Share via

ExplainParams Class

  • Reference

Provide constants for interpret community (init, explain_local and explain_global) parameters.

Inheritance
builtins.object
ExplainParams

Constructor

ExplainParams()

Methods

get_private

Return the private version of the ExplainParams property.
get_serializable

Return only the ExplainParams properties that have meaningful data values for serialization.

get_private

Return the private version of the ExplainParams property.

get_private(explain_param)

Parameters

Name Description
cls
Required
ExplainParams

ExplainParams input class.
explain_param
Required
str

The ExplainParams property to get private version of.

Returns

Type Description
str

The private version of the property.

get_serializable

Return only the ExplainParams properties that have meaningful data values for serialization.

get_serializable()

Parameters

Name Description
cls
Required
ExplainParams

ExplainParams input class.

Returns

Type Description
set[str]

A set of property names, e.g., 'GLOBAL_IMPORTANCE_VALUES', 'MODEL_TYPE', etc.

Attributes

BATCH_SIZE 

BATCH_SIZE = 'batch_size'

CHECK_ADDITIVITY 

CHECK_ADDITIVITY = 'check_additivity'

CLASSES 

CLASSES = 'classes'

CLASSIFICATION 

CLASSIFICATION = 'classification'

EVAL_DATA 

EVAL_DATA = 'eval_data'

EVAL_Y_PRED 

EVAL_Y_PRED = 'eval_y_predicted'

EVAL_Y_PRED_PROBA 

EVAL_Y_PRED_PROBA = 'eval_y_predicted_proba'

EXPECTED_VALUES 

EXPECTED_VALUES = 'expected_values'

EXPLAIN_SUBSET 

EXPLAIN_SUBSET = 'explain_subset'

EXPLANATION_ID 

EXPLANATION_ID = 'explanation_id'

FEATURES 

FEATURES = 'features'

GLOBAL_IMPORTANCE_NAMES 

GLOBAL_IMPORTANCE_NAMES = 'global_importance_names'

GLOBAL_IMPORTANCE_RANK 

GLOBAL_IMPORTANCE_RANK = 'global_importance_rank'

GLOBAL_IMPORTANCE_VALUES 

GLOBAL_IMPORTANCE_VALUES = 'global_importance_values'

GLOBAL_NAMES 

GLOBAL_NAMES = 'global_names'

GLOBAL_RANK 

GLOBAL_RANK = 'global_rank'

GLOBAL_VALUES 

GLOBAL_VALUES = 'global_values'

ID 

ID = 'id'

INCLUDE_LOCAL 

INCLUDE_LOCAL = 'include_local'

INIT_DATA 

INIT_DATA = 'init_data'

IS_ENG 

IS_ENG = 'is_engineered'

IS_LOCAL_SPARSE 

IS_LOCAL_SPARSE = 'is_local_sparse'

IS_RAW 

IS_RAW = 'is_raw'

LOCAL_EXPLANATION 

LOCAL_EXPLANATION = 'local_explanation'

LOCAL_IMPORTANCE_VALUES 

LOCAL_IMPORTANCE_VALUES = 'local_importance_values'

METHOD 

METHOD = 'method'

MODEL_ID 

MODEL_ID = 'model_id'

MODEL_TASK 

MODEL_TASK = 'model_task'

MODEL_TYPE 

MODEL_TYPE = 'model_type'

NUM_CLASSES 

NUM_CLASSES = 'num_classes'

NUM_EXAMPLES 

NUM_EXAMPLES = 'num_examples'

NUM_FEATURES 

NUM_FEATURES = 'num_features'

PER_CLASS_NAMES 

PER_CLASS_NAMES = 'per_class_names'

PER_CLASS_RANK 

PER_CLASS_RANK = 'per_class_rank'

PER_CLASS_VALUES 

PER_CLASS_VALUES = 'per_class_values'

PROBABILITIES 

PROBABILITIES = 'probabilities'

SAMPLING_POLICY 

SAMPLING_POLICY = 'sampling_policy'

SHAP_VALUES_OUTPUT 

SHAP_VALUES_OUTPUT = 'shap_values_output'