Struct zyx::nn::SoftMax

pub struct SoftMax<D>where
    D: IntoDims,{
    pub dims: D,
}

Softmax operation

Fields

dims: D

Dimensions to calculate softmax across

Trait Implementations

impl<D: Clone> Clone for SoftMax<D>where
    D: IntoDims,

fn clone(&self) -> SoftMax<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for SoftMax<D>where
    D: IntoDims,

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

Formats the value using the given formatter.

impl<D: Hash> Hash for SoftMax<D>where
    D: IntoDims,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Input, D> Module<'_, Input> for SoftMax<D>where
    D: IntoDims + Clone,
    Input: Clone + Max + Sub<<Input as Max>::Output>,
    <Input as Sub<<Input as Max>::Output>>::Output: Exp,
    <<Input as Sub<<Input as Max>::Output>>::Output as Exp>::Output: Clone + Sum,
    <<Input as Sub<<Input as Max>::Output>>::Output as Exp>::Output: Div<<<<Input as Sub<<Input as Max>::Output>>::Output as Exp>::Output as Sum>::Output>,

type Output = <<<Input as Sub<<Input as Max>::Output>>::Output as Exp>::Output as Div<<<<Input as Sub<<Input as Max>::Output>>::Output as Exp>::Output as Sum>::Output>>::Output

Output of forward operation on Module

type Params = ()

Parameters of Module

fn forward(&self, x: Input) -> Self::Output

Forward operation on Module

fn parameters(&mut self) -> Self::Params

Get parameters of Module

impl<D: Ord> Ord for SoftMax<D>where
    D: IntoDims,

fn cmp(&self, other: &SoftMax<D>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<D: PartialEq> PartialEq<SoftMax<D>> for SoftMax<D>where
    D: IntoDims,

fn eq(&self, other: &SoftMax<D>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<D: PartialOrd> PartialOrd<SoftMax<D>> for SoftMax<D>where
    D: IntoDims,

fn partial_cmp(&self, other: &SoftMax<D>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<D: Copy> Copy for SoftMax<D>where
    D: IntoDims,

impl<D: Eq> Eq for SoftMax<D>where
    D: IntoDims,

impl<D> StructuralEq for SoftMax<D>where
    D: IntoDims,

impl<D> StructuralPartialEq for SoftMax<D>where
    D: IntoDims,