Struct CosineEmbeddingLoss

pub struct CosineEmbeddingLoss {
    pub margin: f32,
    pub reduction: Ignored<Reduction>,
}

Cosine embedding loss between two tensors.

Measures cosine distance between tensors. Used for learning embeddings or similarity.

Fields

margin: f32

Margin value. Default: 0.0

reduction: Ignored<Reduction>

Reduction method

Implementations

impl CosineEmbeddingLoss

pub fn new() -> CosineEmbeddingLoss

Creates a new instance

pub fn forward<B>( &self, input1: Tensor<B, 2>, input2: Tensor<B, 2>, target: Tensor<B, 1, Int>, ) -> Tensor<B, 1>

where B: Backend,

Compute loss with reduction.

Shapes

• input1: [batch_size, embedding_dim]
• input2: [batch_size, embedding_dim]
• target: [batch_size] with values 1 or -1

Returns

Loss tensor of shape [1]

pub fn forward_no_reduction<B>( &self, input1: Tensor<B, 2>, input2: Tensor<B, 2>, target: Tensor<B, 1, Int>, ) -> Tensor<B, 1>

where B: Backend,

Compute loss without applying reduction.

Arguments

• input1 - First input tensor of shape [batch_size, embedding_dim]
• input2 - Second input tensor of shape [batch_size, embedding_dim]
• target - Target tensor of shape [batch_size] with values 1 or -1

Returns

Tensor of per-element losses with shape [batch_size]

Trait Implementations

impl<B> AutodiffModule<B> for CosineEmbeddingLoss

where B: AutodiffBackend,

type InnerModule = CosineEmbeddingLoss

Inner module without auto-differentiation.

fn valid(&self) -> <CosineEmbeddingLoss as AutodiffModule<B>>::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl Clone for CosineEmbeddingLoss

fn clone(&self) -> CosineEmbeddingLoss

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more

impl Debug for CosineEmbeddingLoss

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

Formats the value using the given formatter. Read more

impl Default for CosineEmbeddingLoss

fn default() -> CosineEmbeddingLoss

Returns the “default value” for a type. Read more

impl Display for CosineEmbeddingLoss

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

Formats the value using the given formatter. Read more

impl<B> Module<B> for CosineEmbeddingLoss

where B: Backend,

type Record = ConstantRecord

Type to save and load the module.

fn visit<V>(&self, _visitor: &mut V)

where V: ModuleVisitor<B>,

Visit each tensor parameter in the module with a visitor.

fn map<M>(self, _mapper: &mut M) -> CosineEmbeddingLoss

where M: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.

fn load_record( self, _record: <CosineEmbeddingLoss as Module<B>>::Record, ) -> CosineEmbeddingLoss

Load the module state from a record.

fn into_record(self) -> <CosineEmbeddingLoss as Module<B>>::Record

Convert the module into a record containing the state.

fn to_device(self, _: &<B as Backend>::Device) -> CosineEmbeddingLoss

Move the module and all of its sub-modules to the given device.

fn fork(self, _: &<B as Backend>::Device) -> CosineEmbeddingLoss

Fork the module and all of its sub-modules to the given device.

fn collect_devices( &self, devices: Vec<<B as Backend>::Device>, ) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn devices(&self) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree without duplicates.

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Save the module to a file using the provided file recorder.

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder.

fn quantize_weights(self, quantizer: &mut Quantizer) -> Self

Quantize the weights of the module.

impl ModuleDisplay for CosineEmbeddingLoss

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module. Read more

fn custom_content(&self, content: Content) -> Option<Content>

Custom attributes for the module.

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings.

impl ModuleDisplayDefault for CosineEmbeddingLoss

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes. Read more

fn num_params(&self) -> usize

Gets the number of the parameters of the module.