Struct MetricDatum

#[non_exhaustive]
pub struct MetricDatum {
    pub metric_name: Option<AutoMlMetricEnum>,
    pub standard_metric_name: Option<AutoMlMetricExtendedEnum>,
    pub value: Option<f32>,
    pub set: Option<MetricSetSource>,
}

Information about the metric for a candidate produced by an AutoML job.

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.

metric_name: Option<AutoMlMetricEnum>

The name of the metric.

standard_metric_name: Option<AutoMlMetricExtendedEnum>

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

value: Option<f32>

The value of the metric.

set: Option<MetricSetSource>

The dataset split from which the AutoML job produced the metric.

Implementations

impl MetricDatum

pub fn metric_name(&self) -> Option<&AutoMlMetricEnum>

The name of the metric.

pub fn standard_metric_name(&self) -> Option<&AutoMlMetricExtendedEnum>

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

pub fn value(&self) -> Option<f32>

The value of the metric.

pub fn set(&self) -> Option<&MetricSetSource>

The dataset split from which the AutoML job produced the metric.

impl MetricDatum

pub fn builder() -> MetricDatumBuilder

Creates a new builder-style object to manufacture MetricDatum.

Trait Implementations

impl Clone for MetricDatum

fn clone(&self) -> MetricDatum

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricDatum

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

Formats the value using the given formatter.

impl PartialEq for MetricDatum

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