Welcome to our Support Center
Updated

GlobalMaxPool3D

Description

Setup and add the global max pooling 3D layer into the model during the definition graph step. Type : polymorphic.

 

Input parameters

 

 Graph in : model architecture.

parameters : layer parameters.

 data_format : enum, one of channels_last or channels_first (default) . The ordering of the dimensions in the inputs. channel_last corresponds to inputs with shape (batch, steps, features) while channels_first corresponds to inputs with shape (batch, features, steps).
Default value “channels_first”.
 keepdims : boolean, A boolean, whether to keep the spatial dimensions or not. If keepdims is ‘False’ (default), the rank of the tensor is reduced for spatial dimensions. If keepdims is ‘True’, the spatial dimensions are retained with length 1.
Default value “False”.
 training? : boolean, whether the layer is in training mode (can store data for backward).
Default value “True”.
 lda_coeff : float, defines the coefficient by which the loss derivative will be multiplied before being sent to the previous layer (since during the backward run we go backwards).
Default value “1”.

 in/out param :

 input_shape : integer array, shape (not including the batch axis). NB : To be used only if it is the first layer of the model.
 output_behavior : enum, setup if the layer is an output layer.
Default “Not Output”​.

name (optional) : string, name of the layer.

 

Output parameters

 

 Graph out : model architecture.

Dimension

Input shape

5D tensor with shape :

  • If data_format = ‘channels_last’ : (batch_size, spatial_dim1, spatial_dim2, spatial_dim3, channels).
  • If data_format = ‘channels_first’ : (batch_size, channels, spatial_dim1, spatial_dim2, spatial_dim3).

Output shape

  • If keepdims = ‘False’ : 2D tensor with shape (batch_size, channels).
  • If keepdims = ‘True’ :
    • If data_format = ‘channels_last’ : 5D tensor with shape (batch_size, 1, 1, 1, channels).
    • If data_format = ‘channels_first’ : 5D tensor with shape (batch_size, channels, 1, 1, 1).

Example

All these exemples are snippets PNG, you can drop these Snippet onto the block diagram and get the depicted code added to your VI (Do not forget to install HAIBAL library to run it).

GlobalMaxPool3D layer

1 – Generate a set of data

We generate an array of data of type single and shape [batch_size = 10, channels = 7, spatial_dim1 = 5, spatial_dim2 = 5, spatial_dim3 = 3].

2 – Define graph

First we define the first layer of the graph which is an Input Layer (explicit input layer method). This Input Layer is setup as an input array shaped [channels = 7, spatial_dim1 = 5, spatial_dim2 = 5, spatial_dim3 = 3].
Then we “add to graph” GlobalMaxPool3D layer.

3 – Run graph

We call the forward method and retrieve the result with the “Prediction 2D” method.
This method returns two variables, the first one is the layer information (cluster composed of the layer name, the graph index and the shape of the output layer) and the second one is the prediction with a shape of [batch_size, channels].
The output dimension depends on the parameters “keepdims” refer to the chapter “Dimension” of this documentation.

 

GlobalMaxPool3D layer, batch and dimension

1 – Generate a set of data

We generate an array of data of type single and shape [number of batch = 9, batch_size = 10, channels = 7, spatial_dim1 = 5, spatial_dim2 = 5, spatial_dim3 = 3].

2 – Define graph

First, we define the first layer of the graph which is an Input layer (explicit input layer method). This layer is setup as an input array shaped [channels = 7, spatial_dim1 = 5, spatial_dim2 = 5, spatial_dim3 = 3].
Then we add to the graph the GlobalMaxPool3D layer.

3 – Run graph

We call the forward method and retrieve the result with the “Prediction 2D” method.
This method returns two variables, the first one is the layer information (cluster composed of the layer name, the graph index and the shape of the output layer) and the second one is the prediction with a shape of [batch_size, channels].
The output dimension depends on the parameters “keepdims” refer to the chapter “Dimension” of this documentation.

 

Tags:
Table of Contents