IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added deprecation messages to docs for ExecutableNetwork (#5201)

Browse Source
This commit is contained in:
Ilya Lavrenov 2021-04-14 06:05:41 +03:00 committed by GitHub
parent 070201feee
commit 3bbc9d2837
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
inference-engine/include/cpp/ie_executable_network.hpp
View File

@ -3,10 +3,11 @@
// //
/** /**
* @brief A header file that provides wrapper classes for IExecutableNetwork * @brief A header file that provides ExecutableNetwork class
* *
* @file ie_executable_network.hpp * @file ie_executable_network.hpp
*/ */
#pragma once #pragma once
#include <map> #include <map>
@ -18,6 +19,7 @@
#include "cpp/ie_infer_request.hpp" #include "cpp/ie_infer_request.hpp"
namespace InferenceEngine { namespace InferenceEngine {
namespace details { namespace details {
class SharedObjectLoader; class SharedObjectLoader;
} }
@ -72,12 +74,13 @@ public:
ConstInputsDataMap GetInputsInfo() const; ConstInputsDataMap GetInputsInfo() const;
/** /**
* @deprecated The method Will be removed
* @brief reset owned object to new pointer. * @brief reset owned object to new pointer.
* *
* Essential for cases when simultaneously loaded networks not expected. * Essential for cases when simultaneously loaded networks not expected.
* @param newActual actual pointed object * @param newActual actual pointed object
*/ */
INFERENCE_ENGINE_DEPRECATED("Will be removed") INFERENCE_ENGINE_DEPRECATED("The method will be removed")
void reset(std::shared_ptr<IExecutableNetwork> newActual); void reset(std::shared_ptr<IExecutableNetwork> newActual);
/** /**
@ -90,12 +93,13 @@ public:
InferRequest CreateInferRequest(); InferRequest CreateInferRequest();
/** /**
* @deprecated Use ExecutableNetwork::CreateInferRequest
* @copybrief IExecutableNetwork::CreateInferRequest * @copybrief IExecutableNetwork::CreateInferRequest
* *
* Wraps IExecutableNetwork::CreateInferRequest. * Wraps IExecutableNetwork::CreateInferRequest.
* @return shared pointer on InferenceEngine::InferRequest object * @return shared pointer on InferenceEngine::InferRequest object
*/ */
INFERENCE_ENGINE_DEPRECATED("Use CreateInferRequest") INFERENCE_ENGINE_DEPRECATED("Use ExecutableNetwork::CreateInferRequest instead")
InferRequest::Ptr CreateInferRequestPtr(); InferRequest::Ptr CreateInferRequestPtr();
/** /**
@ -117,10 +121,11 @@ public:
void Export(std::ostream& networkModel); void Export(std::ostream& networkModel);
/** /**
* @deprecated Will be removed. Use operator bool
* @brief cast operator is used when this wrapper initialized by LoadNetwork * @brief cast operator is used when this wrapper initialized by LoadNetwork
* @return A shared pointer to IExecutableNetwork interface. * @return A shared pointer to IExecutableNetwork interface.
*/ */
INFERENCE_ENGINE_DEPRECATED("Will be removed") INFERENCE_ENGINE_DEPRECATED("The method will be removed. Use operator bool")
operator std::shared_ptr<IExecutableNetwork>(); operator std::shared_ptr<IExecutableNetwork>();
/** /**
@ -185,6 +190,7 @@ public:
* @return true if current ExecutableNetwork object is not initialized, false - otherwise * @return true if current ExecutableNetwork object is not initialized, false - otherwise
*/ */
bool operator!() const noexcept; bool operator!() const noexcept;
/** /**
* @brief Checks if current ExecutableNetwork object is initialized * @brief Checks if current ExecutableNetwork object is initialized
* @return true if current ExecutableNetwork object is initialized, false - otherwise * @return true if current ExecutableNetwork object is initialized, false - otherwise