Struct KlDivLoss

pub struct KlDivLoss {
    pub axis: i32,
    pub reduction: LossReduction,
}

Compute the Kullback-Leibler divergence loss.

Computes the following when the reduction is LossReduction::None:

sum(exp(targets) * (targets - inputs), axis, None)

Fields

axis: i32

The distribution axis. Default to KlDivLoss::DEFAULT_AXIS

reduction: LossReduction

Reduction type. Default to KlDivLoss::DEFAULT_REDUCTION

Implementations

impl KlDivLoss

pub fn new() -> Self

Creates a new instance of KlDivLoss.

impl KlDivLoss

pub const DEFAULT_AXIS: i32 = -1i32

Default value for the axis parameter.

pub const DEFAULT_REDUCTION: LossReduction = LossReduction::None

Default value for the reduction parameter.

pub fn apply( &self, inputs: impl AsRef<Array>, targets: impl AsRef<Array>, ) -> Result<Array, Exception>

Compute the Kullback-Leibler divergence loss.

Params

• inputs: Log probabilities for the predicted distribution.
• targets: Log probabilities for the target distribution.

Trait Implementations

impl Buildable for KlDivLoss

type Builder = KlDivLossBuilder

The builder type for this buildable type

impl Builder<KlDivLoss> for KlDivLossBuilder

type Error = Infallible

Error with building

fn build(self) -> Result<KlDivLoss, Self::Error>

Build the type

impl Clone for KlDivLoss

fn clone(&self) -> KlDivLoss

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KlDivLoss

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

Formats the value using the given formatter.