create_dl_layer_depth_maxT_create_dl_layer_depth_maxCreateDlLayerDepthMaxCreateDlLayerDepthMaxcreate_dl_layer_depth_max (Operator)

Name

create_dl_layer_depth_maxT_create_dl_layer_depth_maxCreateDlLayerDepthMaxCreateDlLayerDepthMaxcreate_dl_layer_depth_max — Create a depth max layer.

Signature

create_dl_layer_depth_max( : : DLLayerInput, LayerName, DepthMaxMode, GenParamName, GenParamValue : DLLayerDepthMaxArg, DLLayerDepthMaxValue)

Herror T_create_dl_layer_depth_max(const Htuple DLLayerInput, const Htuple LayerName, const Htuple DepthMaxMode, const Htuple GenParamName, const Htuple GenParamValue, Htuple* DLLayerDepthMaxArg, Htuple* DLLayerDepthMaxValue)

void CreateDlLayerDepthMax(const HTuple& DLLayerInput, const HTuple& LayerName, const HTuple& DepthMaxMode, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* DLLayerDepthMaxArg, HTuple* DLLayerDepthMaxValue)

HDlLayerArray HDlLayer::CreateDlLayerDepthMax(const HString& LayerName, const HString& DepthMaxMode, const HTuple& GenParamName, const HTuple& GenParamValue, HDlLayerArray* DLLayerDepthMaxValue) const

HDlLayer HDlLayer::CreateDlLayerDepthMax(const HString& LayerName, const HString& DepthMaxMode, const HString& GenParamName, const HString& GenParamValue, HDlLayer* DLLayerDepthMaxValue) const

HDlLayer HDlLayer::CreateDlLayerDepthMax(const char* LayerName, const char* DepthMaxMode, const char* GenParamName, const char* GenParamValue, HDlLayer* DLLayerDepthMaxValue) const

HDlLayer HDlLayer::CreateDlLayerDepthMax(const wchar_t* LayerName, const wchar_t* DepthMaxMode, const wchar_t* GenParamName, const wchar_t* GenParamValue, HDlLayer* DLLayerDepthMaxValue) const   (Windows only)

static void HOperatorSet.CreateDlLayerDepthMax(HTuple DLLayerInput, HTuple layerName, HTuple depthMaxMode, HTuple genParamName, HTuple genParamValue, out HTuple DLLayerDepthMaxArg, out HTuple DLLayerDepthMaxValue)

HDlLayer[] HDlLayer.CreateDlLayerDepthMax(string layerName, string depthMaxMode, HTuple genParamName, HTuple genParamValue, out HDlLayer[] DLLayerDepthMaxValue)

HDlLayer HDlLayer.CreateDlLayerDepthMax(string layerName, string depthMaxMode, string genParamName, string genParamValue, out HDlLayer DLLayerDepthMaxValue)

def create_dl_layer_depth_max(dllayer_input: HHandle, layer_name: str, depth_max_mode: str, gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[int, float, str]]) -> Tuple[Sequence[HHandle], Sequence[HHandle]]

def create_dl_layer_depth_max_s(dllayer_input: HHandle, layer_name: str, depth_max_mode: str, gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[int, float, str]]) -> Tuple[HHandle, HHandle]

Description

The operator create_dl_layer_depth_maxcreate_dl_layer_depth_maxCreateDlLayerDepthMaxCreateDlLayerDepthMaxCreateDlLayerDepthMaxcreate_dl_layer_depth_max creates a depth max layer.

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

There are two possible output layers depending on DepthMaxModeDepthMaxModeDepthMaxModeDepthMaxModedepthMaxModedepth_max_mode:

Note, these parameters only need to be set in case such an output layer is requested (see DepthMaxModeDepthMaxModeDepthMaxModeDepthMaxModedepthMaxModedepth_max_mode).

The parameter LayerNameLayerNameLayerNameLayerNamelayerNamelayer_name defines the name of the output layer(s) depending on DepthMaxModeDepthMaxModeDepthMaxModeDepthMaxModedepthMaxModedepth_max_mode:

Note that if creating a model using create_dl_modelcreate_dl_modelCreateDlModelCreateDlModelCreateDlModelcreate_dl_model each layer of the created network must have a unique name.

The mode DepthMaxModeDepthMaxModeDepthMaxModeDepthMaxModedepthMaxModedepth_max_mode indicates which depth max value is actually returned as output. The following values are supported:

'argmax'"argmax""argmax""argmax""argmax""argmax":

The depth index of the maximal value is returned in DLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgdllayer_depth_max_arg.

'value'"value""value""value""value""value":

The maximal value itself is returned in DLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValuedllayer_depth_max_value.

'argmax_and_value'"argmax_and_value""argmax_and_value""argmax_and_value""argmax_and_value""argmax_and_value":

Both are returned, the depth index of the maximal value in the output layer DLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgdllayer_depth_max_arg, and the maximal value itself in the output layer DLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValuedllayer_depth_max_value.

The following generic parameters GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and the corresponding values GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value are supported:

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

Determines whether apply_dl_modelapply_dl_modelApplyDlModelApplyDlModelApplyDlModelapply_dl_model will include the output of this layer in the dictionary DLResultBatchDLResultBatchDLResultBatchDLResultBatchDLResultBatchdlresult_batch even without specifying this layer in OutputsOutputsOutputsOutputsoutputsoutputs ('true'"true""true""true""true""true") or not ('false'"false""false""false""false""false").

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

'num_trainable_params'"num_trainable_params""num_trainable_params""num_trainable_params""num_trainable_params""num_trainable_params":

Number of trainable parameters (weights and biases) of the layer.

Certain parameters of layers created using this operator create_dl_layer_depth_maxcreate_dl_layer_depth_maxCreateDlLayerDepthMaxCreateDlLayerDepthMaxCreateDlLayerDepthMaxcreate_dl_layer_depth_max 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_paramSetDlModelLayerParamSetDlModelLayerParamSetDlModelLayerParamset_dl_model_layer_param and which ones can be retrieved using get_dl_model_layer_paramget_dl_model_layer_paramGetDlModelLayerParamGetDlModelLayerParamGetDlModelLayerParamget_dl_model_layer_param or get_dl_layer_paramget_dl_layer_paramGetDlLayerParamGetDlLayerParamGetDlLayerParamget_dl_layer_param. Note, the operators set_dl_model_layer_paramset_dl_model_layer_paramSetDlModelLayerParamSetDlModelLayerParamSetDlModelLayerParamset_dl_model_layer_param and get_dl_model_layer_paramget_dl_model_layer_paramGetDlModelLayerParamGetDlModelLayerParamGetDlModelLayerParamget_dl_model_layer_param require a model created by create_dl_modelcreate_dl_modelCreateDlModelCreateDlModelCreateDlModelcreate_dl_model.

Layer Parameters set get
'input_layer'"input_layer""input_layer""input_layer""input_layer""input_layer" (DLLayerInputDLLayerInputDLLayerInputDLLayerInputDLLayerInputdllayer_input)
'mode'"mode""mode""mode""mode""mode" (DepthMaxModeDepthMaxModeDepthMaxModeDepthMaxModedepthMaxModedepth_max_mode)
'name'"name""name""name""name""name" (LayerNameLayerNameLayerNameLayerNamelayerNamelayer_name)
'output_layer'"output_layer""output_layer""output_layer""output_layer""output_layer" (DLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgdllayer_depth_max_arg and/or DLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValuedllayer_depth_max_value)
'shape'"shape""shape""shape""shape""shape"
'type'"type""type""type""type""type"
Generic Layer Parameters set get
'is_inference_output'"is_inference_output""is_inference_output""is_inference_output""is_inference_output""is_inference_output"
'num_trainable_params'"num_trainable_params""num_trainable_params""num_trainable_params""num_trainable_params""num_trainable_params"

Execution Information

Parameters

DLLayerInputDLLayerInputDLLayerInputDLLayerInputDLLayerInputdllayer_input (input_control)  dl_layer HDlLayer, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Feeding layer.

LayerNameLayerNameLayerNameLayerNamelayerNamelayer_name (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the output layer.

DepthMaxModeDepthMaxModeDepthMaxModeDepthMaxModedepthMaxModedepth_max_mode (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Mode to indicate type of return value.

Default value: 'argmax' "argmax" "argmax" "argmax" "argmax" "argmax"

List of values: 'argmax'"argmax""argmax""argmax""argmax""argmax", 'argmax_and_value'"argmax_and_value""argmax_and_value""argmax_and_value""argmax_and_value""argmax_and_value", 'value'"value""value""value""value""value"

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name(-array) HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Generic input parameter names.

Default value: []

List of values: 'is_inference_output'"is_inference_output""is_inference_output""is_inference_output""is_inference_output""is_inference_output", 'num_trainable_params'"num_trainable_params""num_trainable_params""num_trainable_params""num_trainable_params""num_trainable_params"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  attribute.value(-array) HTupleMaybeSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Generic input parameter values.

Default value: []

Suggested values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false"

DLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgDLLayerDepthMaxArgdllayer_depth_max_arg (output_control)  dl_layer(-array) HDlLayer, HTupleSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Optional, depth max layer with mode 'argmax'"argmax""argmax""argmax""argmax""argmax".

DLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValueDLLayerDepthMaxValuedllayer_depth_max_value (output_control)  dl_layer(-array) HDlLayer, HTupleSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Optional, depth max layer with mode 'value'"value""value""value""value""value".

Module

Deep Learning Training