From 76ade7a7d0c08e8536f4cd516122e902ac87d0f8 Mon Sep 17 00:00:00 2001 From: Vitaliy Urusovskij Date: Fri, 18 Feb 2022 07:48:58 +0300 Subject: [PATCH] Update docstrings with information about static build (#10488) --- src/inference/include/ie/ie_core.hpp | 14 +++++++++----- src/inference/include/openvino/runtime/core.hpp | 13 ++++++++----- src/inference/src/ie_core.cpp | 4 ++-- 3 files changed, 19 insertions(+), 12 deletions(-) diff --git a/src/inference/include/ie/ie_core.hpp b/src/inference/include/ie/ie_core.hpp index a33ca43e9dc..b7253c25350 100644 --- a/src/inference/include/ie/ie_core.hpp +++ b/src/inference/include/ie/ie_core.hpp @@ -34,13 +34,17 @@ class INFERENCE_ENGINE_API_CLASS(Core) { std::shared_ptr _impl; public: - /** @brief Constructs Inference Engine Core instance using XML configuration file with - * plugins description. + /** @brief Constructs an OpenVINO Core instance with devices + * and their plugins description. * - * See RegisterPlugins for more details. + * There are two ways how to configure device plugins: + * 1. (default) Use XML configuration file in case of dynamic libraries build; + * 2. Use strictly defined configuration in case of static libraries build. * - * @param xmlConfigFile A path to .xml file with plugins to load from. If XML configuration file is not specified, - * then default Inference Engine plugins are loaded from the default plugin.xml file. + * @param xml_config_file Path to the .xml file with plugins to load from. If the XML configuration file is not + * specified, default OpenVINO Runtime plugins are loaded from: + * 1. (dynamic build) default `plugins.xml` file located in the same folder as OpenVINO runtime shared library; + * 2. (static build) statically defined configuration. In this case path to the .xml file is ignored. */ explicit Core(const std::string& xmlConfigFile = {}); diff --git a/src/inference/include/openvino/runtime/core.hpp b/src/inference/include/openvino/runtime/core.hpp index 90628bb49da..d22e071eb43 100644 --- a/src/inference/include/openvino/runtime/core.hpp +++ b/src/inference/include/openvino/runtime/core.hpp @@ -43,14 +43,17 @@ class OPENVINO_RUNTIME_API Core { std::shared_ptr _impl; public: - /** @brief Constructs an OpenVINO Core instance using the XML configuration file with - * devices and their plugins description. + /** @brief Constructs an OpenVINO Core instance with devices + * and their plugins description. * - * See Core::register_plugins for more details. + * There are two ways how to configure device plugins: + * 1. (default) Use XML configuration file in case of dynamic libraries build; + * 2. Use strictly defined configuration in case of static libraries build. * * @param xml_config_file Path to the .xml file with plugins to load from. If the XML configuration file is not - * specified, default OpenVINO Runtime plugins are loaded from the default `plugin.xml` file located in the same - * folder as OpenVINO runtime shared library. + * specified, default OpenVINO Runtime plugins are loaded from: + * 1. (dynamic build) default `plugins.xml` file located in the same folder as OpenVINO runtime shared library; + * 2. (static build) statically defined configuration. In this case path to the .xml file is ignored. */ explicit Core(const std::string& xml_config_file = {}); diff --git a/src/inference/src/ie_core.cpp b/src/inference/src/ie_core.cpp index fcf031c0dc1..fac529fc855 100644 --- a/src/inference/src/ie_core.cpp +++ b/src/inference/src/ie_core.cpp @@ -453,9 +453,9 @@ public: #ifdef OPENVINO_STATIC_LIBRARY /** - * @brief Register plugins for devices which are located in .xml configuration file. + * @brief Register plugins for devices using statically defined configuration * @note The function supports UNICODE path - * @param xmlConfigFile An .xml configuraion with device / plugin information + * @param static_registry a statically defined configuration with device / plugin information */ void RegisterPluginsInRegistry(const decltype(::getStaticPluginsRegistry())& static_registry) { std::lock_guard lock(pluginsMutex);