pub struct SoftmaxOperation<'c> { /* private fields */ }
Expand description

A softmax operation. Softmax operator.

linalg.softmax computes a numerically stable version of softmax.

For a given input tensor and a specified dimension d, compute:

  1. the max m along that dimension d
  2. f(x) = exp(x - m)
  3. sum f(x) along dimension d to get l(x).
  4. compute the final result f(x) / l(x).

This is an aggregate linalg operation that further reduces to a small DAG of structured operations.

Warning: Regarding the tiling capabilities, the implementation doesn’t check that the provided dimensions make sense. This is the responsability of the transformation calling the tiling to ensure that the provided sizes for each dimension make sense with respect to the semantic of softmax.

Implementations§

source§

impl<'c> SoftmaxOperation<'c>

source

pub fn name() -> &'static str

Returns a name.

source

pub fn as_operation(&self) -> &Operation<'c>

Returns a generic operation.

source

pub fn builder( context: &'c Context, location: Location<'c> ) -> SoftmaxOperationBuilder<'c, Unset, Unset, Unset, Unset>

Creates a builder.

source

pub fn result(&self) -> impl Iterator<Item = OperationResult<'c, '_>>

source

pub fn input(&self) -> Result<Value<'c, '_>, Error>

source

pub fn output(&self) -> Result<Value<'c, '_>, Error>

source

pub fn dimension(&self) -> Result<IntegerAttribute<'c>, Error>

source

pub fn set_dimension(&mut self, value: IntegerAttribute<'c>)

Trait Implementations§

source§

impl<'c> From<SoftmaxOperation<'c>> for Operation<'c>

source§

fn from(operation: SoftmaxOperation<'c>) -> Self

Converts to this type from the input type.
source§

impl<'c> TryFrom<Operation<'c>> for SoftmaxOperation<'c>

§

type Error = Error

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

fn try_from(operation: Operation<'c>) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

§

impl<'c> RefUnwindSafe for SoftmaxOperation<'c>

§

impl<'c> !Send for SoftmaxOperation<'c>

§

impl<'c> !Sync for SoftmaxOperation<'c>

§

impl<'c> Unpin for SoftmaxOperation<'c>

§

impl<'c> UnwindSafe for SoftmaxOperation<'c>

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
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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.