Skip to main content

PoolingLayerParams

Struct PoolingLayerParams 

Source
pub struct PoolingLayerParams {
    pub type: i32,
    pub kernel_size: Vec<u64>,
    pub stride: Vec<u64>,
    pub avg_pool_exclude_padding: bool,
    pub global_pooling: bool,
    pub pooling_padding_type: Option<PoolingPaddingType>,
}
Expand description

A spatial pooling layer.

.. code::

  y = PoolingLayer(x)

Requires 1 input and produces 1 output.

Input A blob with rank greater than equal to 4. Rank 4 blob represents [Batch, channels, height, width] For ranks greater than 4, the leading dimensions, starting from 0 to -4 (inclusive), are all treated as batch.

Output Rank is same as the input. e.g.: for rank 4 input, output shape is [B, C, H_out, W_out]

Padding options are similar to ConvolutionLayerParams with the additional option of ValidCompletePadding (includeLastPixel), which ensures that the last application of the kernel always includes the last pixel of the input image, if there is padding.

.. code::

 H_out = ceil(float(H_in + 2 * paddingAmounts\[0\] - kernelSize\[0\])/float(Stride\[0\])) + 1
 if (paddingAmounts\[0\] > 0 or paddingAmounts\[1\] > 0)
      if ((H_out - 1) * Stride >= H_in + paddingAmounts\[0\]) {
          H_out = H_out - 1
      }
 }

The equivalent expressions hold true for W_out as well. Only symmetric padding is supported with this option.

Fields§

§type: i32

Type of pooling operation.

§kernel_size: Vec<u64>

Must be length 2 in the order \[H, W\]. If not set, default value \[3, 3\] is used.

§stride: Vec<u64>

Must be length 2 in the order \[H, W\]. If not set, default value \[1, 1\] is used.

§avg_pool_exclude_padding: bool

If true, padded values are excluded from the count (denominator) when computing average pooling.

§global_pooling: bool

If true, global pooling is performed. Kernel size is inferred from the input data spatial dimensions.

§pooling_padding_type: Option<PoolingPaddingType>

Implementations§

Source§

impl PoolingLayerParams

Source

pub fn type(&self) -> PoolingType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

Source

pub fn set_type(&mut self, value: PoolingType)

Sets type to the provided enum value.

Trait Implementations§

Source§

impl Clone for PoolingLayerParams

Source§

fn clone(&self) -> PoolingLayerParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PoolingLayerParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PoolingLayerParams

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Message for PoolingLayerParams

Source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
Source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.
Source§

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes an instance of the message from a buffer. Read more
Source§

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes a length-delimited instance of the message from the buffer.
Source§

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self. Read more
Source§

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.
Source§

impl PartialEq for PoolingLayerParams

Source§

fn eq(&self, other: &PoolingLayerParams) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PoolingLayerParams

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.