From f07b2b3a42da36963d4c1548e095c459a7a26c23 Mon Sep 17 00:00:00 2001 From: Vladisalv Sovrasov Date: Wed, 9 Apr 2025 00:48:39 +0900 Subject: [PATCH 1/2] Add badges to readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c33eda0..ab3ab73e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # OpenVINO Model API +[![PyPI](https://img.shields.io/pypi/v/otx)](https://pypi.org/project/openvino-model-api) +[![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) + +[![openvino](https://img.shields.io/badge/openvino-2025.0-purple)]() + +[![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) +[![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) + +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +## Introduction + 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. ## How it works @@ -50,7 +62,7 @@ Training Extensions embed all the metadata required for inference into model fil cmake ../model_api/cpp -DOpenCV_DIR= -DOpenVINO_DIR= ``` -`OpenCV` and `OpenVINO` locations are optional. In most cases, system these dependencies are discovered by cmake without extra guidance. +`OpenCV` and `OpenVINO` locations are optional. In most cases, these dependencies are discovered by cmake without extra guidance. - Build: From 917354dc74931b0f591b5e00c079e2a66bd8f8e1 Mon Sep 17 00:00:00 2001 From: Vladisalv Sovrasov Date: Wed, 9 Apr 2025 00:55:09 +0900 Subject: [PATCH 2/2] Fix linter --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index ab3ab73e..d260a4a5 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,13 @@ [![PyPI](https://img.shields.io/pypi/v/otx)](https://pypi.org/project/openvino-model-api) [![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) + + [![openvino](https://img.shields.io/badge/openvino-2025.0-purple)]() + + [![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) [![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)