Struct ModelMetrics

#[non_exhaustive]
pub struct ModelMetrics {
    pub model_quality: Option<ModelQuality>,
    pub model_data_quality: Option<ModelDataQuality>,
    pub bias: Option<Bias>,
    pub explainability: Option<Explainability>,
}

Contains metrics captured from a model.

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.

model_quality: Option<ModelQuality>

Metrics that measure the quality of a model.

model_data_quality: Option<ModelDataQuality>

Metrics that measure the quality of the input data for a model.

bias: Option<Bias>

Metrics that measure bias in a model.

explainability: Option<Explainability>

Metrics that help explain a model.

Implementations

impl ModelMetrics

pub fn model_quality(&self) -> Option<&ModelQuality>

Metrics that measure the quality of a model.

pub fn model_data_quality(&self) -> Option<&ModelDataQuality>

Metrics that measure the quality of the input data for a model.

pub fn bias(&self) -> Option<&Bias>

Metrics that measure bias in a model.

pub fn explainability(&self) -> Option<&Explainability>

Metrics that help explain a model.

impl ModelMetrics

pub fn builder() -> ModelMetricsBuilder

Creates a new builder-style object to manufacture ModelMetrics.

Trait Implementations

impl Clone for ModelMetrics

fn clone(&self) -> ModelMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelMetrics

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

Formats the value using the given formatter.

impl PartialEq for ModelMetrics

fn eq(&self, other: &ModelMetrics) -> 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 StructuralPartialEq for ModelMetrics