Struct AurocMetric 

pub struct AurocMetric { /* private fields */ }

The Area Under the Receiver Operating Characteristic Curve (AUROC, also referred to as ROC AUC).

Supports binary, multiclass and multi-label classification through a One-vs-Rest decomposition, aggregated with the configured class reduction.

Implementations

impl AurocMetric

pub fn binary() -> AurocMetric

AUROC metric for binary classification.

pub fn multiclass(class_reduction: ClassReduction) -> AurocMetric

AUROC metric for multiclass classification.

Arguments

• class_reduction - Class reduction type.

pub fn multilabel(class_reduction: ClassReduction) -> AurocMetric

AUROC metric for multi-label classification.

Arguments

• class_reduction - Class reduction type.

Trait Implementations

impl Clone for AurocMetric

fn clone(&self) -> AurocMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for AurocMetric

fn default() -> AurocMetric

Returns the “default value” for a type.

impl Metric for AurocMetric

type Input = ConfusionStatsInput

The input type of the metric.

fn update( &mut self, input: &ConfusionStatsInput, _metadata: &MetricMetadata, ) -> Result<SerializedEntry, TensorReadError>

Update the metric state and returns the current metric entry.

fn compute(&mut self) -> Result<SerializedEntry, TensorReadError>

Compute the final metric value.

fn clear(&mut self)

Clear the metric state.

fn name(&self) -> Arc<String>

The parameterized name of the metric.

fn description(&self) -> Option<String>

A short description of the metric.

fn attributes(&self) -> MetricAttributes

Attributes of the metric.

impl Numeric for AurocMetric

fn value(&self) -> Option<NumericEntry>

Returns the numeric value of the metric, or None if this metric has no meaningful value yet (e.g. it only accumulates state per batch and computes its value once all state has been accumulated).

fn running_value(&self) -> Option<NumericEntry>

Returns the current aggregated value of the metric over the global step, or None if this metric has no meaningful value yet (e.g. it only accumulates state per batch and computes its value once all state has been accumulated).

fn final_value(&self) -> NumericEntry

Returns the final, authoritative value of the metric for the epoch. Only meaningful after Metric::compute has been called.