Skip to main content

BiDirectionalLstmLayerParams

Struct BiDirectionalLstmLayerParams 

Source
pub struct BiDirectionalLstmLayerParams {
    pub input_vector_size: u64,
    pub output_vector_size: u64,
    pub activations_forward_lstm: Vec<ActivationParams>,
    pub activations_backward_lstm: Vec<ActivationParams>,
    pub params: Option<LstmParams>,
    pub weight_params: Vec<LstmWeightParams>,
}
Expand description

Bidirectional long short-term memory (LSTM) layer

.. code::

  (y_t, c_t, y_t_reverse, c_t_reverse) = BiDirectionalLSTMLayer(x_t, y_{t-1}, c_{t-1}, y_{t-1}_reverse, c_{t-1}_reverse)

Input A blob of rank 5, with shape `[Seq, Batch, inputVectorSize, 1, 1]. This represents a sequence of vectors of size inputVectorSize. Output Same rank as the input. Represents a vector of size 2 * outputVectorSize``. It is either the final output or a sequence of outputs at all time steps.

  • Output Shape: \[1, Batch, 2 * outputVectorSize, 1, 1\] , if sequenceOutput == false
  • Output Shape: \[Seq, Batch, 2 * outputVectorSize, 1, 1\] , if sequenceOutput == true

The first LSTM operates on the input sequence in the forward direction. The second LSTM operates on the input sequence in the reverse direction.

Example: given the input sequence \[x_1, x_2, x_3\], where x_i are vectors at time index i:

The forward LSTM output is \[yf_1, yf_2, yf_3\],

where yf_i are vectors of size outputVectorSize:

  • yf_1 is the output at the end of sequence {x_1}
  • yf_2 is the output at the end of sequence {x_1, x_2}
  • yf_3 is the output at the end of sequence {x_1, x_2, x_3}

The backward LSTM output: \[yb_1, yb_2, yb_3\],

where yb_i are vectors of size outputVectorSize:

  • yb_1 is the output at the end of sequence {x_3}
  • yb_2 is the output at the end of sequence {x_3, x_2}
  • yb_3 is the output at the end of sequence {x_3, x_2, x_1}

Output of the bi-dir layer:

  • if sequenceOutput = True : { \[yf_1, yb_3\], \[yf_2, yb_2\], \[yf_3, yb_1\] }
  • if sequenceOutput = False : { \[yf_3, yb_3\] }

Fields§

§input_vector_size: u64

Size of the input vectors.

§output_vector_size: u64

Size of the outputs vectors. It is same for both forward and backward LSTMs.

§activations_forward_lstm: Vec<ActivationParams>

3 element array representing activations [f(),g(),h()] in that order. Typical values used = [sigmoid, tanh, tanh]. Activations supported are Linear, Sigmoid, Tanh, ReLU, Scaled Tanh (alpha = 1.71, beta = 2/3), Hard sigmoid (alpha = 0.2, beta = 0.5)

§activations_backward_lstm: Vec<ActivationParams>

Currently, backward LSTM activations must be same as the ones for the forward LSTM.

§params: Option<LstmParams>

Common parameters shared by the forward and backward LSTMs.

§weight_params: Vec<LstmWeightParams>

Weights and biases. Must be a length 2 message, for the forward and backward LSTM respectively.

Trait Implementations§

Source§

impl Clone for BiDirectionalLstmLayerParams

Source§

fn clone(&self) -> BiDirectionalLstmLayerParams

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 Debug for BiDirectionalLstmLayerParams

Source§

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

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

impl Default for BiDirectionalLstmLayerParams

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Message for BiDirectionalLstmLayerParams

Source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
Source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.
Source§

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes an instance of the message from a buffer. Read more
Source§

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes a length-delimited instance of the message from the buffer.
Source§

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self. Read more
Source§

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.
Source§

impl PartialEq for BiDirectionalLstmLayerParams

Source§

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

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.