LSTM

Struct LSTM 

Source
pub struct LSTM<B>
where B: Backend,
{ /* private fields */ }
Expand description

A multi-step LSTM that unrolls an LSTMCell over the sequence dimension.

§Shapes

  • input: [batch, seq_len, input_size]
  • output: [batch, seq_len, hidden_size]
  • h_n: [batch, hidden_size]
  • c_n: [batch, hidden_size]

Implementations§

Source§

impl<B> LSTM<B>
where B: Backend,

Source

pub fn new( input_size: usize, hidden_size: usize, use_bias: bool, dtype: DType, device: &<B as Backend>::Device, ) -> Result<LSTM<B>, Error>

Create a new LSTM layer.

Source

pub fn forward( &self, x: &Tensor<B>, hc0: Option<(&Tensor<B>, &Tensor<B>)>, ) -> Result<(Tensor<B>, (Tensor<B>, Tensor<B>)), Error>

Forward pass over the full sequence.

  • x: [batch, seq_len, input_size]
  • hc0: optional initial (h0, c0), each [batch, hidden_size]. If None, zeros are used.

Returns (output, (h_n, c_n)) where:

  • output: [batch, seq_len, hidden_size]
  • h_n, c_n: [batch, hidden_size]
Source

pub fn parameters(&self) -> Vec<Tensor<B>>

Return all trainable parameters.

Source

pub fn named_parameters(&self) -> Vec<(String, Tensor<B>)>

Return all trainable parameters with names.

Source

pub fn cell(&self) -> &LSTMCell<B>

Access the underlying cell.

Auto Trait Implementations§

§

impl<B> Freeze for LSTM<B>

§

impl<B> RefUnwindSafe for LSTM<B>
where <B as Backend>::Device: RefUnwindSafe,

§

impl<B> Send for LSTM<B>

§

impl<B> Sync for LSTM<B>

§

impl<B> Unpin for LSTM<B>

§

impl<B> UnwindSafe for LSTM<B>
where <B as Backend>::Device: RefUnwindSafe,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V