Struct dfdx::nn::MaxPoolGlobal

pub struct MaxPoolGlobal;

Applies max pooling over an entire image, fully reducing the height and width dimensions:

• Reduces 2d (C, L) to 1d (C, )
• Reduces 3d (C, H, W) to 1d (C, )
• Reduces 4d (B, C, H, W) to 2d (B, C)

Pytorch equivalent: torch.nn.AdaptiveMaxPool2d(1) followed by a flatten.

Examples:

let m: MaxPoolGlobal = Default::default();
let _: Tensor1D<5> = m.forward(Tensor3D::<5, 16, 8>::zeros());
let _: Tensor2D<10, 5> = m.forward(Tensor4D::<10, 5, 16, 8>::zeros());

Trait Implementations

impl CanUpdateWithGradients for MaxPoolGlobal

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

Updates self given the GradientProvider. When any parameters that are NOT present in G, then this function should add the tensor’s UniqueId to UnusedTensors.

impl Clone for MaxPoolGlobal

fn clone(&self) -> MaxPoolGlobal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for MaxPoolGlobal

fn default() -> MaxPoolGlobal

Returns the “default value” for a type.

impl LoadFromNpz for MaxPoolGlobal

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

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

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

Reads this object from a ZipArchive. r with a base filename of filename_prefix.

impl<const C: usize, const L: usize, T: Tape> Module<Tensor2D<C, L, T>> for MaxPoolGlobal

type Output = Tensor1D<C, T>

The type that this unit produces given Input.

fn forward(&self, input: Tensor2D<C, L, T>) -> Self::Output

Forward Input through the module and produce Module::Output.

impl<const C: usize, const H: usize, const W: usize, T: Tape> Module<Tensor3D<C, H, W, T>> for MaxPoolGlobal

type Output = Tensor1D<C, T>

The type that this unit produces given Input.

fn forward(&self, input: Tensor3D<C, H, W, T>) -> Self::Output

Forward Input through the module and produce Module::Output.

impl<const B: usize, const C: usize, const H: usize, const W: usize, T: Tape> Module<Tensor4D<B, C, H, W, T>> for MaxPoolGlobal

type Output = Tensor2D<B, C, T>

The type that this unit produces given Input.

fn forward(&self, input: Tensor4D<B, C, H, W, T>) -> Self::Output

Forward Input through the module and produce Module::Output.

impl<T> ModuleMut<T> for MaxPoolGlobalwhere
    Self: Module<T>,

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

The type that this unit produces given Input.

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

Forward Input through the module and produce ModuleMut::Output.

impl ResetParams for MaxPoolGlobal

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

Mutate the unit’s parameters using rand::Rng. Each implementor of this trait decides how the parameters are initialized. In fact, some impls may not even use the rng.

impl SaveToNpz for MaxPoolGlobal

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

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

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

Write this object into ZipWriter w with a base filename of filename_prefix.

impl Copy for MaxPoolGlobal