openvino/inference-engine/include/vpu/vpu_plugin_config.hpp

160 lines
4.8 KiB
C++

// Copyright (C) 2018-2019 Intel Corporation
// SPDX-License-Identifier: Apache-2.0
//
/**
* @brief A header that defines advanced related properties for VPU plugins.
* These properties should be used in SetConfig() and LoadNetwork() methods of plugins
*
* @file vpu_plugin_config.hpp
*/
#pragma once
#include <string>
#include "ie_plugin_config.hpp"
#include "myriad_plugin_config.hpp"
#include "hddl_plugin_config.hpp"
#include "ie_api.h"
//
// Common options
//
#define VPU_CONFIG_KEY(name) InferenceEngine::VPUConfigParams::_CONFIG_KEY(VPU_##name)
#define VPU_CONFIG_VALUE(name) InferenceEngine::VPUConfigParams::VPU_##name
#define DECLARE_VPU_CONFIG_KEY(name) DECLARE_CONFIG_KEY(VPU_##name)
#define DECLARE_VPU_CONFIG_VALUE(name) DECLARE_CONFIG_VALUE(VPU_##name)
//
// Common metrics
//
#define VPU_METRIC(name) METRIC_KEY(VPU_##name)
#define DECLARE_VPU_METRIC(name, ...) DECLARE_METRIC_KEY(VPU_##name, __VA_ARGS__)
namespace InferenceEngine {
namespace VPUConfigParams {
//
// Common options
//
/**
* @brief Turn on HW stages usage (applicable for MyriadX devices only).
* This option should be used with values: CONFIG_VALUE(YES) or CONFIG_VALUE(NO) (default)
*/
DECLARE_VPU_CONFIG_KEY(HW_STAGES_OPTIMIZATION);
/**
* @brief The key to specify desirable log level for devices.
* This option should be used with values: CONFIG_VALUE(LOG_NONE) (default),
* CONFIG_VALUE(LOG_WARNING), CONFIG_VALUE(LOG_INFO), CONFIG_VALUE(LOG_DEBUG)
*/
DECLARE_VPU_CONFIG_KEY(LOG_LEVEL);
/**
* @deprecated
* @brief The key to define normalization coefficient for the network input.
* This option should used with be a real number. Example "255.f"
*/
INFERENCE_ENGINE_DEPRECATED
DECLARE_VPU_CONFIG_KEY(INPUT_NORM);
/**
* @deprecated
* @brief The flag to specify Bias value that is added to each element of the network input.
* This option should used with be a real number. Example "0.1f"
*/
INFERENCE_ENGINE_DEPRECATED
DECLARE_VPU_CONFIG_KEY(INPUT_BIAS);
/**
* @brief The flag for adding to the profiling information the time of obtaining a tensor.
* This option should be used with values: CONFIG_VALUE(YES) or CONFIG_VALUE(NO) (default)
*/
DECLARE_VPU_CONFIG_KEY(PRINT_RECEIVE_TENSOR_TIME);
/**
* @brief This option allows to pass extra configuration for executable network.
* By default, it is empty string, which means - no configuration.
* String format:
* <key>=<value>,<key>=<value>,...
* Supported parameters and options:
* * file : path to XML file with configuration
* * data : options related to data objects (input, output, intermediate), next parameter describes the option
* * scale : SCALE factor for data range (applicable for input and intermediate data)
*/
DECLARE_VPU_CONFIG_KEY(NETWORK_CONFIG);
/**
* @brief This option allows to to specify input output layouts for network layers.
* By default, this value set to VPU_CONFIG_VALUE(AUTO) value.
* Supported values:
* VPU_CONFIG_VALUE(AUTO) executable network configured to use optimal layer layout depending on available HW
* VPU_CONFIG_VALUE(NCHW) executable network forced to use NCHW input/output layouts
* VPU_CONFIG_VALUE(NHWC) executable network forced to use NHWC input/output layouts
*/
DECLARE_VPU_CONFIG_KEY(COMPUTE_LAYOUT);
/**
* @brief Supported keys definition for VPU_CONFIG_KEY(COMPUTE_LAYOUT) option.
*/
DECLARE_VPU_CONFIG_VALUE(AUTO);
DECLARE_VPU_CONFIG_VALUE(NCHW);
DECLARE_VPU_CONFIG_VALUE(NHWC);
DECLARE_VPU_CONFIG_VALUE(NCDHW);
DECLARE_VPU_CONFIG_VALUE(NDHWC);
/**
* @brief This option allows to pass custom layers binding xml.
* If layer is present in such an xml, it would be used during inference even if the layer is natively supported
*/
DECLARE_VPU_CONFIG_KEY(CUSTOM_LAYERS);
/**
* @brief Ignore statistic in IR by plugin.
* Plugin could use statistic present in IR in order to try to improve calculations precision.
* If you don't want statistic to be used enable this option.
* This option should be used with values: CONFIG_VALUE(YES) or CONFIG_VALUE(NO) (default)
*/
DECLARE_VPU_CONFIG_KEY(IGNORE_IR_STATISTIC);
/**
* @brief This option allows to specify protocol.
*/
DECLARE_VPU_MYRIAD_CONFIG_KEY(PROTOCOL);
/**
* @brief Supported keys definition for VPU_MYRIAD_CONFIG_KEY(PROTOCOL) option.
*/
DECLARE_VPU_MYRIAD_CONFIG_VALUE(PCIE);
DECLARE_VPU_MYRIAD_CONFIG_VALUE(USB);
/**
* @deprecated Use VPU_MYRIAD_CONFIG_KEY(FORCE_RESET) instead.
*/
INFERENCE_ENGINE_DEPRECATED
DECLARE_VPU_CONFIG_KEY(FORCE_RESET);
/**
* @deprecated Use VPU_MYRIAD_CONFIG_KEY(PLATFORM) instead.
*/
INFERENCE_ENGINE_DEPRECATED
DECLARE_VPU_CONFIG_KEY(PLATFORM);
/**
* @brief Supported keys definition for DECLARE_VPU_CONFIG_KEY(PLATFORM) option.
*/
INFERENCE_ENGINE_DEPRECATED
DECLARE_VPU_CONFIG_VALUE(2450);
INFERENCE_ENGINE_DEPRECATED
DECLARE_VPU_CONFIG_VALUE(2480);
} // namespace VPUConfigParams
} // namespace InferenceEngine