Skip to content

Commit 7f3dd6c

Browse files
committed
Quote OTX as a models source
1 parent 9fb1432 commit 7f3dd6c

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
# OpenVINO Model API
22

3-
Model API is a set of wrapper classes for particular tasks and model architectures, simplifying data preprocess and postprocess as well as routine procedures (model loading, asynchronous execution, etc.). It is aimed at simplifying end-to-end model inference for different deployment scenarious, including local execution and serving. The Model API is based on the OpenVINO inference API.
3+
Model API is a set of wrapper classes for particular tasks and model architectures, simplifying data preprocess and postprocess as well as routine procedures (model loading, asynchronous execution, etc.). It is aimed at simplifying end-to-end model inference for different deployment scenarios, including local execution and serving. The Model API is based on the OpenVINO inference API.
44

55
## How it works
66

77
Model API searches for additional information required for model inference, data, pre/postprocessing, label names, etc. directly in OpenVINO Intermediate Representation. This information is used to prepare the inference data, process and output the inference results in a human-readable format.
88

9+
Currently, ModelAPI supports models trained in [OpenVINO Training Extensions](https://github.com/openvinotoolkit/training_extensions) framework.
10+
Training Extensions embed all the metadata required for inference into model file. For models coming from other than Training Extensions frameworks metadata generation step is required before using ModelAPI.
11+
12+
## Supported model formats
13+
14+
- [OpenVINO IR](https://docs.openvino.ai/2025/documentation/openvino-ir-format.html)
15+
- [ONNX](https://onnx.ai)
16+
917
## Features
1018

1119
- Python and C++ API
@@ -42,7 +50,7 @@ Model API searches for additional information required for model inference, data
4250
cmake ../model_api/cpp -DOpenCV_DIR=<OpenCV cmake dir> -DOpenVINO_DIR=<OpenVINO cmake dir>
4351
```
4452

45-
`OpenCV` location is optional. In most cases, system OpenCV is discovered by cmake without extra guidance.
53+
`OpenCV` and `OpenVINO` locations are optional. In most cases, system these dependencies are discovered by cmake without extra guidance.
4654

4755
- Build:
4856

@@ -63,7 +71,7 @@ cmake --build . --target package -j
6371
```python
6472
from model_api.models import Model
6573

66-
# Create a model wrapper from a compatible model converted to OV format
74+
# Create a model wrapper from a compatible model generated by OpenVINO Training Extensions
6775
# Use URL to work with OVMS-served model, e.g. "localhost:9000/models/ssdlite_mobilenet_v2"
6876
model = Model.create_model("model.xml")
6977

0 commit comments

Comments
 (0)