Loading...
Searching...
No Matches
opennn::Pooling Class Referencefinal

#include <opennn/network/layers/pooling_layer.h>

Inheritance diagram for opennn::Pooling:
opennn::Layer

Public Member Functions

 Pooling (const Shape &={2, 2, 1}, const Shape &={ 2, 2 }, const Shape &={ 2, 2 }, const Shape &={ 0, 0 }, PoolingMethod=PoolingMethod::MaxPooling, const string &="pooling_layer")
 
Shape get_input_shape () const noexcept override
 
Shape get_output_shape () const override
 
Index get_output_height () const
 
Index get_output_width () const
 
Index get_pool_height () const noexcept
 
Index get_pool_width () const noexcept
 
Index get_row_stride () const noexcept
 
Index get_column_stride () const noexcept
 
Index get_padding_height () const noexcept
 
Index get_padding_width () const noexcept
 
PoolingMethod get_pooling_method () const noexcept
 
bool is_passthrough () const noexcept
 
vector< TensorSpec > get_forward_specs (Index) const override
 
vector< TensorSpec > get_backward_specs (Index) const override
 
void forward_propagate (ForwardPropagation &, size_t, ForwardPropagationMode) override
 
void back_propagate (ForwardPropagation &, BackPropagation &, size_t) const override
 
void set (const Shape &={ 0, 0, 0 }, const Shape &={ 1, 1 }, const Shape &={ 1, 1 }, const Shape &={ 0, 0 }, PoolingMethod=PoolingMethod::MaxPooling, const string &="pooling_layer")
 
bool accepts_input_rank (Index rank) const override
 
void apply_input_shape (const Shape &) override
 
void set_pooling_method (PoolingMethod)
 
void set_pooling_method (const string &)
 
void read_JSON_body (const Json *) override
 
void write_JSON_body (JsonWriter &) const override
 
- Public Member Functions inherited from opennn::Layer
virtual ~Layer ()=default
 
const string & get_label () const noexcept
 
const string & get_name () const
 
LayerType get_type () const noexcept
 
void set_input_shape (const Shape &new_input_shape)
 
virtual void set_output_shape (const Shape &)
 
void set_label (string new_label)
 
Index get_parameters_number () const
 
const vector< Operator * > & get_operators () const noexcept
 
virtual vector< TensorSpec > get_parameter_specs () const
 
virtual vector< TensorSpec > get_state_specs () const
 
virtual bool is_forward_slot_inference_elidable (size_t, Device) const noexcept
 
virtual size_t get_recomputable_forward_slot () const noexcept
 
virtual void recompute_forward_slot (ForwardPropagation &, size_t)
 
virtual bool backward_uses_forward_output () const noexcept
 
virtual bool backward_uses_input (size_t) const noexcept
 
virtual bool preserves_output_delta_during_backward () const noexcept
 
virtual bool allows_input_delta_alias () const noexcept
 
virtual bool folds_input_delta_addend (size_t) const noexcept
 
virtual ActivationFunction get_output_activation () const
 
virtual Index get_sources_number () const noexcept
 
virtual bool allows_successors () const noexcept
 
virtual bool is_recurrent () const noexcept
 
virtual bool skip_for_pre_scaled_input () const noexcept
 
virtual bool uses_sequence_position () const noexcept
 
virtual bool allows_bf16_input_cast (size_t) const noexcept
 
Index get_inputs_number () const noexcept
 
Index get_outputs_number () const
 
virtual void from_JSON (const JsonDocument &)
 
virtual void on_loaded ()
 
virtual void load_state_from_JSON (const JsonDocument &)
 
virtual void to_JSON (JsonWriter &) const
 
virtual string write_expression (const vector< string > &, const vector< string > &) const
 
bool get_is_trainable () const noexcept
 
void set_is_trainable (bool trainable)
 
Type get_compute_dtype () const noexcept
 
Device get_compute_device () const noexcept
 
void set_compute_dtype (Type new_compute_dtype)
 
void set_compute_device (Device new_compute_device)
 
virtual void on_compute_dtype_changed ()
 
virtual float * link_states (float *, Device)
 
float * link_gradients (float *, Device)
 
vector< TensorView > & get_parameter_views ()
 
const vector< TensorView > & get_parameter_views () const noexcept
 
vector< TensorView > & get_parameter_scales ()
 
const vector< TensorView > & get_parameter_scales () const noexcept
 
vector< Operator::SlotQuantization > get_parameter_quantization () const
 
virtual TiedWeight get_tied_weight () const
 
virtual void set_tied_weight (const TiedWeight &tied_weight)
 
void redistribute_parameters_to_operators ()
 

Additional Inherited Members

- Protected Types inherited from opennn::Layer
enum  Forward { Input , Output }
 
- Protected Member Functions inherited from opennn::Layer
 Layer (LayerType type, Trainability trainability=Trainability::Trainable)
 
float * link_views_to_operators (vector< TensorView > &, float *, vector< TensorSpec >(Operator::*specs_fn)() const, void(Operator::*link_fn)(span< const TensorView >), Device)
 
- Static Protected Member Functions inherited from opennn::Layer
static bool refresh_feature_storage (Buffer &storage, bool &dirty, Device device, Index features, Index columns, const function< void(float *)> &fill)
 
- Protected Attributes inherited from opennn::Layer
string label = "my_layer"
 
bool is_trainable = true
 
Shape input_shape
 
Type compute_dtype = Type::FP32
 
Type weights_dtype = Type::FP32
 
Device compute_device = Device::CPU
 
vector< TensorView > parameters
 
vector< TensorView > parameter_scales
 
vector< TensorView > states
 
vector< Operator * > operators
 

Constructor & Destructor Documentation

◆ Pooling()

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

Member Function Documentation

◆ accepts_input_rank()

bool opennn::Pooling::accepts_input_rank ( Index rank) const
inlineoverridevirtual

Reimplemented from opennn::Layer.

◆ apply_input_shape()

void opennn::Pooling::apply_input_shape ( const Shape & )
overridevirtual

Reimplemented from opennn::Layer.

◆ back_propagate()

void opennn::Pooling::back_propagate ( ForwardPropagation & ,
BackPropagation & ,
size_t  ) const
overridevirtual

Reimplemented from opennn::Layer.

◆ forward_propagate()

void opennn::Pooling::forward_propagate ( ForwardPropagation & ,
size_t ,
ForwardPropagationMode  )
overridevirtual

Reimplemented from opennn::Layer.

◆ get_backward_specs()

vector< TensorSpec > opennn::Pooling::get_backward_specs ( Index ) const
overridevirtual

Reimplemented from opennn::Layer.

◆ get_column_stride()

Index opennn::Pooling::get_column_stride ( ) const
inlinenoexcept

◆ get_forward_specs()

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

Reimplemented from opennn::Layer.

◆ get_input_shape()

Shape opennn::Pooling::get_input_shape ( ) const
inlineoverridevirtualnoexcept

Reimplemented from opennn::Layer.

◆ get_output_height()

Index opennn::Pooling::get_output_height ( ) const

◆ get_output_shape()

Shape opennn::Pooling::get_output_shape ( ) const
overridevirtual

Implements opennn::Layer.

◆ get_output_width()

Index opennn::Pooling::get_output_width ( ) const

◆ get_padding_height()

Index opennn::Pooling::get_padding_height ( ) const
inlinenoexcept

◆ get_padding_width()

Index opennn::Pooling::get_padding_width ( ) const
inlinenoexcept

◆ get_pool_height()

Index opennn::Pooling::get_pool_height ( ) const
inlinenoexcept

◆ get_pool_width()

Index opennn::Pooling::get_pool_width ( ) const
inlinenoexcept

◆ get_pooling_method()

PoolingMethod opennn::Pooling::get_pooling_method ( ) const
inlinenoexcept

◆ get_row_stride()

Index opennn::Pooling::get_row_stride ( ) const
inlinenoexcept

◆ is_passthrough()

bool opennn::Pooling::is_passthrough ( ) const
noexcept

◆ read_JSON_body()

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

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 },
PoolingMethod = PoolingMethod::MaxPooling,
const string & = "pooling_layer" )

◆ set_pooling_method() [1/2]

void opennn::Pooling::set_pooling_method ( const string & )

◆ set_pooling_method() [2/2]

void opennn::Pooling::set_pooling_method ( PoolingMethod )

◆ write_JSON_body()

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

Reimplemented from opennn::Layer.