opennn::Pooling Class Reference

2D spatial pooling layer supporting max and average reduction. More...

#include <pooling_layer.h>

Inheritance diagram for opennn::Pooling:

Public Member Functions
	Pooling (const Shape &={2, 2, 1}, const Shape &={ 2, 2 }, const Shape &={ 2, 2 }, const Shape &={ 0, 0 }, const string &="MaxPooling", const string &="pooling_layer")
	Constructs a pooling layer with given input, pool, stride and padding shapes.
Shape	get_input_shape () const override
	Returns the input tensor shape (height, width, channels).
Shape	get_output_shape () const override
	Returns the output tensor shape after pooling.
Index	get_output_height () const
	Returns the output feature map height.
Index	get_output_width () const
	Returns the output feature map width.
Index	get_input_height () const
Index	get_input_width () const
Index	get_input_channels () const
Index	get_pool_height () const
Index	get_pool_width () const
Index	get_row_stride () const
Index	get_column_stride () const
Index	get_padding_height () const
Index	get_padding_width () const
PoolingMethod	get_pooling_method () const
vector< TensorSpec >	get_forward_specs (Index batch_size) const override
	Returns the tensor specifications used during forward propagation.
void	set (const Shape &={ 0, 0, 0 }, const Shape &={ 1, 1 }, const Shape &={ 1, 1 }, const Shape &={ 0, 0 }, const string &="MaxPooling", const string &="pooling_layer")
	Reconfigures the layer with new shapes and pooling method.
void	set_input_shape (const Shape &) override
	Updates the layer for a new input shape.
void	set_pool_size (Index, Index)
	Sets the pooling window height and width.
void	set_row_stride (Index)
void	set_column_stride (Index)
void	set_padding_height (Index)
void	set_padding_width (Index)
void	set_pooling_method (const string &)
	Sets the pooling method by name ("MaxPooling" or "AveragePooling").
void	read_JSON_body (const Json *) override
	Reads the layer configuration from a JSON node.
void	write_JSON_body (JsonWriter &) const override
	Writes the layer configuration to a JSON writer.
Public Member Functions inherited from opennn::Layer
virtual	~Layer ()=default
const string &	get_label () const
const string &	get_name () const
LayerType	get_type () const
virtual void	set_output_shape (const Shape &)
	Sets the output shape; subclasses override when the output is user-configurable.
void	set_label (string new_label)
Index	get_parameters_number () const
	Returns the total number of trainable parameters owned by this layer.
const vector< Operator * > &	get_operators () const
virtual vector< TensorSpec >	get_parameter_specs () const
	Returns the tensor specs of trainable parameters; subclasses override.
virtual vector< TensorSpec >	get_state_specs () const
	Returns the tensor specs of persistent state (e.g. running mean/variance).
virtual vector< TensorSpec >	get_backward_specs (Index batch_size) const
	Returns the tensor specs of the backward workspace; empty for non-trainable layers.
virtual ActivationOp::Function	get_output_activation () const
	Returns the layer's output activation (Identity for most layers; overridden by Dense/Bounding).
Index	get_inputs_number () const
Index	get_outputs_number () const
virtual void	forward_propagate (ForwardPropagation &fp, size_t layer, bool is_training) noexcept
	Runs the forward pass by chaining the layer's operators in order.
virtual void	back_propagate (ForwardPropagation &fp, BackPropagation &bp, size_t i) const noexcept
	Runs the backward pass by chaining the layer's operators in reverse order.
virtual void	from_JSON (const JsonDocument &document)
	Restores layer configuration and parameters from a JSON document.
virtual void	load_state_from_JSON (const JsonDocument &document)
	Restores persistent state (e.g. running statistics) from a JSON document.
virtual void	to_JSON (JsonWriter &writer) const
	Serializes layer configuration and parameters to a JSON writer.
virtual string	write_expression (const vector< string > &, const vector< string > &) const
	Returns a human-readable mathematical expression for this layer (empty by default).
virtual void	print () const
	Prints a human-readable summary of the layer to standard output.
bool	get_is_trainable () const
Type	get_compute_dtype () const
void	set_compute_dtype (Type new_compute_dtype)
	Sets the compute dtype and notifies subclasses via on_compute_dtype_changed().
virtual void	on_compute_dtype_changed ()
	Subclass hook invoked when the compute dtype changes; default is no-op.
virtual float *	link_states (float *pointer)
	Binds the persistent-state region of the shared buffer to operator views.
float *	link_gradients (float *pointer, vector< TensorView > &gradient_views)
	Binds the gradient slice of the shared buffer to operator gradient views.
vector< TensorView > &	get_parameter_views ()
const vector< TensorView > &	get_parameter_views () const
void	redistribute_parameters_to_operators ()
	Re-binds operator parameter views after the parameter buffer has been resized or moved.

Additional Inherited Members
Protected Types inherited from opennn::Layer
enum	Forward { Input , Output }
enum	Backward { OutputDelta , InputDelta }
Protected Member Functions inherited from opennn::Layer
	Layer ()=default
	Layer (LayerType t, bool trainable=true)
float *	link_views_to_operators (vector< TensorView > &views, float *pointer, vector< TensorSpec >(Operator::*specs_fn)() const, void(Operator::*link_fn)(span< const TensorView >))
Protected Attributes inherited from opennn::Layer
string	label = "my_layer"
LayerType	layer_type = LayerType::Dense
bool	is_trainable = true
Shape	input_shape
Type	compute_dtype = Type::FP32
vector< TensorView >	parameters
vector< TensorView >	states
vector< Operator * >	operators

Detailed Description

2D spatial pooling layer supporting max and average reduction.

Constructor & Destructor Documentation

Pooling()

opennn::Pooling::Pooling	(	const Shape &	= {2, 2, 1},
		const Shape &	= { 2, 2 },
		const Shape &	= { 2, 2 },
		const Shape &	= { 0, 0 },
		const string &	= "MaxPooling",
		const string &	= "pooling_layer" )

Constructs a pooling layer with given input, pool, stride and padding shapes.

Parameters

input_shape	Shape of the input tensor (height, width, channels).
pool_shape	Pooling window size (height, width).
stride_shape	Stride along height and width.
padding_shape	Padding along height and width.
pooling_method	"MaxPooling" or "AveragePooling".
name	Layer name used for serialization.

Member Function Documentation

get_column_stride()

Index opennn::Pooling::get_column_stride ( ) const

inline

get_forward_specs()

vector< TensorSpec > opennn::Pooling::get_forward_specs ( Index batch_size ) const

overridevirtual

Returns the tensor specifications used during forward propagation.

Reimplemented from opennn::Layer.

get_input_channels()

Index opennn::Pooling::get_input_channels ( ) const

inline

get_input_height()

Index opennn::Pooling::get_input_height ( ) const

inline

get_input_shape()

Shape opennn::Pooling::get_input_shape ( ) const

inlineoverridevirtual

Returns the input tensor shape (height, width, channels).

Reimplemented from opennn::Layer.

get_input_width()

Index opennn::Pooling::get_input_width ( ) const

inline

get_output_height()

Index opennn::Pooling::get_output_height

(

)

const

Returns the output feature map height.

get_output_shape()

Shape opennn::Pooling::get_output_shape ( ) const

overridevirtual

Returns the output tensor shape after pooling.

Implements opennn::Layer.

get_output_width()

Index opennn::Pooling::get_output_width

(

)

const

Returns the output feature map width.

get_padding_height()

Index opennn::Pooling::get_padding_height ( ) const

inline

get_padding_width()

Index opennn::Pooling::get_padding_width ( ) const

inline

get_pool_height()

Index opennn::Pooling::get_pool_height ( ) const

inline

get_pool_width()

Index opennn::Pooling::get_pool_width ( ) const

inline

get_pooling_method()

PoolingMethod opennn::Pooling::get_pooling_method ( ) const

inline

get_row_stride()

Index opennn::Pooling::get_row_stride ( ) const

inline

read_JSON_body()

void opennn::Pooling::read_JSON_body ( const Json * )

overridevirtual

Reads the layer configuration from a JSON node.

Reimplemented from opennn::Layer.

set()

void opennn::Pooling::set	(	const Shape &	= { 0, 0, 0 },
		const Shape &	= { 1, 1 },
		const Shape &	= { 1, 1 },
		const Shape &	= { 0, 0 },
		const string &	= "MaxPooling",
		const string &	= "pooling_layer" )

Reconfigures the layer with new shapes and pooling method.

set_column_stride()

void opennn::Pooling::set_column_stride

(

Index

)

set_input_shape()

void opennn::Pooling::set_input_shape ( const Shape & )

overridevirtual

Updates the layer for a new input shape.

Reimplemented from opennn::Layer.

set_padding_height()

void opennn::Pooling::set_padding_height

(

Index

)

set_padding_width()

void opennn::Pooling::set_padding_width

(

Index

)

set_pool_size()

void opennn::Pooling::set_pool_size	(	Index	,
		Index	)

Sets the pooling window height and width.

set_pooling_method()

void opennn::Pooling::set_pooling_method

(

const string &

)

Sets the pooling method by name ("MaxPooling" or "AveragePooling").

set_row_stride()

void opennn::Pooling::set_row_stride

(

Index

)

write_JSON_body()

void opennn::Pooling::write_JSON_body ( JsonWriter & ) const

overridevirtual

Writes the layer configuration to a JSON writer.

Reimplemented from opennn::Layer.