An abstract class API for explainer. More...

#include <ExplainWrapper.h>

Inheritance diagram for ModelExplainer:

Public Member Functions
virtual int	init (map< string, string > &mapper)
	Global init for general args in all explainers. initialize directly all args in GlobalExplainerParams.

virtual int	update (map< string, string > &mapper)
	Virtual to update object from parsed fields.

virtual void	_learn (const MedFeatures &train_mat)=0
	overload function for ModelExplainer - easier API

virtual void	Learn (const MedFeatures &train_mat)
	Learns from predictor and train_matrix (PostProcessor API)

void	Apply (MedFeatures &matrix)
	alias for explain

void	get_input_fields (vector< Effected_Field > &fields) const
	List of fields that are used by this post_processor.

void	get_output_fields (vector< Effected_Field > &fields) const
	List of fields that are being effected by this post_processor.

void	init_post_processor (MedModel &model)
	Init ModelExplainer from MedModel - copies predictor pointer, might save normalizers pointers.

virtual void	explain (const MedFeatures &matrix, vector< map< string, float > > &sample_explain_reasons) const =0
	Virtual - return explain results in sample_feature_contrib.

virtual void	explain (MedFeatures &matrix) const
	Stores explain results in matrix.

void	dprint (const string &pref) const

Public Member Functions inherited from PostProcessor
void *	new_polymorphic (string dname)
	for polymorphic classes that want to be able to serialize/deserialize a pointer * to the derived class given its type one needs to implement this function to return a new to the derived class given its type (as in my_type)

virtual float	get_use_p ()

virtual int	get_use_split ()

Public Member Functions inherited from SerializableObject
virtual int	version () const
	Relevant for serializations.

virtual string	my_class_name () const
	For better handling of serializations it is highly recommended that each SerializableObject inheriting class will implement the next method.

virtual void	serialized_fields_name (vector< string > &field_names) const
	The names of the serialized fields.

virtual void	pre_serialization ()

virtual void	post_deserialization ()

virtual size_t	get_size ()
	Gets bytes sizes for serializations.

virtual size_t	serialize (unsigned char *blob)
	Serialiazing object to blob memory. return number ob bytes wrote to memory.

virtual size_t	deserialize (unsigned char *blob)
	Deserialiazing blob to object. returns number of bytes read.

size_t	serialize_vec (vector< unsigned char > &blob)

size_t	deserialize_vec (vector< unsigned char > &blob)

virtual size_t	serialize (vector< unsigned char > &blob)

virtual size_t	deserialize (vector< unsigned char > &blob)

virtual int	read_from_file (const string &fname)
	read and deserialize model

virtual int	write_to_file (const string &fname)
	serialize model and write to file

virtual int	read_from_file_unsafe (const string &fname)
	read and deserialize model without checking version number - unsafe read

int	init_from_string (string init_string)
	Init from string.

int	init_params_from_file (string init_file)

int	init_param_from_file (string file_str, string &param)

int	update_from_string (const string &init_string)

virtual string	object_json () const

Static Public Member Functions
static void	print_explain (MedSample &smp, int sort_mode=0)

Static Public Member Functions inherited from PostProcessor
static PostProcessor *	make_processor (const string &processor_name, const string &params="")

static PostProcessor *	make_processor (PostProcessorTypes type, const string &params="")

static PostProcessor *	create_processor (string &params)

Data Fields
MedPredictor *	original_predictor = NULL
	predictor we're trying to explain

ExplainFilters	filters
	general filters of results

ExplainProcessings	processing
	processing of results, like groupings, COV

GlobalExplainerParams	global_explain_params

Data Fields inherited from PostProcessor
PostProcessorTypes	processor_type = PostProcessorTypes::FTR_POSTPROCESS_LAST

int	use_split = -1

float	use_p = 0.0

Detailed Description

An abstract class API for explainer.

Member Function Documentation

◆ _learn()

virtual void ModelExplainer::_learn ( const MedFeatures & train_mat )

pure virtual

overload function for ModelExplainer - easier API

Implemented in TreeExplainer, MissingShapExplainer, ShapleyExplainer, LimeExplainer, KNN_Explainer, LinearExplainer, and IterativeSetExplainer.

◆ Apply()

void ModelExplainer::Apply ( MedFeatures & matrix )

inlinevirtual

alias for explain

Reimplemented from PostProcessor.

◆ dprint()

void ModelExplainer::dprint ( const string & pref ) const

virtual

Reimplemented from PostProcessor.

◆ explain()

virtual void ModelExplainer::explain	(	const MedFeatures &	matrix,
		vector< map< string, float > > &	sample_explain_reasons
	)		const

pure virtual

Virtual - return explain results in sample_feature_contrib.

Implemented in TreeExplainer, MissingShapExplainer, ShapleyExplainer, LimeExplainer, KNN_Explainer, LinearExplainer, and IterativeSetExplainer.

◆ get_input_fields()

void ModelExplainer::get_input_fields ( vector< Effected_Field > & fields ) const

virtual

List of fields that are used by this post_processor.

Reimplemented from PostProcessor.

◆ get_output_fields()

void ModelExplainer::get_output_fields ( vector< Effected_Field > & fields ) const

virtual

List of fields that are being effected by this post_processor.

Options: "prediction:X", "attr:$NAME", "str_attr:$NAME", "feature:$NAME", "json"

Reimplemented from PostProcessor.

◆ init()

int ModelExplainer::init ( map< string, string > & mapper )

virtual

Global init for general args in all explainers. initialize directly all args in GlobalExplainerParams.

Reimplemented from SerializableObject.

◆ init_post_processor()

void ModelExplainer::init_post_processor ( MedModel & model )

virtual

Init ModelExplainer from MedModel - copies predictor pointer, might save normalizers pointers.

Reimplemented from PostProcessor.

Reimplemented in TreeExplainer.

◆ Learn()

void ModelExplainer::Learn ( const MedFeatures & train_mat )

virtual

Learns from predictor and train_matrix (PostProcessor API)

Reimplemented from PostProcessor.

◆ update()

int ModelExplainer::update ( map< string, string > & map )

virtual

Virtual to update object from parsed fields.

Reimplemented from SerializableObject.

The documentation for this class was generated from the following files:

Internal/MedProcessTools/MedProcessTools/ExplainWrapper.h
Internal/MedProcessTools/MedProcessTools/ExplainWrapper.cpp

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ _learn()

◆ Apply()

◆ dprint()

◆ explain()

◆ get_input_fields()

◆ get_output_fields()

◆ init()

◆ init_post_processor()

◆ Learn()

◆ update()