Struct burn::train::metric::HammingScore

pub struct HammingScore<B>
where
    B: Backend,
{ /* private fields */ }

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

Implementations

impl<B> HammingScore<B>

where B: Backend,

pub fn new() -> HammingScore<B>

Creates the metric.

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

Sets the threshold.

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

Sets the sigmoid activation function usage.

Trait Implementations

impl<B> Default for HammingScore<B>

where B: Backend,

fn default() -> HammingScore<B>

Creates a new metric instance with default values.

impl<B> Metric for HammingScore<B>

where B: Backend,

const NAME: &'static str = "Hamming Score"

The name of the metric.

type Input = HammingScoreInput<B>

The input type of the metric.

fn update( &mut self, input: &HammingScoreInput<B>, _metadata: &MetricMetadata, ) -> MetricEntry

Update the metric state and returns the current metric entry.

fn clear(&mut self)

Clear the metric state.

impl<B> Numeric for HammingScore<B>

where B: Backend,

fn value(&self) -> f64

Returns the numeric value of the metric.