Skip to content

Commit

Permalink
Updated Core::ReadNetwork documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyachur committed Jul 3, 2020
1 parent b72e56e commit 5bfba54
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions inference-engine/include/ie_core.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,13 @@ class INFERENCE_ENGINE_API_CLASS(Core) {

#ifdef ENABLE_UNICODE_PATH_SUPPORT
/**
* @brief Reads IR xml and bin files
* @param modelPath path to IR file
* @param binPath path to bin file, if path is empty, will try to read bin file with the same name as xml and
* if bin file with the same name was not found, will load IR without weights.
* @brief Reads models from IR and ONNX formats
* @param modelPath path to model
* @param binPath path to data file
* For IR format (*.bin):
* * if path is empty, will try to read bin file with the same name as xml and
* * if bin file with the same name was not found, will load IR without weights.
* ONNX models with data files are not supported
* @return CNNNetwork
*/
CNNNetwork ReadNetwork(const std::wstring& modelPath, const std::wstring& binPath = {}) const {
Expand All @@ -85,17 +88,22 @@ class INFERENCE_ENGINE_API_CLASS(Core) {
#endif

/**
* @brief Reads IR xml and bin files
* @param modelPath path to IR file
* @param binPath path to bin file, if path is empty, will try to read bin file with the same name as xml and
* if bin file with the same name was not found, will load IR without weights.
* @brief Reads models from IR and ONNX formats
* @param modelPath path to model
* @param binPath path to data file
* For IR format (*.bin):
* * if path is empty, will try to read bin file with the same name as xml and
* * if bin file with the same name was not found, will load IR without weights.
* ONNX models with data files are not supported
* @return CNNNetwork
*/
CNNNetwork ReadNetwork(const std::string& modelPath, const std::string& binPath = {}) const;
/**
* @brief Reads IR xml and bin (with the same name) files
* @param model string with IR
* @brief Reads models from IR and ONNX formats
* @param model string with model in IR or ONNX format
* @param weights shared pointer to constant blob with weights
* ONNX models doesn't support models with data blobs.
* For ONNX case the second parameter should contain empty blob.
* @return CNNNetwork
*/
CNNNetwork ReadNetwork(const std::string& model, const Blob::CPtr& weights) const;
Expand Down

0 comments on commit 5bfba54

Please sign in to comment.