Struct BiLstmConfig 

pub struct BiLstmConfig {
    pub d_input: usize,
    pub d_hidden: usize,
    pub bias: bool,
    pub initializer: Initializer,
    pub batch_first: 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 BiLstm 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 BiLstm transformation.

initializer: Initializer

BiLstm 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].

clip: Option<f64>

Optional cell state clip threshold.

input_forget: bool

If true, couples the input and forget gates and omits the separate forget gate in both directions.

gate_activation: ActivationConfig

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

cell_activation: ActivationConfig

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

hidden_activation: ActivationConfig

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

Implementations

impl BiLstmConfig

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

Create a new instance of the config.

Arguments

Required Arguments

d_input

The size of the input features.

d_hidden

The size of the hidden state.

bias

If a bias should be applied during the BiLstm transformation.

Optional Arguments

clip

Optional cell state clip threshold.

• Defaults to None

Default Arguments

initializer

BiLstm initializer

• Defaults to "Initializer::XavierNormal{gain:1.0}"

batch_first

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

• Defaults to true

input_forget

If true, couples the input and forget gates and omits the separate forget gate in both directions.

• Defaults to false

gate_activation

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

• Defaults to "ActivationConfig::Sigmoid"

cell_activation

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

• Defaults to "ActivationConfig::Tanh"

hidden_activation

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

• Defaults to "ActivationConfig::Tanh"

impl BiLstmConfig

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

Sets the value for the field initializer.

BiLstm initializer

• Defaults to "Initializer::XavierNormal{gain:1.0}"

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

Sets the value for the field batch_first.

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

• Defaults to true

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

Sets the value for the field input_forget.

If true, couples the input and forget gates and omits the separate forget gate in both directions.

• Defaults to false

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

Sets the value for the field gate_activation.

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

• Defaults to "ActivationConfig::Sigmoid"

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

Sets the value for the field cell_activation.

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

• Defaults to "ActivationConfig::Tanh"

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

Sets the value for the field hidden_activation.

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

• Defaults to "ActivationConfig::Tanh"

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

Sets the value for the field clip.

Optional cell state clip threshold.

• Defaults to None

impl BiLstmConfig

pub fn init(&self, device: &Device) -> BiLstm

Initialize a new Bidirectional LSTM module.

Trait Implementations

impl Clone for BiLstmConfig

fn clone(&self) -> BiLstmConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for BiLstmConfig

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 BiLstmConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BiLstmConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BiLstmConfig

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

Formats the value using the given formatter.

impl Serialize for BiLstmConfig

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.