Skip to main content

EmbeddingKind

Enum EmbeddingKind 

Source
#[non_exhaustive]
#[repr(u16)]
pub enum EmbeddingKind { Embedding = 0, EmbeddingBackward = 1, EmbeddingBagSum = 2, EmbeddingBagMean = 3, EmbeddingBagSumBackward = 4, EmbeddingBagMeanBackward = 5, EmbeddingBagMax = 6, EmbeddingBagMaxBackward = 7, }
Expand description

Embedding-family op discriminant — Category M from the comprehensive plan.

Stored as u16 in crate::KernelSku::op when category == OpCategory::Embedding. Phase 7 Milestone 7.5 wires:

  • Self::Embedding (FW + BW): row-lookup out[i, :] = weight[indices[i], :] with optional padding_idx that emits an all-zero row at FW and skips accumulation at BW.
  • Self::EmbeddingBagSum / Self::EmbeddingBagMean (FW + BW): bag-reduced row lookup — out[b, :] = reduce(weight[indices[k], :] for k in offsets[b]..offsets[b+1]). Mode determines the reducer (sum / divide-by-bag-size). EmbeddingBagMax is deferred (needs argmax tracking for BW).

Index dtype is i32 only (i64 deferred). FW kernels emit f32, f64, f16, bf16 (pure copy / reduce); BW kernels emit f32, f64 (atomicAdd).

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

Embedding = 0

embedding(weight, indices, padding_idx)out[i, :] = weight[indices[i], :]. PyTorch torch.nn.functional.embedding.

§

EmbeddingBackward = 1

Gradient of Self::Embedding: dweight[indices[i], :] += dout[i, :] (atomicAdd), skipping rows where indices[i] == padding_idx.

§

EmbeddingBagSum = 2

embedding_bag(weight, indices, offsets, mode=Sum). PyTorch torch.nn.functional.embedding_bag with mode='sum'.

§

EmbeddingBagMean = 3

embedding_bag(weight, indices, offsets, mode=Mean). PyTorch torch.nn.functional.embedding_bag with mode='mean'.

§

EmbeddingBagSumBackward = 4

Gradient of embedding_bag (Sum-mode): dweight[indices[k], :] += dout[b, :] for k in bag b (atomicAdd).

§

EmbeddingBagMeanBackward = 5

Gradient of embedding_bag (Mean-mode): dweight[indices[k], :] += dout[b, :] / bag_size(b) (atomicAdd).

§

EmbeddingBagMax = 6

embedding_bag(weight, indices, offsets, mode=Max) — reserved. Max-mode requires argmax tracking on FW (the per-feature index of the contributing row) so the BW can scatter into just that row — different plan shape; deferred.

§

EmbeddingBagMaxBackward = 7

Gradient of embedding_bag (Max-mode) — reserved.

Trait Implementations§

Source§

impl Clone for EmbeddingKind

Source§

fn clone(&self) -> EmbeddingKind

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 EmbeddingKind

Source§

impl Debug for EmbeddingKind

Source§

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

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

impl Eq for EmbeddingKind

Source§

impl Hash for EmbeddingKind

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 EmbeddingKind

Source§

fn eq(&self, other: &EmbeddingKind) -> 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 EmbeddingKind

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.