interpret_community.common.model_summary module

Defines a structure for gathering and storing the parts of an explanation asset.

class interpret_community.common.model_summary.ModelSummary

Bases: object

A structure for gathering and storing the parts of an explanation asset.

add_from_get_model_summary(name, artifact_metadata_tuple)

Update artifacts and metadata with new information.

Parameters:
  • name (str) – The name the new data should be associated with.

  • artifact_metadata_tuple ((list[dict], dict)) – The tuple of artifacts and metadata to add to existing.

get_artifacts()

Get the list of artifacts.

Returns:

Artifact list.

Return type:

list[list[dict]]

get_metadata_dictionary()

Get the combined dictionary of metadata.

Returns:

Metadata dictionary.

Return type:

dict