Struct dfdx::nn::Residual

pub struct Residual<F>(pub F);

A residual connection around F: F(x) + x, as introduced in Deep Residual Learning for Image Recognition.

Generics

• F: The underlying module to do a skip connection around.

Examples

let module: Residual<ReLU> = Default::default();
let x = Tensor1D::new([-2.0, -1.0, 0.0, 1.0, 2.0]);
let y = module.forward(x);
assert_eq!(y.data(), &[-2.0, -1.0, 0.0, 2.0, 4.0]);

Tuple Fields

0: F

Trait Implementations

impl<F: CanUpdateWithGradients> CanUpdateWithGradients for Residual<F>

fn update<G: GradientProvider>(
    &mut self,
    grads: &mut G,
    unused: &mut UnusedTensors
)

Pass through to F’s CanUpdateWithGradients.

impl<F: Clone> Clone for Residual<F>

fn clone(&self) -> Residual<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for Residual<F>

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

Formats the value using the given formatter.

impl<F: Default> Default for Residual<F>

fn default() -> Residual<F>

Returns the “default value” for a type.

impl<F: LoadFromNpz> LoadFromNpz for Residual<F>

fn read<R>(
    &mut self,
    filename_prefix: &str,
    r: &mut ZipArchive<R>
) -> Result<(), NpzError> where
    R: Read + Seek, 

Pass through to F’s LoadFromNpz.

fn load<P: AsRef<Path>>(&mut self, path: P) -> Result<(), NpzError>

Loads data from a .npz zip archive at the specified path.

impl<T, F> Module<T> for Residual<F> where
    T: Tensor<Dtype = f32>,
    F: Module<T, Output = T>, 

fn forward(&self, x: T) -> Self::Output

Calls forward on F and then adds x to the result: F(x) + x

type Output = <F as Module<T>>::Output

The type that this unit produces given Input.

fn forward_mut(&mut self, input: Input) -> Self::Output

Pass an Input through the unit and produce Self::Output. Can be implemented for multiple Input types.

impl<F: ResetParams> ResetParams for Residual<F>

fn reset_params<R: Rng>(&mut self, rng: &mut R)

Pass through to F’s ResetParams.

impl<F: SaveToNpz> SaveToNpz for Residual<F>

fn write<W>(&self, filename_prefix: &str, w: &mut ZipWriter<W>) -> ZipResult<()> where
    W: Write + Seek, 

Pass through to F’s SaveToNpz.

fn save<P: AsRef<Path>>(&self, path: P) -> ZipResult<()>

Save this object into the .npz file determined located at path.