Skip to main content

EmbeddingHandle

Struct EmbeddingHandle 

Source
pub struct EmbeddingHandle {
    pub name: String,
    pub module: Option<PyObject>,
    pub trainable: bool,
    pub dim: usize,
    pub vocab_size: usize,
}
Expand description

Handle to a registered embedding module.

Wraps either a trainable nn.Embedding or a frozen torch.Tensor. Created via CompiledProgram.register_embedding() in Python.

Fields§

§name: String

Unique name matching the nn() declaration

§module: Option<PyObject>

The PyTorch nn.Embedding or tensor

§trainable: bool

Whether gradients flow through this embedding

§dim: usize

Embedding vector dimension (second axis of weight matrix)

§vocab_size: usize

Number of embedding entries (first axis of weight matrix)

Implementations§

Source§

impl EmbeddingHandle

Source

pub fn new(name: String, trainable: bool, dim: usize, vocab_size: usize) -> Self

Create a new embedding handle.

Source

pub fn has_module(&self) -> bool

Check if the PyTorch module/tensor has been set.

Source

pub fn set_module(&mut self, module: PyObject)

Set the PyTorch module/tensor.

Source

pub fn module(&self) -> Option<&PyObject>

Get a reference to the PyTorch module/tensor.

Trait Implementations§

Source§

impl Debug for EmbeddingHandle

Source§

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

Formats the value using the given formatter. Read more

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

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

impl<T> Ungil for T
where T: Send,