Struct HammingScore 

pub struct HammingScore { /* private fields */ }

The hamming score, sometimes referred to as multi-label or label-based accuracy.

Implementations

impl HammingScore

pub fn new() -> HammingScore

Creates the metric.

pub fn with_threshold(self, threshold: f32) -> HammingScore

Sets the threshold.

pub fn with_sigmoid(self, sigmoid: bool) -> HammingScore

Sets the sigmoid activation function usage.

Trait Implementations

impl Clone for HammingScore

fn clone(&self) -> HammingScore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for HammingScore

fn default() -> HammingScore

Creates a new metric instance with default values.

impl Metric for HammingScore

type Input = HammingScoreInput

The input type of the metric.

fn update( &mut self, input: &HammingScoreInput, _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 attributes(&self) -> MetricAttributes

Attributes of the metric.

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

A short description of the metric.

impl Numeric for HammingScore

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.