Struct Embedding

pub struct Embedding {
    pub weight: Param<Array>,
}

Implements a simple lookup table that maps each input integer to a high-dimensional vector.

Typically used to embed discrete tokens for processing by neural networks.

Fields

weight: Param<Array>

The weight of the

Implementations

impl Embedding

pub fn new(embedding_count: i32, dimensions: i32) -> Result<Self, Exception>

Creates a new Embedding layer.

Params

• embedding_count: How many possible discrete tokens can we embed. Usually called the vocabulary size.
• dimensions: The dimensionality of the embeddings.

pub fn as_linear(&self, x: &Array) -> Result<Array, Exception>

Call the embedding layer as a linear layer.

Use this for example when input embedding and output projection weights are tied.

Trait Implementations

impl Clone for Embedding

fn clone(&self) -> Embedding

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Embedding

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

Formats the value using the given formatter.

impl Module<&Array> for Embedding

type Error = Exception

Error type for the module.

type Output = Array

Output type of the module.

fn forward(&mut self, x: &Array) -> Result<Array, Self::Error>

Forward pass of the module.

fn training_mode(&mut self, _mode: bool)

Set whether the module is in training mode.

impl ModuleParameters for Embedding

fn freeze_parameters(&mut self, recursive: bool)

Freeze all parameters in the module.

fn unfreeze_parameters(&mut self, recursive: bool)

Unfreeze all parameters in the module.

fn parameters(&self) -> ModuleParamRef<'_>

Get references to the module parameters.

fn parameters_mut(&mut self) -> ModuleParamMut<'_>

Get mutable references to the module parameters.

fn trainable_parameters(&self) -> ModuleParamRef<'_>

Get references to the trainable parameters. A parameter is trainable if it is NOT frozen.

fn all_frozen(&self) -> Option<bool>

Check if all parameters in the module are frozen. Returns None if there are no parameters.

fn any_frozen(&self) -> Option<bool>

Check if any parameter in the module is frozen. Returns None if there are no parameters.

fn update(&mut self, parameters: ModuleParam)

Update the module parameters.

fn update_flattened(&mut self, flattened_parameters: FlattenedModuleParam)

Update the module parameters from a flattened representation.

impl Quantizable for Embedding

type Quantized = QuantizedEmbedding

The quantized type.

type QuantizationError = Exception

The error type for quantization.

fn try_into_quantized( self, group_size: i32, bits: i32, ) -> Result<Self::Quantized, Self::QuantizationError>

Quantize the module with the specified group size and number of bits.

const DEFAULT_GROUP_SIZE: i32 = 64i32

The default group size for quantization.

const DEFAULT_BITS: i32 = 4i32

The default number of bits for quantization.

impl TryFrom<Embedding> for QuantizedEmbedding

type Error = Exception

The type returned in the event of a conversion error.

fn try_from(embedding: Embedding) -> Result<Self, Self::Error>

Performs the conversion.