get_dl_device_paramT_get_dl_device_paramGetDlDeviceParamGetDlDeviceParamget_dl_device_param (Operator)
Name
get_dl_device_paramT_get_dl_device_paramGetDlDeviceParamGetDlDeviceParamget_dl_device_param — Return the parameters of a deep-learning-capable hardware device.
Signature
Description
get_dl_device_paramget_dl_device_paramGetDlDeviceParamGetDlDeviceParamGetDlDeviceParamget_dl_device_param returns the parameter values
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value of GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name for the
deep-learning-capable hardware device (hereafter referred to as device)
DLDeviceHandleDLDeviceHandleDLDeviceHandleDLDeviceHandleDLDeviceHandledldevice_handle.
See query_available_dl_devicesquery_available_dl_devicesQueryAvailableDlDevicesQueryAvailableDlDevicesQueryAvailableDlDevicesquery_available_dl_devices for details about deep-learning-capable
hardware devices.
Supported values for GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name are:
- 'id'"id""id""id""id""id":
The ID of the device. Within each inference engine,
the IDs of its supported devices are unique. The same
holds for devices supported through HALCON.
- 'inference_only'"inference_only""inference_only""inference_only""inference_only""inference_only":
Indicates if the device can only be used to
infer deep learning models ('true'"true""true""true""true""true") or
also supports training or gradient-based operations
('false'"false""false""false""false""false").
- 'name'"name""name""name""name""name":
Name of the device.
- 'inference_engine'"inference_engine""inference_engine""inference_engine""inference_engine""inference_engine" (Reserved for future usage):
Name of the inference engine that supports the device.
In case the device is directly supported by HALCON,
the value 'none'"none""none""none""none""none" is returned.
- 'type'"type""type""type""type""type":
Type of the device.
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
DLDeviceHandleDLDeviceHandleDLDeviceHandleDLDeviceHandleDLDeviceHandledldevice_handle (input_control) dl_device → HDlDevice, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the deep-learning-capable hardware device.
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the generic parameter.
Default value:
'type'
"type"
"type"
"type"
"type"
"type"
List of values: 'id'"id""id""id""id""id", 'inference_engine'"inference_engine""inference_engine""inference_engine""inference_engine""inference_engine", 'inference_only'"inference_only""inference_only""inference_only""inference_only""inference_only", 'name'"name""name""name""name""name", 'type'"type""type""type""type""type"
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control) attribute.name(-array) → HTupleSequence[Union[str, float, int]]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)
Value of the generic parameter.
Result
If the parameters are valid, the operator get_dl_device_paramget_dl_device_paramGetDlDeviceParamGetDlDeviceParamGetDlDeviceParamget_dl_device_param
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
Possible Predecessors
query_available_dl_devicesquery_available_dl_devicesQueryAvailableDlDevicesQueryAvailableDlDevicesQueryAvailableDlDevicesquery_available_dl_devices
Possible Successors
set_dl_model_paramset_dl_model_paramSetDlModelParamSetDlModelParamSetDlModelParamset_dl_model_param
Module
Foundation