Intel HDDL specific properties¶
Overview¶
Set of Intel HDDL specific properties. More…
// global variables
static constexpr Property<int, PropertyMutability::RO> ov::intel_myriad::hddl::device_num {"HDDL_DEVICE_NUM"};
static constexpr Property<std::vector<float>, PropertyMutability::RO> ov::intel_myriad::hddl::device_thermal {"HDDL_DEVICE_THERMAL"};
static constexpr Property<std::vector<unsigned int>, PropertyMutability::RO> ov::intel_myriad::hddl::device_id {"HDDL_DEVICE_ID"};
static constexpr Property<std::vector<int>, PropertyMutability::RO> ov::intel_myriad::hddl::device_subclass {"HDDL_DEVICE_SUBCLASS"};
static constexpr Property<std::vector<unsigned int>, PropertyMutability::RO> ov::intel_myriad::hddl::device_memory_total { "HDDL_DEVICE_MEMORY_TOTAL"};
static constexpr Property<std::vector<unsigned int>, PropertyMutability::RO> ov::intel_myriad::hddl::device_memory_used { "HDDL_DEVICE_MEMORY_USED"};
static constexpr Property<std::vector<float>, PropertyMutability::RO> ov::intel_myriad::hddl::device_utilization {"HDDL_DEVICE_UTILIZATION"};
static constexpr Property<std::vector<std::string>, PropertyMutability::RO> ov::intel_myriad::hddl::stream_id {"HDDL_STREAM_ID"};
static constexpr Property<std::vector<std::string>, PropertyMutability::RO> ov::intel_myriad::hddl::device_tag {"HDDL_DEVICE_TAG"};
static constexpr Property<std::vector<int>, PropertyMutability::RO> ov::intel_myriad::hddl::group_id {"HDDL_GROUP_ID"};
static constexpr Property<int, PropertyMutability::RO> ov::intel_myriad::hddl::device_group_using_num {"HDDL_DEVICE_GROUP_USING_NUM"};
static constexpr Property<int, PropertyMutability::RO> ov::intel_myriad::hddl::device_total_num {"HDDL_DEVICE_TOTAL_NUM"};
static constexpr Property<std::string, PropertyMutability::RW> ov::intel_myriad::hddl::graph_tag {"HDDL_GRAPH_TAG"};
static constexpr Property<std::string, PropertyMutability::RW> ov::intel_myriad::hddl::set_stream_id {"HDDL_SET_STREAM_ID"};
static constexpr Property<std::string, PropertyMutability::RW> ov::intel_myriad::hddl::set_device_tag {"HDDL_SET_DEVICE_TAG"};
static constexpr Property<bool, PropertyMutability::RW> ov::intel_myriad::hddl::bind_device {"HDDL_BIND_DEVICE"};
static constexpr Property<std::string, PropertyMutability::RW> ov::intel_myriad::hddl::runtime_priority {"HDDL_RUNTIME_PRIORITY"};
static constexpr Property<bool, PropertyMutability::RW> ov::intel_myriad::hddl::use_sgad {"HDDL_USE_SGAD"};
static constexpr Property<std::string, PropertyMutability::RW> ov::intel_myriad::hddl::group_device {"HDDL_GROUP_DEVICE"};Detailed Documentation¶
Set of Intel HDDL specific properties.
Global Variables¶
static constexpr Property<int, PropertyMutability::RO> ov::intel_myriad::hddl::device_num {"HDDL_DEVICE_NUM"}Property to get a int of the device number.
static constexpr Property<std::vector<float>, PropertyMutability::RO> ov::intel_myriad::hddl::device_thermal {"HDDL_DEVICE_THERMAL"}Property to get a std::vector<float> of device thermal.
static constexpr Property<std::vector<unsigned int>, PropertyMutability::RO> ov::intel_myriad::hddl::device_id {"HDDL_DEVICE_ID"}Property to get a std::vector<uint32> of device ids.
static constexpr Property<std::vector<int>, PropertyMutability::RO> ov::intel_myriad::hddl::device_subclass {"HDDL_DEVICE_SUBCLASS"}Property to get a std::vector<int> of device subclasses.
static constexpr Property<std::vector<unsigned int>, PropertyMutability::RO> ov::intel_myriad::hddl::device_memory_total { "HDDL_DEVICE_MEMORY_TOTAL"}Property to get a std::vector<uint32> of device total memory.
static constexpr Property<std::vector<unsigned int>, PropertyMutability::RO> ov::intel_myriad::hddl::device_memory_used { "HDDL_DEVICE_MEMORY_USED"}Property to get a std::vector<uint32> of device used memory.
static constexpr Property<std::vector<float>, PropertyMutability::RO> ov::intel_myriad::hddl::device_utilization {"HDDL_DEVICE_UTILIZATION"}Property to get a std::vector<float> of device utilization.
static constexpr Property<std::vector<std::string>, PropertyMutability::RO> ov::intel_myriad::hddl::stream_id {"HDDL_STREAM_ID"}Property to get a std::vector<std::string> of stream ids.
static constexpr Property<std::vector<std::string>, PropertyMutability::RO> ov::intel_myriad::hddl::device_tag {"HDDL_DEVICE_TAG"}Property to get a std::vector<std::string> of device tags.
static constexpr Property<std::vector<int>, PropertyMutability::RO> ov::intel_myriad::hddl::group_id {"HDDL_GROUP_ID"}Property to get a std::vector<int> of group ids.
static constexpr Property<int, PropertyMutability::RO> ov::intel_myriad::hddl::device_group_using_num {"HDDL_DEVICE_GROUP_USING_NUM"}Property to get a int number of device be using for group.
static constexpr Property<int, PropertyMutability::RO> ov::intel_myriad::hddl::device_total_num {"HDDL_DEVICE_TOTAL_NUM"}Property to get a int number of total device.
static constexpr Property<std::string, PropertyMutability::RW> ov::intel_myriad::hddl::graph_tag {"HDDL_GRAPH_TAG"}[Only for HDDLPlugin] Type: Arbitrary non-empty string. If empty (“”), equals no set, default: “”; This option allows to specify the number of MYX devices used for inference a specific Executable network. Note: Only one network would be allocated to one device. The number of devices for the tag is specified in the hddl_service.config file. Example: “service_settings”: { “graph_tag_map”: { “tagA”:3 } } It means that an executable network marked with tagA will be executed on 3 devices
static constexpr Property<std::string, PropertyMutability::RW> ov::intel_myriad::hddl::set_stream_id {"HDDL_SET_STREAM_ID"}[Only for HDDLPlugin] Type: Arbitrary non-empty string. If empty (“”), equals no set, default: “”; This config makes the executable networks to be allocated on one certain device (instead of multiple devices). And all inference through this executable network, will be done on this device. Note: Only one network would be allocated to one device. The number of devices which will be used for stream-affinity must be specified in hddl_service.config file. Example: “service_settings”: { “stream_device_number”:5 } It means that 5 device will be used for stream-affinity
static constexpr Property<std::string, PropertyMutability::RW> ov::intel_myriad::hddl::set_device_tag {"HDDL_SET_DEVICE_TAG"}[Only for HDDLPlugin] Type: Arbitrary non-empty string. If empty (“”), equals no set, default: “”; This config allows user to control device flexibly. This config gives a “tag” for a certain device while allocating a network to it. Afterward, user can allocating/deallocating networks to this device with this “tag”. Devices used for such use case is controlled by a so-called “Bypass Scheduler” in HDDL backend, and the number of such device need to be specified in hddl_service.config file. Example: “service_settings”: { “bypass_device_number”: 5 } It means that 5 device will be used for Bypass scheduler.
static constexpr Property<bool, PropertyMutability::RW> ov::intel_myriad::hddl::bind_device {"HDDL_BIND_DEVICE"}[Only for HDDLPlugin] Type: “bool”, default is “false”. This config is a sub-config of DEVICE_TAG, and only available when “DEVICE_TAG” is set. After a user load a network, the user got a handle for the network. If “YES”, the network allocated is bind to the device (with the specified “DEVICE_TAG”), which means all afterwards inference through this network handle will be executed on this device only. If “NO”, the network allocated is not bind to the device (with the specified “DEVICE_TAG”). If the same network is allocated on multiple other devices (also set BIND_DEVICE to “False”), then inference through any handle of these networks may be executed on any of these devices those have the network loaded.
static constexpr Property<std::string, PropertyMutability::RW> ov::intel_myriad::hddl::runtime_priority {"HDDL_RUNTIME_PRIORITY"}[Only for HDDLPlugin] Type: A signed int wrapped in a string, default is “0”. This config is a sub-config of DEVICE_TAG, and only available when “DEVICE_TAG” is set and “BIND_DEVICE” is “False”. When there are multiple devices running a certain network (a same network running on multiple devices in Bypass Scheduler), the device with a larger number has a higher priority, and more inference tasks will be fed to it with priority.
static constexpr Property<bool, PropertyMutability::RW> ov::intel_myriad::hddl::use_sgad {"HDDL_USE_SGAD"}[Only for HDDLPlugin] Type: “bool”, default is “false”. SGAD is short for “Single Graph All Device”. With this scheduler, once application allocates 1 network, all devices (managed by SGAD scheduler) will be loaded with this graph. The number of network that can be loaded to one device can exceed one. Once application deallocates 1 network from device, all devices will unload the network from them.
static constexpr Property<std::string, PropertyMutability::RW> ov::intel_myriad::hddl::group_device {"HDDL_GROUP_DEVICE"}[Only for HDDLPlugin] Type: A signed int wrapped in a string, default is “0”. This config gives a “group id” for a certain device when this device has been reserved for certain client, client can use this device grouped by calling this group id while other client can’t use this device Each device has their own group id. Device in one group shares same group id.