BlackCat_Tensors
A GPU-supported autograd and linear algebra library, designed for neural network construction
Public Types | Public Member Functions | List of all members
bc::nn::Max_Pooling< SystemTag, ValueType > Struct Template Reference

#include <max_pooling.h>

Inheritance diagram for bc::nn::Max_Pooling< SystemTag, ValueType >:
Inheritance graph
[legend]
Collaboration diagram for bc::nn::Max_Pooling< SystemTag, ValueType >:
Collaboration graph
[legend]

Public Types

using input_tensor_dim = bc::traits::Integer< 3 >
 
using output_tensor_dim = bc::traits::Integer< 3 >
 
using input_tensor_descriptor_t = Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > >
 
using system_tag = SystemTag
 
using value_type = ValueType
 
using self_type = Max_Pooling< SystemTag, ValueType >
 
using parent_type = Layer_Base< self_type, input_tensor_descriptor_t >
 
using allocator_type = nn_default_allocator_type< ValueType, SystemTag >
 
using greedy_evaluate_delta = std::true_type
 
using requires_extra_cache = std::true_type
 
using defines_single_predict = std::true_type
 
- Public Types inherited from bc::nn::Layer_Base< Max_Pooling< SystemTag, ValueType >, Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
using value_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::value_type
 
using system_tag = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::system_tag
 
using allocator_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::allocator_type
 
using input_tensor_dim = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::tensor_dim
 
using shape_type = bc::Dim< input_tensor_dim::value >
 
using input_tensor_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::type
 
using batched_input_tensor_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::batched_type
 
using output_value_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::value_type
 
using output_system_tag = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::system_tag
 
using output_allocator_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::allocator_type
 
using output_tensor_dim = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::tensor_dim
 
using output_shape_type = bc::Dim< output_tensor_dim::value >
 
using output_tensor_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::type
 
using batched_output_tensor_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::batched_type
 
- Public Types inherited from bc::nn::Layer_Output_Base< Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
using output_value_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::value_type
 
using output_value_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::value_type
 
using output_system_tag = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::system_tag
 
using output_system_tag = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::system_tag
 
using output_allocator_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::allocator_type
 
using output_allocator_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::allocator_type
 
using output_tensor_dim = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::tensor_dim
 
using output_tensor_dim = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::tensor_dim
 
using output_shape_type = bc::Dim< output_tensor_dim::value >
 
using output_shape_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::shape_type
 
using output_tensor_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::type
 
using output_tensor_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::tensor_type
 
using batched_output_tensor_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::batched_type
 
using batched_output_tensor_type = typename Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > ::batched_type
 
using next_layer_type = Layer_Input_Base< Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
 
using next_layer_type = Layer_Input_Base< Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
 

Public Member Functions

 Max_Pooling (Dim< 3 > img_dims, Dim< 2 > krnl_dims={3, 3}, Dim< 2 > padding={0, 0}, Dim< 2 > strides={-1,-1})
 
template<class Image >
auto forward_propagation (const Image &image, Cache &cache)
 
template<class Image >
auto single_predict (const Image &image, Cache &cache)
 
template<class Image , class Delta >
auto back_propagation (const Image &image, const Delta &pooled_delta, Cache &cache)
 
- Public Member Functions inherited from bc::nn::Layer_Base< Max_Pooling< SystemTag, ValueType >, Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
 Layer_Base (std::string classname, shape_type input_shape, output_shape_type output_shape)
 m_classname should be initialized by supplying __func__ to the first argument of the Layer_Base. More...
 
 Layer_Base (std::string classname, shape_type input_shape)
 
virtual ~Layer_Base ()
 
virtual output_shape_type get_output_shape () const
 
virtual shape_type get_input_shape () const
 
auto get_batched_input_shape () const
 
auto get_batched_output_shape () const
 
bc::size_t input_size () const
 
bc::size_t output_size () const
 
bc::size_t batch_size () const
 
bc::size_t batched_input_size () const
 
bc::size_t batched_output_size () const
 
void set_batch_size (int batch_size)
 
virtual void set_batch_size_hook (int batch_size)
 
void set_learning_rate (value_type learning_rate)
 
virtual void set_learning_rate_hook (value_type learning_rate)
 
auto get_learning_rate () const
 
auto get_batched_learning_rate () const
 
virtual void save (Layer_Loader &) const
 
virtual void save_from_cache (Layer_Loader &, const Cache &) const
 
virtual void load (Layer_Loader &)
 
virtual void load_to_cache (Layer_Loader &, const Cache &)
 
void copy_training_data_to_single_predict (Cache &, int batch_index)
 
void update_weights ()
 
void clear_bp_storage (Cache &)
 
const std::string & classname () const
 Returns the derived_classes class namepse. More...
 
std::string get_string_architecture () const
 
virtual std::string get_string_architecture_hook () const
 
auto default_input_tensor_factory () const
 
auto default_output_tensor_factory () const
 
auto default_batched_input_tensor_factory () const
 
auto default_batched_output_tensor_factory () const
 
- Public Member Functions inherited from bc::nn::Layer_Input_Base< Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
void set_prev (prev_layer_type &prev)
 
void set_prev (prev_layer_type &prev)
 
input_shape_type input_shape () const
 
input_shape_type input_shape () const
 
const prev_layer_type & prev_layer () const
 
prev_layer_type & prev_layer ()
 
const prev_layer_type & prev_layer () const
 
prev_layer_type & prev_layer ()
 
virtual ~Layer_Input_Base ()
 
virtual ~Layer_Input_Base ()
 
- Public Member Functions inherited from bc::nn::Layer_Output_Base< Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
void set_next (next_layer_type &next)
 
void set_next (next_layer_type &next)
 
output_shape_type output_shape () const
 
output_shape_type output_shape () const
 
const next_layer_type & next_layer () const
 
next_layer_type & next_layer ()
 
const next_layer_type & next_layer () const
 
next_layer_type & next_layer ()
 
virtual ~Layer_Output_Base ()
 
virtual ~Layer_Output_Base ()
 

Additional Inherited Members

- Static Public Member Functions inherited from bc::nn::Layer_Base< Max_Pooling< SystemTag, ValueType >, Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
static std::string parse_classname (std::string classname)
 
- Static Public Attributes inherited from bc::nn::Layer_Base< Max_Pooling< SystemTag, ValueType >, Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
static constexpr value_type default_learning_rate
 
- Protected Attributes inherited from bc::nn::Layer_Base< Max_Pooling< SystemTag, ValueType >, Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
shape_type m_input_shape
 
output_shape_type m_output_shape
 
- Protected Attributes inherited from bc::nn::Layer_Input_Base< Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
prev_layer_type * m_prev_layer
 
input_shape_type m_input_shape
 
- Protected Attributes inherited from bc::nn::Layer_Output_Base< Tensor_Descriptor< ValueType, SystemTag, Integer< 3 > > >
next_layer_type * m_next_layer
 
bc::Dim< output_tensor_dim::value > m_output_shape
 

Member Typedef Documentation

◆ allocator_type

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::allocator_type = nn_default_allocator_type<ValueType, SystemTag>

◆ defines_single_predict

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::defines_single_predict = std::true_type

◆ greedy_evaluate_delta

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::greedy_evaluate_delta = std::true_type

◆ input_tensor_descriptor_t

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::input_tensor_descriptor_t = Tensor_Descriptor<ValueType, SystemTag, Integer<3> >

◆ input_tensor_dim

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::input_tensor_dim = bc::traits::Integer<3>

◆ output_tensor_dim

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::output_tensor_dim = bc::traits::Integer<3>

◆ parent_type

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::parent_type = Layer_Base<self_type, input_tensor_descriptor_t>

◆ requires_extra_cache

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::requires_extra_cache = std::true_type

◆ self_type

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::self_type = Max_Pooling<SystemTag, ValueType>

◆ system_tag

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::system_tag = SystemTag

◆ value_type

template<class SystemTag, class ValueType>
using bc::nn::Max_Pooling< SystemTag, ValueType >::value_type = ValueType

Constructor & Destructor Documentation

◆ Max_Pooling()

template<class SystemTag, class ValueType>
bc::nn::Max_Pooling< SystemTag, ValueType >::Max_Pooling ( Dim< 3 >  img_dims,
Dim< 2 >  krnl_dims = {3,3},
Dim< 2 >  padding = {0,0},
Dim< 2 >  strides = {-1,-1} 
)
inline

Member Function Documentation

◆ back_propagation()

template<class SystemTag, class ValueType>
template<class Image , class Delta >
auto bc::nn::Max_Pooling< SystemTag, ValueType >::back_propagation ( const Image &  image,
const Delta &  pooled_delta,
Cache &  cache 
)
inline

◆ forward_propagation()

template<class SystemTag, class ValueType>
template<class Image >
auto bc::nn::Max_Pooling< SystemTag, ValueType >::forward_propagation ( const Image &  image,
Cache &  cache 
)
inline

◆ single_predict()

template<class SystemTag, class ValueType>
template<class Image >
auto bc::nn::Max_Pooling< SystemTag, ValueType >::single_predict ( const Image &  image,
Cache &  cache 
)
inline
The documentation for this struct was generated from the following file:
Generated by   doxygen 1.8.13