vpu_plugin_config.hpp
Go to the documentation of this file.
1 // Copyright (C) 2018-2019 Intel Corporation
2 // SPDX-License-Identifier: Apache-2.0
3 //
4 
5 /**
6  * @brief A header that defines advanced related properties for VPU plugins.
7  * These properties should be used in SetConfig() and LoadNetwork() methods of plugins
8  *
9  * @file vpu_plugin_config.hpp
10  */
11 
12 #pragma once
13 
14 #include <string>
15 #include "ie_plugin_config.hpp"
16 
17 #define VPU_CONFIG_KEY(name) InferenceEngine::VPUConfigParams::_CONFIG_KEY(VPU_##name)
18 #define VPU_CONFIG_VALUE(name) InferenceEngine::VPUConfigParams::VPU_##name
19 
20 #define DECLARE_VPU_CONFIG_KEY(name) DECLARE_CONFIG_KEY(VPU_##name)
21 #define DECLARE_VPU_CONFIG_VALUE(name) DECLARE_CONFIG_VALUE(VPU_##name)
22 
23 #define VPU_HDDL_CONFIG_KEY(name) InferenceEngine::VPUConfigParams::_CONFIG_KEY(VPU_HDDL_##name)
24 #define VPU_HDDL_CONFIG_VALUE(name) InferenceEngine::VPUConfigParams::VPU_HDDL_##name
25 
26 #define DECLARE_VPU_HDDL_CONFIG_KEY(name) DECLARE_CONFIG_KEY(VPU_HDDL_##name)
27 #define DECLARE_VPU_HDDL_CONFIG_VALUE(name) DECLARE_CONFIG_VALUE(VPU_HDDL_##name)
28 
29 namespace InferenceEngine {
30 namespace VPUConfigParams {
31 
32 /**
33  * @brief Turn on HW stages usage (applicable for MyriadX devices only).
34  * This option should be used with values: CONFIG_VALUE(YES) or CONFIG_VALUE(NO) (default)
35  */
36 DECLARE_VPU_CONFIG_KEY(HW_STAGES_OPTIMIZATION);
37 
38 /**
39  * @brief The key to specify desirable log level for devices.
40  * This option should be used with values: CONFIG_VALUE(LOG_NONE) (default),
41  * CONFIG_VALUE(LOG_WARNING), CONFIG_VALUE(LOG_INFO), CONFIG_VALUE(LOG_DEBUG)
42  */
43 DECLARE_VPU_CONFIG_KEY(LOG_LEVEL);
44 
45 /**
46  * @deprecated
47  * @brief The key to define normalization coefficient for the network input.
48  * This option should used with be a real number. Example "255.f"
49  */
50 DECLARE_VPU_CONFIG_KEY(INPUT_NORM);
51 
52 /**
53  * @deprecated
54  * @brief The flag to specify Bias value that is added to each element of the network input.
55  * This option should used with be a real number. Example "0.1f"
56  */
57 DECLARE_VPU_CONFIG_KEY(INPUT_BIAS);
58 
59 /**
60  * @brief The flag for adding to the profiling information the time of obtaining a tensor.
61  * This option should be used with values: CONFIG_VALUE(YES) or CONFIG_VALUE(NO) (default)
62  */
63 DECLARE_VPU_CONFIG_KEY(PRINT_RECEIVE_TENSOR_TIME);
64 
65 /**
66  * @brief The flag to reset stalled devices: CONFIG_VALUE(YES) or CONFIG_VALUE(NO) (default)
67  * This is a plugin scope option and must be used with the plugin's SetConfig method
68  */
69 DECLARE_VPU_CONFIG_KEY(FORCE_RESET);
70 
71 /**
72  * @brief [Only for HDDLPlugin]
73  * Type: Arbitrary non-empty string. If empty (""), equals no set, default: "";
74  * This option allows to specify the number of MYX devices used for inference a specific Executable network.
75  * Note: Only one network would be allocated to one device.
76  * The number of devices for the tag is specified in the hddl_service.config file.
77  * Example:
78  * "service_settings":
79  * {
80  * "graph_tag_map":
81  * {
82  * "tagA":3
83  * }
84  * }
85  * It means that an executable network marked with tagA will be executed on 3 devices
86  */
87 DECLARE_VPU_HDDL_CONFIG_KEY(GRAPH_TAG);
88 
89 /**
90  * @brief [Only for HDDLPlugin]
91  * Type: Arbitrary non-empty string. If empty (""), equals no set, default: "";
92  * This config makes the executable networks to be allocated on one certain device (instead of multiple devices).
93  * And all inference through this executable network, will be done on this device.
94  * Note: Only one network would be allocated to one device.
95  * The number of devices which will be used for stream-affinity must be specified in hddl_service.config file.
96  * Example:
97  * "service_settings":
98  * {
99  * "stream_device_number":5
100  * }
101  * It means that 5 device will be used for stream-affinity
102  */
103 DECLARE_VPU_HDDL_CONFIG_KEY(STREAM_ID);
104 
105 /**
106  * @brief [Only for HDDLPlugin]
107  * Type: Arbitrary non-empty string. If empty (""), equals no set, default: "";
108  * This config allows user to control device flexibly. This config gives a "tag" for a certain device while
109  * allocating a network to it. Afterward, user can allocating/deallocating networks to this device with this "tag".
110  * Devices used for such use case is controlled by a so-called "Bypass Scheduler" in HDDL backend, and the number
111  * of such device need to be specified in hddl_service.config file.
112  * Example:
113  * "service_settings":
114  * {
115  * "bypass_device_number": 5
116  * }
117  * It means that 5 device will be used for Bypass scheduler.
118  */
119 DECLARE_VPU_HDDL_CONFIG_KEY(DEVICE_TAG);
120 
121 /**
122  * @brief [Only for HDDLPlugin]
123  * Type: "YES/NO", default is "NO".
124  * This config is a sub-config of DEVICE_TAG, and only available when "DEVICE_TAG" is set. After a user load a
125  * network, the user got a handle for the network.
126  * If "YES", the network allocated is bind to the device (with the specified "DEVICE_TAG"), which means all afterwards
127  * inference through this network handle will be executed on this device only.
128  * If "NO", the network allocated is not bind to the device (with the specified "DEVICE_TAG"). If the same network
129  * is allocated on multiple other devices (also set BIND_DEVICE to "False"), then inference through any handle of these
130  * networks may be executed on any of these devices those have the network loaded.
131  */
132 DECLARE_VPU_HDDL_CONFIG_KEY(BIND_DEVICE);
133 
134 /**
135  * @brief [Only for HDDLPlugin]
136  * Type: A signed int wrapped in a string, default is "0".
137  * This config is a sub-config of DEVICE_TAG, and only available when "DEVICE_TAG" is set and "BIND_DEVICE" is "False".
138  * When there are multiple devices running a certain network (a same network running on multiple devices in Bypass Scheduler),
139  * the device with a larger number has a higher priority, and more inference tasks will be fed to it with priority.
140  */
141 DECLARE_VPU_HDDL_CONFIG_KEY(RUNTIME_PRIORITY);
142 
143 /**
144  * @brief This option allows to pass extra configuration for executable network.
145  * By default, it is empty string, which means - no configuration.
146  * String format:
147  * <key>=<value>,<key>=<value>,...
148  * Supported parameters and options:
149  * * file : path to XML file with configuration
150  * * data : options related to data objects (input, output, intermediate), next parameter describes the option
151  * * scale : SCALE factor for data range (applicable for input and intermediate data)
152  */
153 DECLARE_VPU_CONFIG_KEY(NETWORK_CONFIG);
154 
155 /**
156  * @brief This option allows to to specify input output layouts for network layers.
157  * By default, this value set to VPU_CONFIG_VALUE(AUTO) value.
158  * Supported values:
159  * VPU_CONFIG_VALUE(AUTO) executable network configured to use optimal layer layout depending on available HW
160  * VPU_CONFIG_VALUE(NCHW) executable network forced to use NCHW input/output layouts
161  * VPU_CONFIG_VALUE(NHWC) executable network forced to use NHWC input/output layouts
162  */
163 DECLARE_VPU_CONFIG_KEY(COMPUTE_LAYOUT);
164 
165 /**
166  * @brief This option allows to pass custom layers binding xml.
167  * If layer is present in such an xml, it would be used during inference even if the layer is natively supported
168  */
169 DECLARE_VPU_CONFIG_KEY(CUSTOM_LAYERS);
170 
171 /**
172  * @brief Supported keys definition for VPU_CONFIG_KEY(COMPUTE_LAYOUT) option.
173  */
174 DECLARE_VPU_CONFIG_VALUE(AUTO);
175 DECLARE_VPU_CONFIG_VALUE(NCHW);
176 DECLARE_VPU_CONFIG_VALUE(NHWC);
177 
178 /**
179  * @brief This option allows to specify device.
180  * If specified device is not available then creating infer request will throw an exception.
181  */
182 DECLARE_VPU_CONFIG_KEY(PLATFORM);
183 
184 /**
185  * @brief Supported keys definition for VPU_CONFIG_KEY(PLATFORM) option.
186  */
187 DECLARE_VPU_CONFIG_VALUE(2450);
188 DECLARE_VPU_CONFIG_VALUE(2480);
189 
190 /**
191  * @brief Ignore statistic in IR by plugin.
192  * Plugin could use statistic present in IR in order to try to improve calculations precision.
193  * If you don't want statistic to be used enable this option.
194  * This option should be used with values: CONFIG_VALUE(YES) or CONFIG_VALUE(NO) (default)
195  */
196 DECLARE_VPU_CONFIG_KEY(IGNORE_IR_STATISTIC);
197 
198 } // namespace VPUConfigParams
199 } // namespace InferenceEngine
InferenceEngine
Definition: ie_argmax_layer.hpp:11
ie_plugin_config.hpp
a header for advanced hardware related properties for clDNN plugin To use in SetConfig() method of pl...