Updated Core::ReadNetwork documentation (#1178)

This commit is contained in:
Ilya Churaev 2020-07-03 08:47:24 +03:00 committed by GitHub
parent bd25d5174f
commit ac2ce80dae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -73,10 +73,13 @@ public:
#ifdef ENABLE_UNICODE_PATH_SUPPORT #ifdef ENABLE_UNICODE_PATH_SUPPORT
/** /**
* @brief Reads IR xml and bin files * @brief Reads models from IR and ONNX formats
* @param modelPath path to IR file * @param modelPath path to model
* @param binPath path to bin file, if path is empty, will try to read bin file with the same name as xml and * @param binPath path to data file
* if bin file with the same name was not found, will load IR without weights. * 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 * @return CNNNetwork
*/ */
CNNNetwork ReadNetwork(const std::wstring& modelPath, const std::wstring& binPath = {}) const { CNNNetwork ReadNetwork(const std::wstring& modelPath, const std::wstring& binPath = {}) const {
@ -85,17 +88,22 @@ public:
#endif #endif
/** /**
* @brief Reads IR xml and bin files * @brief Reads models from IR and ONNX formats
* @param modelPath path to IR file * @param modelPath path to model
* @param binPath path to bin file, if path is empty, will try to read bin file with the same name as xml and * @param binPath path to data file
* if bin file with the same name was not found, will load IR without weights. * 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 * @return CNNNetwork
*/ */
CNNNetwork ReadNetwork(const std::string& modelPath, const std::string& binPath = {}) const; CNNNetwork ReadNetwork(const std::string& modelPath, const std::string& binPath = {}) const;
/** /**
* @brief Reads IR xml and bin (with the same name) files * @brief Reads models from IR and ONNX formats
* @param model string with IR * @param model string with model in IR or ONNX format
* @param weights shared pointer to constant blob with weights * @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 * @return CNNNetwork
*/ */
CNNNetwork ReadNetwork(const std::string& model, const Blob::CPtr& weights) const; CNNNetwork ReadNetwork(const std::string& model, const Blob::CPtr& weights) const;