Struct burn_core::nn::pool::AvgPool2d

pub struct AvgPool2d { /* private fields */ }

Applies a 2D avg pooling over input tensors.

See AvgPool2dConfig for details.

Remarks

The zero-padding values will be included in the calculation of the average. This means that the zeros are counted as legitimate values, and they contribute to the denominator when calculating the average. This is equivalent to torch.nn.AvgPool2d with count_include_pad=True.

TODO: Add support for count_include_pad=False, see Issue 636

Implementations

impl AvgPool2d

pub fn forward<B: Backend>(&self, input: Tensor<B, 4>) -> Tensor<B, 4>

Applies the forward pass on the input tensor.

Shapes

• input: [batch_size, channels, height_in, width_in],
• output: [batch_size, channels, height_out, width_out],

Trait Implementations

impl<B: AutodiffBackend> AutodiffModule<B> for AvgPool2d

type InnerModule = AvgPool2d

Inner module without auto-differentiation.

fn valid(&self) -> Self::InnerModule

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

impl Clone for AvgPool2d

fn clone(&self) -> AvgPool2d

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AvgPool2d

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

Formats the value using the given formatter.

impl<B: Backend> Module<B> for AvgPool2d

type Record = ConstantRecord

Type to save and load the module.

fn visit<V: ModuleVisitor<B>>(&self, _visitor: &mut V)

Visit each tensor parameter in the module with a visitor.

fn map<M: ModuleMapper<B>>(self, _mapper: &mut M) -> Self

Map each tensor parameter in the module with a mapper.

fn load_record(self, _record: Self::Record) -> Self

Load the module state from a record.

fn into_record(self) -> Self::Record

Convert the module into a record containing the state.

fn to_device(self, _: &B::Device) -> Self

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

fn fork(self, _: &B::Device) -> Self

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

fn collect_devices(&self, devices: Devices<B>) -> Devices<B>

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

fn devices(&self) -> Devices<B>

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 num_params(&self) -> usize

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

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::Device ) -> Result<Self, RecorderError>

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

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