Skip to main content

TripletLoss

mlx_rs::losses

Struct TripletLoss 

Source 
pub struct TripletLoss {
    pub axis: i32,
    pub p: f32,
    pub margin: f32,
    pub eps: f32,
    pub reduction: LossReduction,
}
Expand description

Computes the triplet loss for a set of anchor, positive, and negative samples. Margin is represented with alpha in the math section.

Fields§

§axis: i32

Distribution axis. Default to TripletLoss::DEFAULT_AXIS

§p: f32

The norm degree for pairwise distance. Default to TripletLoss::DEFAULT_P

§margin: f32

Margin for the triplet loss. Default to TripletLoss::DEFAULT_MARGIN

§eps: f32

Small positive constant for numerical stability. Default to TripletLoss::DEFAULT_EPS

§reduction: LossReduction

Reduction type. Default to TripletLoss::DEFAULT_REDUCTION

Implementations§

Source§

impl TripletLoss

Source

pub fn new() -> Self

Creates a new instance of TripletLoss.

Source§

impl TripletLoss

Source

pub const DEFAULT_AXIS: i32 = -1

Default value for the axis parameter.

Source

pub const DEFAULT_P: f32 = 2.0

Default value for the p parameter.

Source

pub const DEFAULT_MARGIN: f32 = 1.0

Default value for the margin parameter.

Source

pub const DEFAULT_EPS: f32 = 1e-6

Default value for the eps parameter.

Source

pub const DEFAULT_REDUCTION: LossReduction = LossReduction::None

Default value for the reduction parameter.

Source

pub fn apply( &self, anchors: impl AsRef<Array>, positives: impl AsRef<Array>, negatives: impl AsRef<Array>, ) -> Result<Array, Exception>

Computes the triplet loss for a set of anchor, positive, and negative samples. Margin is represented with alpha in the math section.

§Params
  • anchors: The anchor samples
  • positives: The positive samples
  • neonatives: The negative samples

Trait Implementations§

Source§

impl Buildable for TripletLoss

Source§

type Builder = TripletLossBuilder

The builder type for this buildable type
Source§

impl Builder<TripletLoss> for TripletLossBuilder

Source§

type Error = Infallible

Error with building
Source§

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

Build the type
Source§

impl Clone for TripletLoss

Source§

fn clone(&self) -> TripletLoss

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TripletLoss

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoOption<T> for T

Source§

fn into_option(self) -> Option<T>

Convert into an Option.
Source§

impl<T> IntoStrideBy for T

Source§

fn stride_by(self, stride: i32) -> StrideBy<T>

Create a stride indexing operation.
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.