get_dl_model_paramT_get_dl_model_paramGetDlModelParamGetDlModelParamget_dl_model_param (Operator)

Name

get_dl_model_paramT_get_dl_model_paramGetDlModelParamGetDlModelParamget_dl_model_param — Return the parameters of a deep learning model.

Signature

get_dl_model_param( : : DLModelHandle, GenParamName : GenParamValue)

Herror T_get_dl_model_param(const Htuple DLModelHandle, const Htuple GenParamName, Htuple* GenParamValue)

void GetDlModelParam(const HTuple& DLModelHandle, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HDlModel::GetDlModelParam(const HString& GenParamName) const

HTuple HDlModel::GetDlModelParam(const char* GenParamName) const

HTuple HDlModel::GetDlModelParam(const wchar_t* GenParamName) const   (Windows only)

static void HOperatorSet.GetDlModelParam(HTuple DLModelHandle, HTuple genParamName, out HTuple genParamValue)

HTuple HDlModel.GetDlModelParam(string genParamName)

def get_dl_model_param(dlmodel_handle: HHandle, gen_param_name: str) -> Sequence[Union[str, float, int]]

def get_dl_model_param_s(dlmodel_handle: HHandle, gen_param_name: str) -> Union[str, float, int]

Description

get_dl_model_paramget_dl_model_paramGetDlModelParamGetDlModelParamGetDlModelParamget_dl_model_param returns the parameter values GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value of GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name for the deep learning model DLModelHandleDLModelHandleDLModelHandleDLModelHandleDLModelHandledlmodel_handle.

For a deep learning model, parameters GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name can be set using set_dl_model_paramset_dl_model_paramSetDlModelParamSetDlModelParamSetDlModelParamset_dl_model_param or create_dl_model_detectioncreate_dl_model_detectionCreateDlModelDetectionCreateDlModelDetectionCreateDlModelDetectioncreate_dl_model_detection, depending on the parameter and the model type. With this operator, get_dl_model_paramget_dl_model_paramGetDlModelParamGetDlModelParamGetDlModelParamget_dl_model_param, you can retrieve the parameter values GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. Below we give an overview of the different parameters and an explanation, except of those you can only set. For latter ones, please see the documentation of corresponding operator.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name Ano. Det. Class. Obj. Det. Sem. Seg.
'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size"
'batch_size_multiplier'"batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier"
'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids"
'class_weights'"class_weights""class_weights""class_weights""class_weights""class_weights"
'device'"device""device""device""device""device"
'enable_resizing'"enable_resizing""enable_resizing""enable_resizing""enable_resizing""enable_resizing"
'fuse_bn_relu'"fuse_bn_relu""fuse_bn_relu""fuse_bn_relu""fuse_bn_relu""fuse_bn_relu"
'fuse_conv_relu'"fuse_conv_relu""fuse_conv_relu""fuse_conv_relu""fuse_conv_relu""fuse_conv_relu"
'gpu'"gpu""gpu""gpu""gpu""gpu"
'image_dimensions'"image_dimensions""image_dimensions""image_dimensions""image_dimensions""image_dimensions"
'image_height'"image_height""image_height""image_height""image_height""image_height"
'image_width'"image_width""image_width""image_width""image_width""image_width"
'image_num_channels'"image_num_channels""image_num_channels""image_num_channels""image_num_channels""image_num_channels"
'image_range_max'"image_range_max""image_range_max""image_range_max""image_range_max""image_range_max"
'image_range_min'"image_range_min""image_range_min""image_range_min""image_range_min""image_range_min"
'input_dimensions'"input_dimensions""input_dimensions""input_dimensions""input_dimensions""input_dimensions"
'learning_rate'"learning_rate""learning_rate""learning_rate""learning_rate""learning_rate"
'meta_data'"meta_data""meta_data""meta_data""meta_data""meta_data"
'momentum'"momentum""momentum""momentum""momentum""momentum"
'num_classes'"num_classes""num_classes""num_classes""num_classes""num_classes" (NumClassesNumClassesNumClassesNumClassesnumClassesnum_classes)
'num_trainable_params'"num_trainable_params""num_trainable_params""num_trainable_params""num_trainable_params""num_trainable_params"
'optimize_for_inference'"optimize_for_inference""optimize_for_inference""optimize_for_inference""optimize_for_inference""optimize_for_inference"
'precision'"precision""precision""precision""precision""precision"
'precision_is_converted'"precision_is_converted""precision_is_converted""precision_is_converted""precision_is_converted""precision_is_converted"
'runtime'"runtime""runtime""runtime""runtime""runtime"
'runtime_init'"runtime_init""runtime_init""runtime_init""runtime_init""runtime_init"
'summary'"summary""summary""summary""summary""summary"
'type'"type""type""type""type""type"
'weight_prior'"weight_prior""weight_prior""weight_prior""weight_prior""weight_prior"
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name Ano. Det. Class. Obj. Det. Sem. Seg.
'complexity'"complexity""complexity""complexity""complexity""complexity"
'standard_deviation_factor'"standard_deviation_factor""standard_deviation_factor""standard_deviation_factor""standard_deviation_factor""standard_deviation_factor"
'class_names'"class_names""class_names""class_names""class_names""class_names"
'extract_feature_maps'"extract_feature_maps""extract_feature_maps""extract_feature_maps""extract_feature_maps""extract_feature_maps"
'anchor_angles'"anchor_angles""anchor_angles""anchor_angles""anchor_angles""anchor_angles"
'anchor_aspect_ratios'"anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios"
'anchor_num_subscales'"anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales"
'backbone'"backbone""backbone""backbone""backbone""backbone" (BackboneBackboneBackboneBackbonebackbonebackbone)
'backbone_docking_layers'"backbone_docking_layers""backbone_docking_layers""backbone_docking_layers""backbone_docking_layers""backbone_docking_layers"
'bbox_heads_weight'"bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight"
'capacity'"capacity""capacity""capacity""capacity""capacity"
'class_heads_weight'"class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight"
'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation"
'freeze_backbone_level'"freeze_backbone_level""freeze_backbone_level""freeze_backbone_level""freeze_backbone_level""freeze_backbone_level"
'ignore_direction'"ignore_direction""ignore_direction""ignore_direction""ignore_direction""ignore_direction"
'instance_type'"instance_type""instance_type""instance_type""instance_type""instance_type"
'max_level'"max_level""max_level""max_level""max_level""max_level"
'min_level'"min_level""min_level""min_level""min_level""min_level"
'max_num_detections'"max_num_detections""max_num_detections""max_num_detections""max_num_detections""max_num_detections"
'max_overlap'"max_overlap""max_overlap""max_overlap""max_overlap""max_overlap"
'max_overlap_class_agnostic'"max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic"
'min_confidence'"min_confidence""min_confidence""min_confidence""min_confidence""min_confidence"
'ignore_class_ids'"ignore_class_ids""ignore_class_ids""ignore_class_ids""ignore_class_ids""ignore_class_ids"

Thereby, the symbols denote the following :

Certain parameters are set as non-optional parameters, the corresponding notation is given in brackets.

In the following we list and explain the parameters GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name for which you can retrieve their value using this operator, get_dl_model_paramget_dl_model_paramGetDlModelParamGetDlModelParamGetDlModelParamget_dl_model_param. They are sorted according to the model type. Note, for models of 'type'"type""type""type""type""type"='segmentation'"segmentation""segmentation""segmentation""segmentation""segmentation" the default values depend on the specific network and therefore have to be retrieved.

Applicable to several model types

'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size"

Number of input images (and corresponding labels) in a batch that is transferred to device memory.

For a training using train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch, the batch of images which are processed simultaneously in a single training iteration contains a number of images which is equal to 'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size" times 'batch_size_multiplier'"batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier". Please refer to train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch for further details.

For inference, the 'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size" can be generally set independently from the number of input images. See apply_dl_modelapply_dl_modelApplyDlModelApplyDlModelApplyDlModelapply_dl_model for details on how to set this parameter for greater efficiency.

Models of 'type'"type""type""type""type""type"='classification'"classification""classification""classification""classification""classification":

The parameter 'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size" is stored in the pretrained classifier. Per default, the 'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size" is set such that a training of the pretrained classifier with up to 100 classes can be easily performed on a device with 8 gigabyte of memory.

For the pretrained classifiers, the default values are hence given as follows:
pretrained classifier default value of 'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size"
'pretrained_dl_classifier_alexnet.hdl'"pretrained_dl_classifier_alexnet.hdl""pretrained_dl_classifier_alexnet.hdl""pretrained_dl_classifier_alexnet.hdl""pretrained_dl_classifier_alexnet.hdl""pretrained_dl_classifier_alexnet.hdl" 230
'pretrained_dl_classifier_compact.hdl'"pretrained_dl_classifier_compact.hdl""pretrained_dl_classifier_compact.hdl""pretrained_dl_classifier_compact.hdl""pretrained_dl_classifier_compact.hdl""pretrained_dl_classifier_compact.hdl" 160
'pretrained_dl_classifier_enhanced.hdl'"pretrained_dl_classifier_enhanced.hdl""pretrained_dl_classifier_enhanced.hdl""pretrained_dl_classifier_enhanced.hdl""pretrained_dl_classifier_enhanced.hdl""pretrained_dl_classifier_enhanced.hdl" 96
'pretrained_dl_classifier_mobilenet_v2.hdl'"pretrained_dl_classifier_mobilenet_v2.hdl""pretrained_dl_classifier_mobilenet_v2.hdl""pretrained_dl_classifier_mobilenet_v2.hdl""pretrained_dl_classifier_mobilenet_v2.hdl""pretrained_dl_classifier_mobilenet_v2.hdl" 40
'pretrained_dl_classifier_resnet50.hdl'"pretrained_dl_classifier_resnet50.hdl""pretrained_dl_classifier_resnet50.hdl""pretrained_dl_classifier_resnet50.hdl""pretrained_dl_classifier_resnet50.hdl""pretrained_dl_classifier_resnet50.hdl" 23
'batch_size_multiplier'"batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier"

Multiplier for 'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size" to enable training with larger numbers of images in one step which would otherwise not be possible due to GPU memory limitations. This model parameter does only affect train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch and thus has no impact during evaluation and inference. For detailed information see train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch.

Models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection":

The parameter 'batch_size_multiplier'"batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier" has no effect.

Default: 'batch_size_multiplier'"batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier" = 1

'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids":

Unique IDs of the classes the model shall distinguish. The tuple is of length 'num_classes'"num_classes""num_classes""num_classes""num_classes""num_classes".

We stress out the slightly different meanings and restrictions depending on the model type:

Models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection":

'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids" is not supported.

Models of 'type'"type""type""type""type""type"='classification'"classification""classification""classification""classification""classification":

The IDs are unique identifiers, which are automatically assigned to each class. The ID of a class corresponds to the index within the tuple 'class_names'"class_names""class_names""class_names""class_names""class_names".

Models of 'type'"type""type""type""type""type"='detection'"detection""detection""detection""detection""detection":

Only the classes of the objects to be detected are included and therewith no background class. Thereby, you can set any integer within the interval as class ID value.

Note that the values of 'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation" depend on 'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids". Thus if 'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids" is changed after the creation of the model, 'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation" is reset to an empty tuple.

Default: 'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids" = '[0,...,num_classes-1]'"[0,...,num_classes-1]""[0,...,num_classes-1]""[0,...,num_classes-1]""[0,...,num_classes-1]""[0,...,num_classes-1]"

Models of 'type'"type""type""type""type""type"='segmentation'"segmentation""segmentation""segmentation""segmentation""segmentation":

Every class used for training has to be included and therewith also the class ID of the 'background' class. Therefore, for such a model the tuple has a minimal length of 2. Thereby, you can set any integer within the interval as class ID value.

'class_weights'"class_weights""class_weights""class_weights""class_weights""class_weights":

The parameter 'class_weights'"class_weights""class_weights""class_weights""class_weights""class_weights" is a tuple of class specific weighting factors for the loss. Giving the unique classes a different weight, it is possible to force the network to learn the classes with different importance. This is useful in cases where a class dominates the dataset. The weighting factors have to be within the interval . Thereby a class gets a stronger impact during the training the larger its weight is. The weights in the tuple 'class_weights'"class_weights""class_weights""class_weights""class_weights""class_weights" are sorted the same way as the classes in the tuple 'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids". We stress out the slightly different meanings and restrictions depending on the model type:

Models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection":

'class_weights'"class_weights""class_weights""class_weights""class_weights""class_weights" is not supported.

Models of 'type'"type""type""type""type""type"='classification'"classification""classification""classification""classification""classification":

Default: 'class_weights'"class_weights""class_weights""class_weights""class_weights""class_weights" = 1.0 for each class.

Models of 'type'"type""type""type""type""type"='detection'"detection""detection""detection""detection""detection":

Default: 'class_weights'"class_weights""class_weights""class_weights""class_weights""class_weights" = 0.25 for each class.

Models of 'type'"type""type""type""type""type"='segmentation'"segmentation""segmentation""segmentation""segmentation""segmentation":

'class_weights'"class_weights""class_weights""class_weights""class_weights""class_weights" is not supported.

'device'"device""device""device""device""device":

Handle of the device on which the deep learning operators will be executed. To get a tuple of handles of all available potentially deep-learning capable hardware devices use query_available_dl_devicesquery_available_dl_devicesQueryAvailableDlDevicesQueryAvailableDlDevicesQueryAvailableDlDevicesquery_available_dl_devices.

Default: Handle of the default device, thus the GPU with index 0. If not available, this is an empty tuple.

'gpu'"gpu""gpu""gpu""gpu""gpu":

Identifier of the GPU where the training and inference operators (train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch and apply_dl_modelapply_dl_modelApplyDlModelApplyDlModelApplyDlModelapply_dl_model) are executed. Per default, the first available GPU is used. get_systemget_systemGetSystemGetSystemGetSystemget_system with 'cuda_devices'"cuda_devices""cuda_devices""cuda_devices""cuda_devices""cuda_devices" can be used to retrieve a list of available GPUs. Pass the index in this list to 'gpu'"gpu""gpu""gpu""gpu""gpu".

Note that the parameter 'gpu'"gpu""gpu""gpu""gpu""gpu" is only taken into account for 'runtime'"runtime""runtime""runtime""runtime""runtime" = 'gpu'"gpu""gpu""gpu""gpu""gpu". Therefore, it is preferable to set the GPU device, on which operators are run, using the parameter 'device'"device""device""device""device""device". executed.

Default: 'gpu'"gpu""gpu""gpu""gpu""gpu" = 0

'image_dimensions'"image_dimensions""image_dimensions""image_dimensions""image_dimensions""image_dimensions":

Tuple containing the input image dimensions 'image_width'"image_width""image_width""image_width""image_width""image_width", 'image_height'"image_height""image_height""image_height""image_height""image_height", and number of channels 'image_num_channels'"image_num_channels""image_num_channels""image_num_channels""image_num_channels""image_num_channels".

The respective default values and possible value ranges depend on the model and model type. Please see the individual dimension parameter description for more details.

'image_height'"image_height""image_height""image_height""image_height""image_height", 'image_width'"image_width""image_width""image_width""image_width""image_width":

Height and width of the input images, respectively, that the network will process.

This parameter can attain different values depending on the model type:

Models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection":

The default values depend on the specific pretrained network, see read_dl_modelread_dl_modelReadDlModelReadDlModelReadDlModelread_dl_model. The network architectures allow changes of the image dimensions, which can be done using set_dl_model_paramset_dl_model_paramSetDlModelParamSetDlModelParamSetDlModelParamset_dl_model_param. Please also refer to read_dl_modelread_dl_modelReadDlModelReadDlModelReadDlModelread_dl_model for restrictions each of the delivered networks has on the input image size. Note that these parameters have to be set before training the model. Setting them on an already trained model would render this model useless. When trying to do so, an error is returned but the model itself is unchanged.

Models of 'type'"type""type""type""type""type"='classification'"classification""classification""classification""classification""classification":

The default values depend on the specific pretrained classifier, see read_dl_modelread_dl_modelReadDlModelReadDlModelReadDlModelread_dl_model. The network architectures allow changes of the image dimensions, which can be done using set_dl_model_paramset_dl_model_paramSetDlModelParamSetDlModelParamSetDlModelParamset_dl_model_param. But for networks with at least one fully connected layer such a change makes a retraining necessary. Networks without fully connected layers are directly applicable to different image sizes. However, images with a size differing from the size with which the classifier has been trained are likely to show a reduced classification accuracy.

Models of 'type'"type""type""type""type""type"='detection'"detection""detection""detection""detection""detection":

The network architectures allow changes of the image dimensions. But the image lengths are halved for every level, that is why the dimensions 'image_width'"image_width""image_width""image_width""image_width""image_width" and 'image_height'"image_height""image_height""image_height""image_height""image_height" need to be an integer multiple of . depends on the 'backbone'"backbone""backbone""backbone""backbone""backbone" and the parameter 'max_level'"max_level""max_level""max_level""max_level""max_level", see create_dl_model_detectioncreate_dl_model_detectionCreateDlModelDetectionCreateDlModelDetectionCreateDlModelDetectioncreate_dl_model_detection for further information.

Default: 'image_height'"image_height""image_height""image_height""image_height""image_height" = 640, 'image_width'"image_width""image_width""image_width""image_width""image_width" = 640

Models of 'type'"type""type""type""type""type"='segmentation'"segmentation""segmentation""segmentation""segmentation""segmentation":

The network architectures allow changes of the image dimensions.

The default and minimal values are given by the network, see read_dl_modelread_dl_modelReadDlModelReadDlModelReadDlModelread_dl_model.

'image_num_channels'"image_num_channels""image_num_channels""image_num_channels""image_num_channels""image_num_channels":

Number of channels of the input images the network will process. The default value is given by the network, see read_dl_modelread_dl_modelReadDlModelReadDlModelReadDlModelread_dl_model and create_dl_model_detectioncreate_dl_model_detectionCreateDlModelDetectionCreateDlModelDetectionCreateDlModelDetectioncreate_dl_model_detection.

For models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection", only the values 1 and 3 are supported. In addition, this parameter can only be set on a model of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection" before the model is trained. Setting 'image_num_channels'"image_num_channels""image_num_channels""image_num_channels""image_num_channels""image_num_channels" on an already trained model would render this model useless. When trying to do so, an error is returned but the model itself is unchanged.

For other models, any number of input image channels is possible.

If number of channels is changed to a value >1, the weights of the first layers after the input image layer will be initialized with random values. Note, in this case more data for the retraining is needed. If the number of channels is changed to 1, the weights of the concerned layers are fused.

Modelf of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection":

Default: 'image_num_channels'"image_num_channels""image_num_channels""image_num_channels""image_num_channels""image_num_channels" = 3

Models of 'type'"type""type""type""type""type"='detection'"detection""detection""detection""detection""detection":

Default: 'image_num_channels'"image_num_channels""image_num_channels""image_num_channels""image_num_channels""image_num_channels" = 3

'image_range_max'"image_range_max""image_range_max""image_range_max""image_range_max""image_range_max", 'image_range_min'"image_range_min""image_range_min""image_range_min""image_range_min""image_range_min":

Maximum and minimum gray value of the input images, respectively, the network will process.

The default values are given by the network, see read_dl_modelread_dl_modelReadDlModelReadDlModelReadDlModelread_dl_model and create_dl_model_detectioncreate_dl_model_detectionCreateDlModelDetectionCreateDlModelDetectionCreateDlModelDetectioncreate_dl_model_detection.

'input_dimensions'"input_dimensions""input_dimensions""input_dimensions""input_dimensions""input_dimensions":

This parameter returns a dictionary containing all input dimensions of the network. Examples for such inputs: input image, weight_image (for models of 'type'"type""type""type""type""type"='segmentation'"segmentation""segmentation""segmentation""segmentation""segmentation").

These dimensions are given in the dictionary as a tuple [width, height, depth]. In case this parameter is used to set the dimension, for every dimension a value of -1 may be set to keep the current value.

'learning_rate'"learning_rate""learning_rate""learning_rate""learning_rate""learning_rate":

Value of the factor determining the gradient influence during training using train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch. Please refer to train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch for further details.

The default values depend on the model.

Models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection":

The parameter 'learning_rate'"learning_rate""learning_rate""learning_rate""learning_rate""learning_rate" has no effect.

'meta_data'"meta_data""meta_data""meta_data""meta_data""meta_data":

Dictionary with user defined meta data, whose entries can be set freely. The meta data may be used to store information such as the model author or a model version along with the model.

Restriction: Dictionary values are limited to strings or tuple of strings.

'momentum'"momentum""momentum""momentum""momentum""momentum":

When updating the weights of the network, the hyperparameter 'momentum'"momentum""momentum""momentum""momentum""momentum" specifies to which extent previous updating vectors will be added to the current updating vector. Please refer to train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch for further details.

The default value is given by the model.

Models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection":

The parameter 'momentum'"momentum""momentum""momentum""momentum""momentum" has no effect.

'num_classes'"num_classes""num_classes""num_classes""num_classes""num_classes":

Number of distinct classes that the model is able to distinguish for its predictions.

This parameter differs between the model types:

Models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection":

'num_classes'"num_classes""num_classes""num_classes""num_classes""num_classes" is not supported.

Models of 'type'"type""type""type""type""type"='classification'"classification""classification""classification""classification""classification":

'num_classes'"num_classes""num_classes""num_classes""num_classes""num_classes" is determined implicitly by the length of 'class_names'"class_names""class_names""class_names""class_names""class_names" and therefore not supported.

Models of 'type'"type""type""type""type""type"='detection'"detection""detection""detection""detection""detection":

This parameter is set as NumClassesNumClassesNumClassesNumClassesnumClassesnum_classes over create_dl_model_detectioncreate_dl_model_detectionCreateDlModelDetectionCreateDlModelDetectionCreateDlModelDetectioncreate_dl_model_detection and 'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids" always needs to have a number of entries equal to 'num_classes'"num_classes""num_classes""num_classes""num_classes""num_classes".

Models of 'type'"type""type""type""type""type"='segmentation'"segmentation""segmentation""segmentation""segmentation""segmentation":

A model of 'type'"type""type""type""type""type"='segmentation'"segmentation""segmentation""segmentation""segmentation""segmentation" does predict background and therefore in this case the 'background' class is included in 'num_classes'"num_classes""num_classes""num_classes""num_classes""num_classes". For these models, 'num_classes'"num_classes""num_classes""num_classes""num_classes""num_classes" is determined implicitly by the length of 'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids".

'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 model. This value is an indicator for the size of the model when it is serialized.

'optimize_for_inference'"optimize_for_inference""optimize_for_inference""optimize_for_inference""optimize_for_inference""optimize_for_inference":

Defines whether the model is optimized and only applicable for inference.

The model remains executable on HALCON standard devices even after optimization (unlike optimize_dl_model_for_inferenceoptimize_dl_model_for_inferenceOptimizeDlModelForInferenceOptimizeDlModelForInferenceOptimizeDlModelForInferenceoptimize_dl_model_for_inference).

Setting this parameter to 'true'"true""true""true""true""true" frees model memory not needed for inference (e.g., memory of gradients). This can significantly reduce the amount of memory needed by the model. As a consequence, models with this characteristic have no gradients accessible (needed e.g., for training or calculations of heatmaps with mode 'grad_cam'"grad_cam""grad_cam""grad_cam""grad_cam""grad_cam"). Operators using values from freed memory (e.g., train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch) will automatically reset this parameter value to 'false'"false""false""false""false""false".

In case the value is reset to 'false'"false""false""false""false""false" (both, manually or automatically), memory needed by the model for training is reallocated. This implies, a following training behaves as if 'momentum'"momentum""momentum""momentum""momentum""momentum" is temporarily set to 0 (as possible updating vectors have to be accumulated again).

Models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection":

'optimize_for_inference'"optimize_for_inference""optimize_for_inference""optimize_for_inference""optimize_for_inference""optimize_for_inference" is not supported.

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

'precision'"precision""precision""precision""precision""precision":

Defines the data type that is internally used for the calculation of a forward pass of a deep learning model.

Default: 'float32'"float32""float32""float32""float32""float32"

'precision_is_converted'"precision_is_converted""precision_is_converted""precision_is_converted""precision_is_converted""precision_is_converted":

Indicates whether the model was subjected to a conversion process after training done by optimize_dl_model_for_inferenceoptimize_dl_model_for_inferenceOptimizeDlModelForInferenceOptimizeDlModelForInferenceOptimizeDlModelForInferenceoptimize_dl_model_for_inference.

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

'runtime'"runtime""runtime""runtime""runtime""runtime":

Defines the device on which the deep learning operators will be executed.

Note that the parameter 'device'"device""device""device""device""device" should be preferred to set the devices on which the deep learning operators will be executed.

Default: 'runtime'"runtime""runtime""runtime""runtime""runtime" = 'gpu'"gpu""gpu""gpu""gpu""gpu"

'cpu'"cpu""cpu""cpu""cpu""cpu":

The training and inference operator will be executed on CPU. Note, training is only supported for specific platform types, please see the HALCON “Installation Guide”.

In case the GPU has been used before, CPU memory is initialized, and if necessary values stored on the GPU memory are moved to the CPU memory.

For parallelization: The runtime is highly dependent on the number of threads set. The use of all available threads does not necessarily create a faster performance. How many threads are currently set can be queried with the operator get_systemget_systemGetSystemGetSystemGetSystemget_system.

The implemented CPU parallelization is dependent on the architecture:

  • Intel or AMD architecture: OpenMP. By default all available threads of the OpenMP runtime environment are used. The number of threads used can be specified with the thread specific parameter 'tsp_thread_num'"tsp_thread_num""tsp_thread_num""tsp_thread_num""tsp_thread_num""tsp_thread_num" of the operator set_systemset_systemSetSystemSetSystemSetSystemset_system.

  • Arm architectures: Global Thread Pool. The number of threads can be set with the global parameter 'thread_num'"thread_num""thread_num""thread_num""thread_num""thread_num" of the operator set_systemset_systemSetSystemSetSystemSetSystemset_system. However, it is not possible to specify a thread-specific number of threads (via the parameter 'tsp_thread_num'"tsp_thread_num""tsp_thread_num""tsp_thread_num""tsp_thread_num""tsp_thread_num" of the operator set_systemset_systemSetSystemSetSystemSetSystemset_system).

'gpu'"gpu""gpu""gpu""gpu""gpu":

The GPU memory is initialized. The operators apply_dl_modelapply_dl_modelApplyDlModelApplyDlModelApplyDlModelapply_dl_model, train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch, and train_dl_model_anomaly_datasettrain_dl_model_anomaly_datasetTrainDlModelAnomalyDatasetTrainDlModelAnomalyDatasetTrainDlModelAnomalyDatasettrain_dl_model_anomaly_dataset will be executed on the GPU. For the specific requirements please refer to the HALCON “Installation Guide”.

'tensorrt'"tensorrt""tensorrt""tensorrt""tensorrt""tensorrt":

The memory is initialized on the device via the Nvidia TensorRT-plugin for the AI²-interface. The operator apply_dl_modelapply_dl_modelApplyDlModelApplyDlModelApplyDlModelapply_dl_model will be executed on the GPU using the TensorRT-interface. In order to successfully run the operator on the selected device, a conversion may be necessary using optimize_dl_model_for_inferenceoptimize_dl_model_for_inferenceOptimizeDlModelForInferenceOptimizeDlModelForInferenceOptimizeDlModelForInferenceoptimize_dl_model_for_inference, see its documentation entry.

'summary'"summary""summary""summary""summary""summary":

This parameter returns information on the layers of the model. More precisely, it returns a tuple with a string for every layer. The string is as follows: ID; NAME; TYPE; OUTPUT_SHAPE; CONNECTED_NODES

  • ID: Index of the layer in the CNN graph.

  • NAME: Human-readable identifier (optional).

  • TYPE: Human-readable identifier representing the type of the layer (e.g., input or convolution).

  • OUTPUT_SHAPE: Size of the output, given in the form (Width, Height, Depth, 'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size"). This means, the layer has feature maps of size Width times Height and therefrom Depth many. Together they form an iconic object with a channel for every feature map. The parameter 'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size" determines, how many objects are returned together.

  • CONNECTED_NODES: Comma separated list with IDs of the layers using the output of the current layer as input

E.g., '3; conv1; convolution; (112, 112, 64, 160); 4'.

Note, for some networks distributed with HALCON, the network architecture is confidential. In this case get_dl_model_paramget_dl_model_paramGetDlModelParamGetDlModelParamGetDlModelParamget_dl_model_param returns an empty tuple with 'summary'"summary""summary""summary""summary""summary".

'type'"type""type""type""type""type":

This parameter returns the HALCON-specific model type. The following types are distinguished:

  • 'anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection"

  • 'classification'"classification""classification""classification""classification""classification"

  • 'detection'"detection""detection""detection""detection""detection"

  • 'segmentation'"segmentation""segmentation""segmentation""segmentation""segmentation"

  • 'generic'"generic""generic""generic""generic""generic" - for certain read in models or models created with the DL framework, see set_dl_model_paramset_dl_model_paramSetDlModelParamSetDlModelParamSetDlModelParamset_dl_model_param.

'weight_prior'"weight_prior""weight_prior""weight_prior""weight_prior""weight_prior":

Regularization parameter used for the regularization of the loss function. For a detailed description of the regularization term we refer to train_dl_model_batchtrain_dl_model_batchTrainDlModelBatchTrainDlModelBatchTrainDlModelBatchtrain_dl_model_batch. Simply put: Regularization favors simpler models that are less likely to learn noise in the data and generalize better. In case the classifier overfits the data, it is strongly recommended to try different values for the parameter 'weight_prior'"weight_prior""weight_prior""weight_prior""weight_prior""weight_prior" to improve the generalization properties of the neural network. Choosing its value is a trade-off between the models ability to generalize, overfitting, and underfitting. If is too small, the model might overfit, if its too large the model might loose its ability to fit the data, because all weights are effectively zero. For finding an ideal value for , we recommend a cross-validation, i.e. to perform the training for a range of values and choose the value that results in the best validation error. For typical applications, we recommend testing the values for 'weight_prior'"weight_prior""weight_prior""weight_prior""weight_prior""weight_prior" on a logarithmic scale between . If the training takes a very long time, one might consider performing the hyperparameter optimization on a reduced amount of data.

Models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection":

The parameter 'weight_prior'"weight_prior""weight_prior""weight_prior""weight_prior""weight_prior" has no effect.

Default: 'weight_prior'"weight_prior""weight_prior""weight_prior""weight_prior""weight_prior" = 0.0 (with exception of the pretrained classifiers pretrained_dl_classifier_resnet50: 'weight_prior'"weight_prior""weight_prior""weight_prior""weight_prior""weight_prior" = 0.0001, pretrained_dl_classifier_alexnet: 'weight_prior'"weight_prior""weight_prior""weight_prior""weight_prior""weight_prior" = 0.0005)

Models of 'type'"type""type""type""type""type"='anomaly_detection'"anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection""anomaly_detection"

'complexity'"complexity""complexity""complexity""complexity""complexity":

This parameter controls the capacity of the model to deal with more complex applications. A higher value allows for the model to represent images showing more complexity. Increasing the parameter leads to higher runtimes during training and inference. Please note that this parameter can only be set before the model is trained. Setting 'complexity'"complexity""complexity""complexity""complexity""complexity" on an already trained model would render this model useless. When trying to do so, an error is returned but the model itself is unchanged.

Default: 'complexity'"complexity""complexity""complexity""complexity""complexity" = 15

'standard_deviation_factor'"standard_deviation_factor""standard_deviation_factor""standard_deviation_factor""standard_deviation_factor""standard_deviation_factor":

The anomaly score is calculated internally as the mean of certain internal scores s plus lambda times their standard deviation.

Where s denotes a pixel value of the internal anomaly_image, the mean value of s and the standard deviation of s. The parameter 'standard_deviation_factor'"standard_deviation_factor""standard_deviation_factor""standard_deviation_factor""standard_deviation_factor""standard_deviation_factor" sets the value and thus controls how import the standard deviation is in comparison to the mean.

Default: 'standard_deviation_factor'"standard_deviation_factor""standard_deviation_factor""standard_deviation_factor""standard_deviation_factor""standard_deviation_factor" = 3.0

Models of 'type'"type""type""type""type""type"='classification'"classification""classification""classification""classification""classification"

'backbone_docking_layers'"backbone_docking_layers""backbone_docking_layers""backbone_docking_layers""backbone_docking_layers""backbone_docking_layers":

The parameter 'backbone_docking_layers'"backbone_docking_layers""backbone_docking_layers""backbone_docking_layers""backbone_docking_layers""backbone_docking_layers" specifies which layers of the backbone are to be used as docking layers by the feature pyramid. Thereby the layers are referenced by their names.

The docking layers can be specified for every classifier, also without using them as backbone. The specification is only considered for object detection backbones. When selecting the docking layers, consider that the feature map lengths have to be halved from one docking layer to the other. Rule of thumb: Use the deepest layers for every (lateral) resolution in the backbone (corresponding to one of the required levels for your object detection task).

Information about the names and sizes of the layers in a model can be enquired using 'summary'"summary""summary""summary""summary""summary".

Default: For the pretrained backbones delivered by HALCON the defaults depend on the classifier. Other classifiers do not have any docking layers set by default and therefore need to have this parameter set before they can be used as backbone.

'class_names'"class_names""class_names""class_names""class_names""class_names":

Unique names of the classes the model shall distinguish. The order of the class names remains unchanged after the setting. The tuple is of length 'num_classes'"num_classes""num_classes""num_classes""num_classes""num_classes".

'extract_feature_maps'"extract_feature_maps""extract_feature_maps""extract_feature_maps""extract_feature_maps""extract_feature_maps":

With this parameter value you can extract feature maps of the specified model layer for an inferred image. The selected layer must be part of the existing network. An overview of all existing layers of the model can be returned by the operator get_dl_model_paramget_dl_model_paramGetDlModelParamGetDlModelParamGetDlModelParamget_dl_model_param with the corresponding parameter 'summary'"summary""summary""summary""summary""summary".

Note, using this option modifies the network architecture: The network is truncated after a selected layer. This modification can not be reversed. If the original network architecture should be used again it must be read in again with the operator read_dl_modelread_dl_modelReadDlModelReadDlModelReadDlModelread_dl_model.

Models of 'type'"type""type""type""type""type"='detection'"detection""detection""detection""detection""detection"
'anchor_angles'"anchor_angles""anchor_angles""anchor_angles""anchor_angles""anchor_angles":

The parameter 'anchor_angles'"anchor_angles""anchor_angles""anchor_angles""anchor_angles""anchor_angles" determines the orientation angle of the anchors for a model of 'instance_type'"instance_type""instance_type""instance_type""instance_type""instance_type" = 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2""rectangle2".

Thereby, the orientation is given in arc measure and indicates the angle between the horizontal axis and 'Length1'"Length1""Length1""Length1""Length1""Length1" (mathematically positive). See the chapter Deep Learning / Object Detection for more explanations to anchors.

You can set a tuple of values. A higher number of angles increases the number of anchors which might lead to a better localization but also increases the runtime and memory-consumption.

Assertion: 'anchor_angles'"anchor_angles""anchor_angles""anchor_angles""anchor_angles""anchor_angles" for 'ignore_direction'"ignore_direction""ignore_direction""ignore_direction""ignore_direction""ignore_direction" = 'false'"false""false""false""false""false", 'anchor_angles'"anchor_angles""anchor_angles""anchor_angles""anchor_angles""anchor_angles" for 'ignore_direction'"ignore_direction""ignore_direction""ignore_direction""ignore_direction""ignore_direction" = 'true'"true""true""true""true""true"

Default: 'anchor_angles'"anchor_angles""anchor_angles""anchor_angles""anchor_angles""anchor_angles" = [0.0]

'anchor_aspect_ratios'"anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios" (legacy: 'aspect_ratios'"aspect_ratios""aspect_ratios""aspect_ratios""aspect_ratios""aspect_ratios"):

The parameter 'anchor_aspect_ratios'"anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios" determines the aspect ratio of the anchors. Thereby, the definition of the ratio depends on the 'instance_type'"instance_type""instance_type""instance_type""instance_type""instance_type":

  • 'rectangle1'"rectangle1""rectangle1""rectangle1""rectangle1""rectangle1": height-to-width ratio

  • 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2""rectangle2": ratio length1 to length2

E.g., for instance type 'rectangle1'"rectangle1""rectangle1""rectangle1""rectangle1""rectangle1" the ratio 2 gives a narrow and 0.5 a broad anchor. The size of the anchor is affected by the parameter 'anchor_num_subscales'"anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales" and with its explanation we give the formula for the sizes and lengths of the generated anchors. See the chapter Deep Learning / Object Detection for more explanations to anchors.

You can set a tuple of values. A higher number of aspect ratios increases the number of anchors which might lead to a better localization but also increases the runtime and memory-consumption.

For reasons of backward compatibility, the parameter name 'aspect_ratios'"aspect_ratios""aspect_ratios""aspect_ratios""aspect_ratios""aspect_ratios" can be used instead of 'anchor_aspect_ratios'"anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios".

Default: 'anchor_aspect_ratios'"anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios" = [1.0, 2.0, 0.5]

'anchor_num_subscales'"anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales" (legacy: 'num_subscales'"num_subscales""num_subscales""num_subscales""num_subscales""num_subscales"):

This parameter determines the number of different sizes with which the anchors are generated at the different levels used.

In HALCON for every anchor point, thus every pixel of every feature map of the feature pyramid, a set of anchors is proposed. See the chapter Deep Learning / Object Detection for more explanations to anchors. Thereby the parameter 'anchor_num_subscales'"anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales" affects the size of the anchors. An example is shown in the figure below.

image/svg+xml
With 'anchor_num_subscales'"anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales"=2 we generate for every aspect ratio 2 anchors of different size on each level: One with the base length (solid line) and an additional, larger one (dotted line). Thereby, in the image these additional anchors of the lower level (orange) converge to the anchor of the next higher level (blue).

An anchor of level has by default a edge lengths of in the input image, whereby the parameter has the value . With the parameter 'anchor_num_subscales'"anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales" additional anchors can be generated, which converge in size to the smallest anchor of the level . More precisely, these anchors of level have in the input image the edge lengths where . For subscale , this results on level in an anchor of height and width equal where is the ratio of this anchor (see 'anchor_aspect_ratios'"anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios").

A larger number of subscales increases the number of anchors and will therefore increase the runtime and memory-consumption.

For reasons of backward compatibility, the parameter name 'num_subscales'"num_subscales""num_subscales""num_subscales""num_subscales""num_subscales" can be used instead of 'anchor_num_subscales'"anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales".

Default: 'anchor_num_subscales'"anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales" = 3

'backbone'"backbone""backbone""backbone""backbone""backbone":

The parameter 'backbone'"backbone""backbone""backbone""backbone""backbone" is the name (together with the path) of the backbone network which is used to create the model. A list of the delivered backbone networks can be found under create_dl_model_detectioncreate_dl_model_detectionCreateDlModelDetectionCreateDlModelDetectionCreateDlModelDetectioncreate_dl_model_detection.

'bbox_heads_weight'"bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight", 'class_heads_weight'"class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight"

The parameters 'bbox_heads_weight'"bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight" and 'class_heads_weight'"class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight" are weighting factors for the calculation of the total loss. This means, when the losses of the individual networks are summed up, the contributions from the bounding box regression heads are weighted by a factor 'bbox_heads_weight'"bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight" and the contributions from the classification heads are weighted by a factor 'class_heads_weight'"class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight".

Default: 'bbox_heads_weight'"bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight" = 1.0, 'class_heads_weight'"class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight" = 1.0

'capacity'"capacity""capacity""capacity""capacity""capacity":

This parameter roughly determines the number of parameters (or filter weights) in the deeper sections of the object detection network (after the backbone). Its possible values are 'high'"high""high""high""high""high", 'medium'"medium""medium""medium""medium""medium", and 'low'"low""low""low""low""low".

It can be used to trade-off between detection performance and speed. For simpler object detection tasks, the 'low'"low""low""low""low""low" or 'medium'"medium""medium""medium""medium""medium" settings may be sufficient to achieve the same detection performance as with 'high'"high""high""high""high""high".

Default: 'capacity'"capacity""capacity""capacity""capacity""capacity" = 'high'"high""high""high""high""high"

'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation":

With this parameter you can declare classes, for which the orientation will not be considered, e.g., round or other point symmetrical objects. For each class, whose class ID is present in 'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation", the network returns axis-aligned bounding boxes.

Note, this parameter only affects networks of 'instance_type'"instance_type""instance_type""instance_type""instance_type""instance_type" = 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2""rectangle2".

Note that the values of 'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation" depend on 'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids". Thus if 'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids" is changed after the creation of the model, 'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation" is reset to an empty tuple.

Default: 'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation" = []

'freeze_backbone_level'"freeze_backbone_level""freeze_backbone_level""freeze_backbone_level""freeze_backbone_level""freeze_backbone_level":

This parameter determines the backbone levels whose weights are kept (meaning not updated and thus frozen) during training. Thereby the given number signifies the highest level whose layers are frozen in the backbone. Setting 'freeze_backbone_level'"freeze_backbone_level""freeze_backbone_level""freeze_backbone_level""freeze_backbone_level""freeze_backbone_level" to 0, for no level the weights are frozen and as a consequence the weights of all layers are updated. It is recommended to set this in case the weights have been randomly initialized (e.g., after certain changes of the number of image channels) or the in case the backbone is not pretrained.

Default: 'freeze_backbone_level'"freeze_backbone_level""freeze_backbone_level""freeze_backbone_level""freeze_backbone_level""freeze_backbone_level" = 2

'instance_type'"instance_type""instance_type""instance_type""instance_type""instance_type":

The parameter 'instance_type'"instance_type""instance_type""instance_type""instance_type""instance_type" determines, which instance type is used for the object model. The current implementations differ regarding the allowed orientations of the bounding boxes. See the chapter Deep Learning / Object Detection for more explanations to the different types and their bounding boxes.

Possible values: 'rectangle1'"rectangle1""rectangle1""rectangle1""rectangle1""rectangle1", 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2""rectangle2"

Default: 'instance_type'"instance_type""instance_type""instance_type""instance_type""instance_type" = 'rectangle1'"rectangle1""rectangle1""rectangle1""rectangle1""rectangle1"

'max_level'"max_level""max_level""max_level""max_level""max_level", 'min_level'"min_level""min_level""min_level""min_level""min_level":

These parameters determine on which levels the additional networks are attached on the feature pyramid. We refer to the chapter Deep Learning / Object Detection for further explanations to the feature pyramid and the attached networks.

From these ('max_level'"max_level""max_level""max_level""max_level""max_level" - 'min_level'"min_level""min_level""min_level""min_level""min_level" + 1) networks all predictions with a minimum confidence value are kept as long they do not strongly overlap (see 'min_confidence'"min_confidence""min_confidence""min_confidence""min_confidence""min_confidence" and 'max_overlap'"max_overlap""max_overlap""max_overlap""max_overlap""max_overlap").

The level declares how often the size of the feature map already has been scaled down. Thus, level 0 corresponds to the feature maps with size of the input image, level 1 to feature maps subscaled once, and so on. As a consequence, smaller objects are detected in the lower levels, whereas larger objects are detected in higher levels.

The value for 'min_level'"min_level""min_level""min_level""min_level""min_level" needs to be at least 2.

If 'max_level'"max_level""max_level""max_level""max_level""max_level" is larger than the number of levels the backbone can provide, the backbone is extended with additional (randomly initialized) convolutional layers in order to generate deeper levels. Further, 'max_level'"max_level""max_level""max_level""max_level""max_level" may have an influence on the minimal input image size.

Note, for small input image dimensions, high levels might not be meaningful, as the feature maps could already be too small to contain meaningful information.

A higher number of used levels might increase the runtime and memory-consumption, whereby especially lower levels carry weight.

Default: 'max_level'"max_level""max_level""max_level""max_level""max_level" = 6, 'min_level'"min_level""min_level""min_level""min_level""min_level" = 2

'max_num_detections'"max_num_detections""max_num_detections""max_num_detections""max_num_detections""max_num_detections":

This parameter determines the maximum number of detections (bounding boxes) per image proposed from the network.

Default: 'max_num_detections'"max_num_detections""max_num_detections""max_num_detections""max_num_detections""max_num_detections" = 100

'max_overlap'"max_overlap""max_overlap""max_overlap""max_overlap""max_overlap":

The maximum allowed intersection over union (IoU) for two predicted bounding boxes of the same class. Or, vice-versa, when two bounding boxes are classified into the same class and have an IoU higher than 'max_overlap'"max_overlap""max_overlap""max_overlap""max_overlap""max_overlap", the one with lower confidence value gets suppressed. We refer to the chapter Deep Learning / Object Detection for further explanations to the IoU.

Default: 'max_overlap'"max_overlap""max_overlap""max_overlap""max_overlap""max_overlap" = 0.5

'max_overlap_class_agnostic'"max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic":

The maximum allowed intersection over union (IoU) for two predicted bounding boxes independently of their predicted classes. Or, vice-versa, when two bounding boxes have an IoU higher than 'max_overlap_class_agnostic'"max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic", the one with lower confidence value gets suppressed. As default, 'max_overlap_class_agnostic'"max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic" is set to 1.0, hence class agnostic bounding box suppression has no influence.

Default: 'max_overlap_class_agnostic'"max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic""max_overlap_class_agnostic" = 1.0

'min_confidence'"min_confidence""min_confidence""min_confidence""min_confidence""min_confidence":

This parameter determines the minimum confidence, when the image part within the bounding box is classified in order to keep the proposed bounding box. This means, when apply_dl_modelapply_dl_modelApplyDlModelApplyDlModelApplyDlModelapply_dl_model is called, all output bounding boxes with a confidence value smaller than 'min_confidence'"min_confidence""min_confidence""min_confidence""min_confidence""min_confidence" are suppressed.

Default: 'min_confidence'"min_confidence""min_confidence""min_confidence""min_confidence""min_confidence" = 0.5

'ignore_direction'"ignore_direction""ignore_direction""ignore_direction""ignore_direction""ignore_direction":

This parameter determines whether for the oriented bounding box also the direction of the object within the bounding box is considered or not. In case the direction within the bounding box is not to be considered you can set 'ignore_direction'"ignore_direction""ignore_direction""ignore_direction""ignore_direction""ignore_direction" to 'true'"true""true""true""true""true". In order to determine the bounding box unambiguously, in this case (but only in this case) the following conventions apply:

  • 'phi'"phi""phi""phi""phi""phi"

  • 'bbox_length1'"bbox_length1""bbox_length1""bbox_length1""bbox_length1""bbox_length1" > 'bbox_length2'"bbox_length2""bbox_length2""bbox_length2""bbox_length2""bbox_length2"

This is consistent to smallest_rectangle2smallest_rectangle2SmallestRectangle2SmallestRectangle2SmallestRectangle2smallest_rectangle2.

Note, this parameter only affects networks of 'instance_type'"instance_type""instance_type""instance_type""instance_type""instance_type" = 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2""rectangle2".

Possible values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false"

Default: 'ignore_direction'"ignore_direction""ignore_direction""ignore_direction""ignore_direction""ignore_direction" = 'false'"false""false""false""false""false"

Models of 'type'"type""type""type""type""type"='segmentation'"segmentation""segmentation""segmentation""segmentation""segmentation"

'ignore_class_ids'"ignore_class_ids""ignore_class_ids""ignore_class_ids""ignore_class_ids""ignore_class_ids":

With this parameter you can declare one or multiple classes as 'ignore' classes, see the chapter Deep Learning / Semantic Segmentation for further information. These classes are declared over their ID (integers).

Note, you can not set a class ID in 'ignore_class_ids'"ignore_class_ids""ignore_class_ids""ignore_class_ids""ignore_class_ids""ignore_class_ids" and 'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids" simultaneously.

Execution Information

Parameters

DLModelHandleDLModelHandleDLModelHandleDLModelHandleDLModelHandledlmodel_handle (input_control)  dl_model HDlModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the deep learning model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the generic parameter.

Default value: 'batch_size' "batch_size" "batch_size" "batch_size" "batch_size" "batch_size"

List of values: 'alphabet'"alphabet""alphabet""alphabet""alphabet""alphabet", 'anchor_angles'"anchor_angles""anchor_angles""anchor_angles""anchor_angles""anchor_angles", 'anchor_aspect_ratios'"anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios""anchor_aspect_ratios", 'anchor_num_subscales'"anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales""anchor_num_subscales", 'backbone'"backbone""backbone""backbone""backbone""backbone", 'backbone_docking_layers'"backbone_docking_layers""backbone_docking_layers""backbone_docking_layers""backbone_docking_layers""backbone_docking_layers", 'batch_size'"batch_size""batch_size""batch_size""batch_size""batch_size", 'batch_size_multiplier'"batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier""batch_size_multiplier", 'bbox_heads_weight'"bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight""bbox_heads_weight", 'capacity'"capacity""capacity""capacity""capacity""capacity", 'class_heads_weight'"class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight""class_heads_weight", 'class_ids'"class_ids""class_ids""class_ids""class_ids""class_ids", 'class_ids_no_orientation'"class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation""class_ids_no_orientation", 'class_names'"class_names""class_names""class_names""class_names""class_names", 'class_weights'"class_weights""class_weights""class_weights""class_weights""class_weights", 'complexity'"complexity""complexity""complexity""complexity""complexity", 'device'"device""device""device""device""device", 'extract_feature_maps'"extract_feature_maps""extract_feature_maps""extract_feature_maps""extract_feature_maps""extract_feature_maps", 'freeze_backbone_level'"freeze_backbone_level""freeze_backbone_level""freeze_backbone_level""freeze_backbone_level""freeze_backbone_level", 'gpu'"gpu""gpu""gpu""gpu""gpu", 'ignore_class_ids'"ignore_class_ids""ignore_class_ids""ignore_class_ids""ignore_class_ids""ignore_class_ids", 'ignore_direction'"ignore_direction""ignore_direction""ignore_direction""ignore_direction""ignore_direction", 'image_dimensions'"image_dimensions""image_dimensions""image_dimensions""image_dimensions""image_dimensions", 'image_height'"image_height""image_height""image_height""image_height""image_height", 'image_num_channels'"image_num_channels""image_num_channels""image_num_channels""image_num_channels""image_num_channels", 'image_range_max'"image_range_max""image_range_max""image_range_max""image_range_max""image_range_max", 'image_range_min'"image_range_min""image_range_min""image_range_min""image_range_min""image_range_min", 'image_width'"image_width""image_width""image_width""image_width""image_width", 'input_dimensions'"input_dimensions""input_dimensions""input_dimensions""