Struct Residual

pub struct Residual<E: Dtype, const I: usize, M: Default + Module<[E; I]>> {
    pub module: M,
    pub dt: PhantomData<E>,
}

A residual connection around some module.

Fields

module: M

dt: PhantomData<E>

Trait Implementations

impl<E: Dtype, const I: usize, M: Default + Module<[E; I], Output = [E; I]> + TracedModule<[E; I]> + BackpropModule<[E; I]>> BackpropModule<[E; I]> for Residual<E, I, M>

type SelfGrads = <M as BackpropModule<[E; I]>>::SelfGrads

Type describing movement in the modules’ own parameters in response to backpropagation.

fn backprop( &self, trace: &<M as TracedModule<[E; I]>>::Trace, grads_wrt_output: <M as Module<[E; I]>>::Output, ) -> ([E; I], Self::SelfGrads)

Computes gradients for this layer/module, given tracing state from forward execution, and the gradients of the output.

fn update( &mut self, applyer: &mut impl GradApplyer, updates: Self::SelfGrads, ) -> Result<(), Error>

Applies a gradient update step, given (Self::SelfGrads) and a GradApplyer.

fn new_momentum( &self, params: TrainParams, momentum_coefficient: f32, ) -> Momentum<Self::SelfGrads>

where <Self as BackpropModule<X>>::SelfGrads: Gradients,

Returns a GradApplyer object needed to train using SGD + momentum.

fn new_rmsprop( &self, params: TrainParams, beta: f32, ) -> RMSProp<Self::SelfGrads>

where <Self as BackpropModule<X>>::SelfGrads: Gradients, <Self::SelfGrads as Gradients>::Concrete: Float,

Returns a GradApplyer object needed to train using rmsprop.

fn new_rmsprop_with_momentum( &self, params: TrainParams, momentum_coefficient: f32, beta: f32, ) -> RMSProp<Self::SelfGrads>

where <Self as BackpropModule<X>>::SelfGrads: Gradients, <Self::SelfGrads as Gradients>::Concrete: Float,

Returns a GradApplyer object needed to train using rmsprop + momentum.

impl<E: Clone + Dtype, const I: usize, M: Clone + Default + Module<[E; I]>> Clone for Residual<E, I, M>

fn clone(&self) -> Residual<E, I, M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug + Dtype, const I: usize, M: Debug + Default + Module<[E; I]>> Debug for Residual<E, I, M>

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

Formats the value using the given formatter.

impl<E: Default + Dtype, const I: usize, M: Default + Default + Module<[E; I]>> Default for Residual<E, I, M>

fn default() -> Residual<E, I, M>

Returns the “default value” for a type.

impl<E: Dtype, const I: usize, M: Default + Module<[E; I]> + LoadableModule> LoadableModule for Residual<E, I, M>

fn save( &self, path: String, dict: &mut HashMap<String, Vec<f64>>, ) -> Result<(), LoadSaveError>

Saves the parameters to the given dictionary.

fn load( &mut self, path: String, dict: &HashMap<String, Vec<f64>>, ) -> Result<(), LoadSaveError>

Loads the parameters from the given dictionary.

impl<E: Dtype, const I: usize, M: Default + Module<[E; I], Output = [E; I]>> Module<[E; I]> for Residual<E, I, M>

type Output = <M as Module<[E; I]>>::Output

The type that this unit produces given Input.

fn forward(&self, x: &[E; I]) -> Result<Self::Output, Error>

impl<E: Dtype, const I: usize, M: Default + Module<[E; I]> + ResetParams> ResetParams for Residual<E, I, M>

fn rand_params<RNG: Rng>( &mut self, rng: &mut RNG, scale: f32, ) -> Result<(), Error>

Sensibly initializes the learnable parameters of some module.

impl<E: Dtype, const I: usize, M: Default + Module<[E; I], Output = [E; I]> + TracedModule<[E; I]>> TracedModule<[E; I]> for Residual<E, I, M>

type Trace = <M as TracedModule<[E; I]>>::Trace

The type that this unit produces to describe intermediate state.

fn traced_forward( &self, x: [E; I], ) -> Result<(<Self as Module<[E; I]>>::Output, Self::Trace), Error>

Same as Module::forward, except intermediate computations that are needed for backprop are returned.