Skip to main content

SoftmaxKind

Enum SoftmaxKind 

Source
#[non_exhaustive]
#[repr(u16)]
pub enum SoftmaxKind { Softmax = 0, LogSoftmax = 1, GumbelSoftmax = 2, Sparsemax = 3, }
Expand description

Softmax-family op discriminant — category H from the comprehensive plan.

Stored as u16 in crate::KernelSku::op when category == OpCategory::Softmax. All variants apply a length-preserving transform along a single axis (output shape == input shape — distinct from reductions, like scans).

Today wired: {Softmax, LogSoftmax} × {f32, f16, bf16, f64} — FW + BW. GumbelSoftmax (needs RNG state from Phase 4 random) and Sparsemax (different gradient — projection onto simplex) are reserved-but-deferred.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Softmax = 0

y[k] = exp(x[k] - max(x)) / Σ_j exp(x[j] - max(x)) — numerically stable softmax.

§

LogSoftmax = 1

y[k] = x[k] - logsumexp(x) — log-domain softmax, also stable. Output is the elementwise log of Softmax(x).

§

GumbelSoftmax = 2

y = (x + Gumbel(0,1)) / τ → softmax — reserved.

§

Sparsemax = 3

y = ProjSimplex(x) — reserved (different gradient than softmax).

Trait Implementations§

Source§

impl Clone for SoftmaxKind

Source§

fn clone(&self) -> SoftmaxKind

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 Copy for SoftmaxKind

Source§

impl Debug for SoftmaxKind

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SoftmaxKind

Source§

impl Hash for SoftmaxKind

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SoftmaxKind

Source§

fn eq(&self, other: &SoftmaxKind) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SoftmaxKind

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