AIfES 2  2.0.0
ailayer_template.h
Go to the documentation of this file.
1 
25 #ifndef TEMPLATE_LAYER
26 #define TEMPLATE_LAYER
27 
28 #include "core/aifes_core.h"
29 
31 
36  ailayer_t base; // The base or super "class" of the layer.
39  // Configurations of the layer, that can be configured by the user when creating the layer
40  uint32_t example_configuration;
41 
42  // Tensor pointer for trainable parameters [DEPRECATED]
43  aitensor_t *params;
44  aitensor_t *d_params; // Gradients
45 
46  // If the shape of the result differs from the input shape, this array can be used for the result.
47  // If not, the result shape array of the input tensor can be used for the result tensor too.
48  uint16_t result_shape[2];
52  void *optimem[2];
54  // Make the math functions accessable for expert developers
55  void (*copy_tensor)(const aitensor_t *from, aitensor_t *to);
56  void (*tensor_add)(const aitensor_t *a, const aitensor_t *b, aitensor_t *result);
57 };
58 
59 extern const aicore_layertype_t *ailayer_template_type;
70 
76 
82 
88 
96 
102 void ailayer_template_set_paramem(ailayer_t *self, void *memory_ptr);
103 
111 
117 void ailayer_template_set_trainmem(ailayer_t *self, void *memory_ptr);
118 
119 #ifdef AIDEBUG_PRINT_MODULE_SPECS
125 #endif
126 
127 #endif // TEMPLATE_LAYER
AIfES 2 core interface.
void ailayer_template_print_specs(const ailayer_t *self)
Print the layer specification.
void ailayer_template_calc_result_shape(ailayer_t *self)
Calculate the shape of the result tensor.
void ailayer_template_set_trainmem(ailayer_t *self, void *memory_ptr)
Distribute provided memory to the training gradients pointers - mandatory for hidden layers
uint32_t ailayer_template_sizeof_paramem(const ailayer_t *self)
Calculate and return the parameter memory size needed for this layer - mandatory for hidden layers
void ailayer_template_set_paramem(ailayer_t *self, void *memory_ptr)
Distribute provided memory to the parameter pointers - mandatory for hidden layers
ailayer_t * ailayer_template(ailayer_template_t *layer, ailayer_t *input_layer)
Initialize the given layer struct - mandatory
void ailayer_template_forward(ailayer_t *self)
Calculate the forward path for given layer - mandatory
void ailayer_template_backward(ailayer_t *self)
Calculate the backward (training) path for the given layer - depends on usability in training
uint32_t ailayer_template_sizeof_trainmem(const ailayer_t *self)
Calculate and return the necessary memory size needed by this layer for training - mandatory for hidd...
Type indicator of the layer.
Definition: aifes_core.h:79
Template for general AIfES layers.
Definition: ailayer_template.h:35
aitensor_t * gradients[2]
Gradients structure for the back propagation algorithm.
Definition: ailayer_template.h:51
void * optimem[2]
Memory field used by the trainings optimizer.
Definition: ailayer_template.h:52
void(* tensor_add)(const aitensor_t *a, const aitensor_t *b, aitensor_t *result)
Function pointer to the used tensor addition.
Definition: ailayer_template.h:56
void(* copy_tensor)(const aitensor_t *from, aitensor_t *to)
Function pointer to the used tensor copy function.
Definition: ailayer_template.h:55
ailayer_t base
Inherited field members from general ailayer struct.
Definition: ailayer_template.h:36
uint16_t result_shape[2]
Inference result tensor shape (n x m matrix).
Definition: ailayer_template.h:48
const aimath_dtype_t * dtype
Datatype of the inference result values.
Definition: ailayer_template.h:37
aitensor_t * trainable_params[2]
Pointer to the weights and biases (which are the trainable parameters).
Definition: ailayer_template.h:50
AIfES layer interface.
Definition: aifes_core.h:249
Indicator for the used datatype.
Definition: aifes_math.h:44
A tensor in AIfES.
Definition: aifes_math.h:89