create_dl_layer_gatherT_create_dl_layer_gatherCreateDlLayerGatherCreateDlLayerGathercreate_dl_layer_gather (Operator)

Name

create_dl_layer_gatherT_create_dl_layer_gatherCreateDlLayerGatherCreateDlLayerGathercreate_dl_layer_gather — Create a gather layer.

Signature

Description

The operator create_dl_layer_gathercreate_dl_layer_gatherCreateDlLayerGatherCreateDlLayerGathercreate_dl_layer_gather creates a gather layer that extracts slices from the input tensor DLLayerInputDLLayerInputDLLayerInputDLLayerInputdllayer_input along a specified axis, according to the indices provided. The handle of the gather layer is returned in DLLayerGatherDLLayerGatherDLLayerGatherDLLayerGatherdllayer_gather.

The parameter DLLayerInputDLLayerInputDLLayerInputDLLayerInputdllayer_input determines the feeding input layer and expects the layer handle as its value.

The parameter IndicesIndicesIndicesindicesindices defines the indices to be gathered from the axis. The indices must be either of rank 0 or rank 1, i.e., a scalar or a list. The indices input can be a layer handle (IndicesIndicesIndicesindicesindices) or a tuple of integers. If IndicesIndicesIndicesindicesindices is given as a tuple of integers, internally a constant input layer is created.

The axis along which the gathering is performed is specified by the parameter AxisAxisAxisaxisaxis. AxisAxisAxisaxisaxis can either be specified by a string ('width'"width""width""width""width", 'height'"height""height""height""height", 'depth'"depth""depth""depth""depth" or 'batch'"batch""batch""batch""batch") or an integer, where 0 corresponds to the batch size, 1 to depth, 2 to height and 3 to width. Negative values for AxisAxisAxisaxisaxis indicate counting dimensions from the back. The accepted range is [-4,3].

The parameter LayerNameLayerNameLayerNamelayerNamelayer_name sets an individual layer name. Note that if creating a model using create_dl_modelcreate_dl_modelCreateDlModelCreateDlModelcreate_dl_model, each layer of the created network must have a unique name.

Gather semantics

Given a 4-dimensional input tensor DLLayerInputDLLayerInputDLLayerInputDLLayerInputdllayer_input of shape (N, C, H, W) and an indices tensor or tuple, the gather layer selects elements from the AxisAxisAxisaxisaxis dimension indexed by elements of IndicesIndicesIndicesindicesindices.

If the indices are given as a tuple and AxisAxisAxisaxisaxis , the output tensor is constructed by replacing dimension with the indices dimensions, resulting in an output of shape

All index values in IndicesIndicesIndicesindicesindices must be within the bounds , where is the size of the AxisAxisAxisaxisaxis dimension. Negative indices are interpreted by adding , i.e., 'index'"index""index""index""index" = 'index'"index""index""index""index" if 'index'"index""index""index""index" < 0.

Index Processing

Adjusting Axis

Negative values for AxisAxisAxisaxisaxis are made non-negative by adding the number of dimensions r of the input tensor:

Clamping Indices

Negative values in IndicesIndicesIndicesindicesindices are adjusted by adding the size s of the corresponding axis:

All values in IndicesIndicesIndicesindicesindices must satisfy Otherwise, an error will be raised.

The following generic parameters GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and the corresponding values GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value are supported:

'is_inference_output'"is_inference_output""is_inference_output""is_inference_output""is_inference_output":

Determines whether apply_dl_modelapply_dl_modelApplyDlModelApplyDlModelapply_dl_model will include the output of this layer in the dictionary DLResultBatchDLResultBatchDLResultBatchDLResultBatchdlresult_batch even without specifying this layer in OutputsOutputsOutputsoutputsoutputs ('true'"true""true""true""true") or not ('false'"false""false""false""false").

List of values: 'true'"true""true""true""true", 'false'"false""false""false""false"

Default: 'false'"false""false""false""false"

Certain parameters of layers created using this operator create_dl_layer_gathercreate_dl_layer_gatherCreateDlLayerGatherCreateDlLayerGathercreate_dl_layer_gather can be set and retrieved using further operators. The following tables give an overview, which parameters can be set using set_dl_model_layer_paramset_dl_model_layer_paramSetDlModelLayerParamSetDlModelLayerParamset_dl_model_layer_param and which ones can be retrieved using get_dl_model_layer_paramget_dl_model_layer_paramGetDlModelLayerParamGetDlModelLayerParamget_dl_model_layer_param or get_dl_layer_paramget_dl_layer_paramGetDlLayerParamGetDlLayerParamget_dl_layer_param. Note, the operators set_dl_model_layer_paramset_dl_model_layer_paramSetDlModelLayerParamSetDlModelLayerParamset_dl_model_layer_param and get_dl_model_layer_paramget_dl_model_layer_paramGetDlModelLayerParamGetDlModelLayerParamget_dl_model_layer_param require a model created by create_dl_modelcreate_dl_modelCreateDlModelCreateDlModelcreate_dl_model.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Module

Deep Learning Professional