burn::nn

Struct LstmState

pub struct LstmState<const D: usize> {
    pub cell: Tensor<D>,
    pub hidden: Tensor<D>,
}

Expand description

State bundle for LSTM implementations.

Fields§

§cell: Tensor<D>

The cell state.

§hidden: Tensor<D>

The hidden state.

Implementations§

§

impl<const D: usize> LstmState<D>

pub fn new(cell: Tensor<D>, hidden: Tensor<D>) -> LstmState<D>

Construct a new LstmState.

This is the inverse to Self::unpack.

§Arguments

cell - the cell state.
hidden - the hidden state.

§Debug Assertion

cell.shape() == hidden.shape()

pub fn initial<S>(shape: S, device: &Device) -> LstmState<D>
where S: Into<Shape>,

Allocate an initial zero state.

§Arguments

shape - the shape of the cell and hidden states.
device - the device to allocate the state on.

pub fn shape(&self) -> Shape

Get the shape of the state.

pub fn device(&self) -> Device

Get the device of the state.

pub fn unpack(self) -> (Tensor<D>, Tensor<D>)

Unpack the state to (cell, hidden).

This is the inverse to Self::new.

pub fn map_state<const D2: usize, F>(self, f: F) -> LstmState<D2>
where F: Fn(Tensor<D>) -> Tensor<D2>,

Maps the internal cells to a new state.

§Arguments

f - a function to map each member.

§Returns

A newly mapped state.

pub fn slice<S>(self, slices: S) -> LstmState<D>
where S: SliceArg,

Slice the state.

See: Tensor::slice.

pub fn squeeze_dim<const D2: usize>(self, dim: impl AsIndex) -> LstmState<D2>

Squeeze a dimension from the state.

Negative dimensions are supported and count from the end.

See: Tensor::squeeze_dim.

pub fn unsqueeze_dim<const D2: usize>(self, dim: impl AsIndex) -> LstmState<D2>

Unsqueeze a dimension in the state.

Negative dimensions are supported and count from the end of the valid insertion positions.

See: Tensor::unsqueeze_dim.

pub fn stack<const D2: usize>( states: Vec<LstmState<D>>, dim: impl AsIndex, ) -> LstmState<D2>

Stack the states along the given dimension.

Negative dimensions are supported and count from the end of the valid insertion positions.

See: Tensor::stack.

pub fn chunk(self, n: usize, dim: impl AsIndex) -> Vec<LstmState<D>>

Chunk the state into n states along the given dimension.

This is the inverse of stacking — useful for splitting multi-layer states back into per-layer states.

Negative dimensions are supported and count from the end.

See: Tensor::chunk.

Trait Implementations§

§

impl<const D: usize> Clone for LstmState<D>

§

fn clone(&self) -> LstmState<D>

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

§

impl<const D: usize> Debug for LstmState<D>

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<const D: usize> UnwindSafe for LstmState<D>

Blanket Implementations§

§

impl<T> Adaptor<()> for T

§

fn adapt(&self)

Adapt the type to be passed to a metric.

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

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

§

impl<K, Q> Comparable<Q> for K
where K: Borrow<Q> + ?Sized, Q: Ord + ?Sized,

§

fn compare(&self, key: &Q) -> Ordering

Compare self to key and return their ordering.

§

impl<K, Q> Equivalent<Q> for K
where K: Borrow<Q> + ?Sized, Q: Eq + ?Sized,

§

fn equivalent(&self, key: &Q) -> bool

Compare self to key and return true if they are equal.

§

impl<T> ErasedDestructor for T
where T: 'static,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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

§