query_available_dl_devicesT_query_available_dl_devicesQueryAvailableDlDevicesQueryAvailableDlDevicesquery_available_dl_devices (Operator)

Name

query_available_dl_devicesT_query_available_dl_devicesQueryAvailableDlDevicesQueryAvailableDlDevicesquery_available_dl_devices — Get list of deep-learning-capable hardware devices.

Signature

query_available_dl_devices( : : GenParamName, GenParamValue : DLDeviceHandles)

Description

query_available_dl_devicesquery_available_dl_devicesQueryAvailableDlDevicesQueryAvailableDlDevicesQueryAvailableDlDevicesquery_available_dl_devices returns a list of handles. Each handle refers to a deep-learning-capable hardware device (hereafter referred to as device) that can be used for inference or training of a deep learning model.

A deep-learning-capable device is either supported directly through HALCON or through an inference engine.

The support of inference engines in HALCON is currently not available but planned for the future.

The devices that are supported directly through HALCON are equivalent to those that can be set to a deep learning model via set_dl_model_paramset_dl_model_paramSetDlModelParamSetDlModelParamSetDlModelParamset_dl_model_param using 'runtime'"runtime""runtime""runtime""runtime""runtime" = 'cpu'"cpu""cpu""cpu""cpu""cpu" or 'runtime'"runtime""runtime""runtime""runtime""runtime" = 'gpu'"gpu""gpu""gpu""gpu""gpu". HALCON provides an internal implementation for the inference or training of a deep learning model for those devices. See Deep Learning for more details.

Devices that are supported through an inference engine can also be set to a deep learning model using set_dl_model_paramset_dl_model_paramSetDlModelParamSetDlModelParamSetDlModelParamset_dl_model_param. In this case the inference is not executed by HALCON but by the inference engine.

query_available_dl_devicesquery_available_dl_devicesQueryAvailableDlDevicesQueryAvailableDlDevicesQueryAvailableDlDevicesquery_available_dl_devices returns a handle for each deep-learning-capable device supported through HALCON and through an inference engine.

If a device is supported through HALCON and one or several inference engines, query_available_dl_devicesquery_available_dl_devicesQueryAvailableDlDevicesQueryAvailableDlDevicesQueryAvailableDlDevicesquery_available_dl_devices returns a handle for HALCON and for each inference engine.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name can be used to filters for the devices. Supported values are:

'id'"id""id""id""id""id":

Devices with this ID.

Possible values: 0, 1, ....

'inference_engine'"inference_engine""inference_engine""inference_engine""inference_engine""inference_engine" (Reserved for future usage):

Devices contained in an inference engine with this name.

Possible values: 'none'"none""none""none""none""none".

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

The devices, which are directly supported by HALCON for this device type.

Possible values: 'cpu'"cpu""cpu""cpu""cpu""cpu", 'gpu'"gpu""gpu""gpu""gpu""gpu".

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

Devices of this type.

Possible values: 'cpu'"cpu""cpu""cpu""cpu""cpu", 'gpu'"gpu""gpu""gpu""gpu""gpu".

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name can have multiple entries for the same value. In this case filter combines the entries with a logical 'or'. Please see the example code below for some examples how to use the filter.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
Processed without parallelization.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)

Name of the generic parameter.

Default value: []

List of values: 'id'"id""id""id""id""id", 'inference_engine'"inference_engine""inference_engine""inference_engine""inference_engine""inference_engine", 'runtime'"runtime""runtime""runtime""runtime""runtime", 'type'"type""type""type""type""type"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) attribute.value(-array) → (string / integer / real)

Value of the generic parameter.

Default value: []

Suggested values:

DLDeviceHandlesDLDeviceHandlesDLDeviceHandlesDLDeviceHandlesDLDeviceHandlesdldevice_handles (output_control) dl_device(-array) → (handle)

Tuple of DLDevice handles

Example (HDevelop)

* Query all deep-learning-capable hardware devices
query_available_dl_devices ([], [], DLDeviceHandles)

* Query all GPUs with ID 0 or 2
query_available_dl_devices (['type', 'id', 'id'], ['gpu', 0, 2], DLDeviceHandles)

* Query the unique GPU with ID 1 supported by HALCON
query_available_dl_devices (['runtime', 'id'], ['gpu', 1], DLDeviceHandles)

Result

If the parameters are valid, the operator query_available_dl_devicesquery_available_dl_devicesQueryAvailableDlDevicesQueryAvailableDlDevicesQueryAvailableDlDevicesquery_available_dl_devices returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Successors

get_dl_device_paramget_dl_device_paramGetDlDeviceParamGetDlDeviceParamGetDlDeviceParamget_dl_device_param

Module

Foundation

Operators