Skip to content

Commit 0817fbe

Browse files
authored
Add badges to readme (#285)
* Add badges to readme * Fix linter
1 parent b21024f commit 0817fbe

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# OpenVINO Model API
22

3+
[![PyPI](https://img.shields.io/pypi/v/otx)](https://pypi.org/project/openvino-model-api)
4+
[![Downloads](https://static.pepy.tech/personalized-badge/otx?period=total&units=international_system&left_color=grey&right_color=green&left_text=PyPI%20Downloads)](https://pepy.tech/project/openvino-model-api)
5+
6+
<!-- markdownlint-disable MD042 -->
7+
8+
[![openvino](https://img.shields.io/badge/openvino-2025.0-purple)]()
9+
10+
<!-- markdownlint-enable MD042 -->
11+
12+
[![Pre-Merge Test](https://github.com/open-edge-platform/model_api/actions/workflows/pre_commit.yml/badge.svg)](https://github.com/open-edge-platform/model_api/actions/workflows/pre_commit.yml)
13+
[![Build Docs](https://github.com/open-edge-platform/model_api/actions/workflows/docs.yml/badge.svg)](https://github.com/open-edge-platform/model_api/actions/workflows/docs.yml)
14+
15+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
16+
17+
## Introduction
18+
319
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.
420

521
## How it works
@@ -50,7 +66,7 @@ Training Extensions embed all the metadata required for inference into model fil
5066
cmake ../model_api/cpp -DOpenCV_DIR=<OpenCV cmake dir> -DOpenVINO_DIR=<OpenVINO cmake dir>
5167
```
5268

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

5571
- Build:
5672

0 commit comments

Comments
 (0)