Struct ModelExplanation

#[non_exhaustive]
pub struct ModelExplanation {
    pub mean_attributions: Vec<Attribution>,
    /* private fields */
}

Aggregated explanation metrics for a Model over a set of instances.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

mean_attributions: Vec<Attribution>

Output only. Aggregated attributions explaining the Model’s prediction outputs over the set of instances. The attributions are grouped by outputs.

For Models that predict only one output, such as regression Models that predict only one score, there is only one attibution that explains the predicted output. For Models that predict multiple outputs, such as multiclass Models that predict multiple classes, each element explains one specific item. Attribution.output_index can be used to identify which output this attribution is explaining.

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

NOTE: Currently AutoML tabular classification Models produce only one attribution, which averages attributions over all the classes it predicts. Attribution.approximation_error is not populated.

Implementations

impl ModelExplanation

pub fn new() -> Self

pub fn set_mean_attributions<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Attribution>,

Sets the value of mean_attributions.

Trait Implementations

impl Clone for ModelExplanation

fn clone(&self) -> ModelExplanation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelExplanation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ModelExplanation

fn default() -> ModelExplanation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelExplanation

where ModelExplanation: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ModelExplanation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ModelExplanation

fn eq(&self, other: &ModelExplanation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ModelExplanation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelExplanation