pyreal.explanation_types.feature_based.FeatureContributionExplanation

class pyreal.explanation_types.feature_based.FeatureContributionExplanation(explanation, values=None, other_properties=None)

A type wrapper for local feature contribution DataFrame type outputs from explanation algorithms. Local feature contribution explanations give one numeric value per instance per feature, representing that feature’s contribution to the model’s prediction for this instance.

__init__(explanation, values=None, other_properties=None)

Set the wrapped explanation to explanation and values to values and validate :param explanation: wrapped explanation :type explanation: object :param values: Values corresponding with the object being explained :type values: DataFrame of shape (n_instances, n_features) or None :param other_properties: Other information relevant to the explanation :type other_properties: dict

Methods

__init__(explanation[, values, other_properties])	Set the wrapped explanation to explanation and values to values and validate :param explanation: wrapped explanation :type explanation: object :param values: Values corresponding with the object being explained :type values: DataFrame of shape (n_instances, n_features) or None :param other_properties: Other information relevant to the explanation :type other_properties: dict
apply_feature_descriptions(feature_descriptions)	Apply feature descriptions to explanation
combine_columns(columns, new_column)	Combine the values for columns into a new column, if appropriate :param columns: Columns to sum :type columns: list of strings :param new_column: Name of new column :type new_column: string
get()	Get the explanation wrapped by this type.
get_all()	Get the explanation and wrapped values as a tuple.
get_average_values()	Return the expected values of features, for explanations where this is relevant
get_explanation()	Get the explanation wrapped by this type
get_top_features([num_features, select_by])	Get the top features from the explanation :returns:
get_values()	Return the values associated with the explanation
update_explanation(new_explanation[, ...])	Sets this object's explanation to the new value.
update_values(values[, inplace])	Updates this objects values, and validates
validate()	Validate that self.explanation is a valid DataFrame :returns: None
validate_other_properties()	Validate that any additional properties are valid
validate_values()	Validate that self.values are valid values for this Explanation.