ModelSummary Class

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

Initialize data structures to hold summary information.

Inheritance
builtins.object
ModelSummary

Constructor

ModelSummary()

Methods

add_from_get_model_summary

Update artifacts and metadata with new information.

get_artifacts

Get the list of artifacts.

get_metadata_dictionary

Get the combined dictionary of metadata.

add_from_get_model_summary

Update artifacts and metadata with new information.

add_from_get_model_summary(name, artifact_metadata_tuple)

Parameters

Name Description
name
Required
str

The name the new data should be associated with.

artifact_metadata_tuple
Required
(list[dict], dict)

The tuple of artifacts and metadata to add to existing.

get_artifacts

Get the list of artifacts.

get_artifacts()

Returns

Type Description

Artifact list.

get_metadata_dictionary

Get the combined dictionary of metadata.

get_metadata_dictionary()

Returns

Type Description

Metadata dictionary.