Struct burn::nn::pool::MaxPool1d

pub struct MaxPool1d {
    pub stride: usize,
    pub kernel_size: usize,
    pub padding: Ignored<PaddingConfig1d>,
    pub dilation: usize,
}

Applies a 1D max pooling over input tensors.

Should be created with MaxPool1dConfig.

Fields

stride: usize

The stride.

kernel_size: usize

The size of the kernel.

padding: Ignored<PaddingConfig1d>

The padding configuration.

dilation: usize

The dilation.

Implementations

impl MaxPool1d

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

where B: Backend,

Applies the forward pass on the input tensor.

See max_pool1d for more information.

Shapes

• input: [batch_size, channels, length_in]
• output: [batch_size, channels, length_out]

Trait Implementations

impl<B> AutodiffModule<B> for MaxPool1d

where B: AutodiffBackend,

type InnerModule = MaxPool1d

Inner module without auto-differentiation.

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

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

impl Clone for MaxPool1d

fn clone(&self) -> MaxPool1d

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaxPool1d

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

Formats the value using the given formatter.

impl Display for MaxPool1d

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

Formats the value using the given formatter.

impl<B> Module<B> for MaxPool1d

where B: Backend,

type Record = ConstantRecord

Type to save and load the module.

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

where V: ModuleVisitor<B>,

Visit each tensor parameter in the module with a visitor.

fn map<M>(self, _mapper: &mut M) -> MaxPool1d

where M: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.

fn load_record(self, _record: <MaxPool1d as Module<B>>::Record) -> MaxPool1d

Load the module state from a record.

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

Convert the module into a record containing the state.

fn to_device(self, _: &<B as Backend>::Device) -> MaxPool1d

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

fn fork(self, _: &<B as Backend>::Device) -> MaxPool1d

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

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 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 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 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 ModuleDisplay for MaxPool1d

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.

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

Formats the module with provided display settings.

impl ModuleDisplayDefault for MaxPool1d

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.