Struct burn::nn::GateController

pub struct GateController<B>
where
    B: Backend,
{
    pub input_transform: Linear<B>,
    pub hidden_transform: Linear<B>,
}

A GateController represents a gate in an LSTM cell. An LSTM cell generally contains three gates: an input gate, forget gate, and output gate. Additionally, cell gate is just used to compute the cell state.

An Lstm gate is modeled as two linear transformations. The results of these transformations are used to calculate the gate’s output.

Fields

input_transform: Linear<B>

Represents the affine transformation applied to input vector

hidden_transform: Linear<B>

Represents the affine transformation applied to the hidden state

Implementations

impl<B> GateController<B>

where B: Backend,

pub fn new( d_input: usize, d_output: usize, bias: bool, initializer: Initializer, device: &<B as Backend>::Device, ) -> GateController<B>

Initialize a new gate_controller module.

pub fn gate_product( &self, input: Tensor<B, 2>, hidden: Tensor<B, 2>, ) -> Tensor<B, 2>

Helper function for performing weighted matrix product for a gate and adds bias, if any.

Mathematically, performs Wx*X + Wh*H + b, where: Wx = weight matrix for the connection to input vector X Wh = weight matrix for the connection to hidden state H X = input vector H = hidden state b = bias terms

Trait Implementations

impl<B> AutodiffModule<B> for GateController<B>

where B: Backend + AutodiffBackend, <B as AutodiffBackend>::InnerBackend: Backend,

type InnerModule = GateController<<B as AutodiffBackend>::InnerBackend>

Inner module without auto-differentiation.

fn valid(&self) -> <GateController<B> as AutodiffModule<B>>::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl<B> Clone for GateController<B>

where B: Backend,

fn clone(&self) -> GateController<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> Debug for GateController<B>

where B: Debug + Backend,

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

Formats the value using the given formatter.

impl<B> Display for GateController<B>

where B: Backend,

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

Formats the value using the given formatter.

impl<B> Module<B> for GateController<B>

where B: Backend,

type Record = GateControllerRecord<B>

Type to save and load the module.

fn load_record( self, record: <GateController<B> as Module<B>>::Record, ) -> GateController<B>

Load the module state from a record.

fn into_record(self) -> <GateController<B> as Module<B>>::Record

Convert the module into a record containing the state.

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

fn visit<Visitor>(&self, visitor: &mut Visitor)

where Visitor: ModuleVisitor<B>,

Visit each tensor parameter in the module with a visitor.

fn map<Mapper>(self, mapper: &mut Mapper) -> GateController<B>

where Mapper: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.

fn collect_devices( &self, devices: Vec<<B as Backend>::Device>, ) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn to_device(self, device: &<B as Backend>::Device) -> GateController<B>

Move the module and all of its sub-modules to the given device.

fn fork(self, device: &<B as Backend>::Device) -> GateController<B>

Fork the module and all of its sub-modules to the given device.

fn devices(&self) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree without duplicates.

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Save the module to a file using the provided file recorder.

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder.

fn quantize_weights<C>(self, quantizer: &mut Quantizer<C>) -> Self

where C: Calibration,

Quantize the weights of the module.

impl<B> ModuleDisplay for GateController<B>

where B: Backend,

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings.

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module.

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module.

impl<B> ModuleDisplayDefault for GateController<B>

where B: Backend,

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes.

fn num_params(&self) -> usize

Gets the number of the parameters of the module.