Struct LstmConfig 

pub struct LstmConfig {
    pub d_input: usize,
    pub d_hidden: usize,
    pub bias: bool,
    pub initializer: Initializer,
    pub batch_first: bool,
    pub reverse: bool,
    pub clip: Option<f64>,
    pub input_forget: bool,
    pub gate_activation: ActivationConfig,
    pub cell_activation: ActivationConfig,
    pub hidden_activation: ActivationConfig,
}

Configuration to create a Lstm module using the init function.

Fields

d_input: usize

The size of the input features.

d_hidden: usize

The size of the hidden state.

bias: bool

If a bias should be applied during the Lstm transformation.

initializer: Initializer

Lstm initializer

batch_first: bool

If true, the input tensor is expected to be [batch_size, seq_length, input_size]. If false, the input tensor is expected to be [seq_length, batch_size, input_size].

reverse: bool

If true, process the sequence in reverse order. This is useful for implementing reverse-direction LSTMs (e.g., ONNX reverse direction).

clip: Option<f64>

Optional cell state clip threshold. If provided, cell state values are clipped to the range [-clip, +clip] after each timestep. This can help prevent exploding values during inference.

input_forget: bool

If true, couples the input and forget gates: f_t = 1 - i_t. This reduces the number of parameters and is based on GRU-style simplification.

gate_activation: ActivationConfig

Activation function for the input, forget, and output gates. Default is Sigmoid, which is standard for LSTM gates.

cell_activation: ActivationConfig

Activation function for the cell gate (candidate cell state). Default is Tanh, which is standard for LSTM.

hidden_activation: ActivationConfig

Activation function applied to the cell state before computing hidden output. Default is Tanh, which is standard for LSTM.

Implementations

impl LstmConfig

pub fn new(d_input: usize, d_hidden: usize, bias: bool) -> LstmConfig

Create a new instance of the config.

impl LstmConfig

pub fn with_initializer(self, initializer: Initializer) -> LstmConfig

Lstm initializer

pub fn with_batch_first(self, batch_first: bool) -> LstmConfig

If true, the input tensor is expected to be [batch_size, seq_length, input_size].

pub fn with_reverse(self, reverse: bool) -> LstmConfig

If true, process the sequence in reverse order.

pub fn with_input_forget(self, input_forget: bool) -> LstmConfig

If true, couples the input and forget gates: f_t = 1 - i_t.

pub fn with_gate_activation( self, gate_activation: ActivationConfig, ) -> LstmConfig

Activation function for the input, forget, and output gates.

pub fn with_cell_activation( self, cell_activation: ActivationConfig, ) -> LstmConfig

Activation function for the cell gate (candidate cell state).

pub fn with_hidden_activation( self, hidden_activation: ActivationConfig, ) -> LstmConfig

Activation function applied to the cell state before computing hidden output.

pub fn with_clip(self, clip: Option<f64>) -> LstmConfig

Set the default value for the field.

impl LstmConfig

pub fn init<B>(&self, device: &<B as Backend>::Device) -> Lstm<B>

where B: Backend,

Initialize a new lstm module.

Trait Implementations

impl Clone for LstmConfig

fn clone(&self) -> LstmConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for LstmConfig

fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Saves the configuration to a file.

fn load<P>(file: P) -> Result<Self, ConfigError>

where P: AsRef<Path>,

Loads the configuration from a file.

fn load_binary(data: &[u8]) -> Result<Self, ConfigError>

Loads the configuration from a binary buffer.

impl Debug for LstmConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LstmConfig

fn deserialize<D>( deserializer: D, ) -> Result<LstmConfig, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LstmConfig

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

Formats the value using the given formatter.

impl Serialize for LstmConfig

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.