Struct CosineSimilarityLoss

pub struct CosineSimilarityLoss {
    pub axis: i32,
    pub eps: f32,
    pub reduction: LossReduction,
}

Computes the cosine similarity loss.

Fields

axis: i32

Embedding axis. Default to CosineSimilarityLoss::DEFAULT_AXIS

eps: f32

minimum value of the denominator used for numerical stability. Default to CosineSimilarityLoss::DEFAULT_EPS

reduction: LossReduction

Reduction type. Default to CosineSimilarityLoss::DEFAULT_REDUCTION

Implementations

impl CosineSimilarityLoss

pub fn new() -> Self

Creates a new instance of CosineSimilarityLoss.

impl CosineSimilarityLoss

pub const DEFAULT_AXIS: i32 = -1i32

Default value for the axis parameter.

pub const DEFAULT_EPS: f32 = 9.99999993E-9f32

Default value for the eps parameter.

pub const DEFAULT_REDUCTION: LossReduction = LossReduction::None

Default value for the reduction parameter.

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

Computes the cosine similarity loss.

Params

• x1: first array
• x2: second array

Trait Implementations

impl Buildable for CosineSimilarityLoss

type Builder = CosineSimilarityLossBuilder

The builder type for this buildable type

impl Builder<CosineSimilarityLoss> for CosineSimilarityLossBuilder

type Error = Infallible

Error with building

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

Build the type

impl Clone for CosineSimilarityLoss

fn clone(&self) -> CosineSimilarityLoss

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CosineSimilarityLoss

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

Formats the value using the given formatter.