ovkit 0.1.0__tar.gz

ovkit-0.1.0/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/**/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

ovkit-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ovkit contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ovkit-0.1.0/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.5
+Name: ovkit
+Version: 0.1.0
+Summary: A simple Python inference API for OpenVINO: one import, one Model class, clean Results — with AUTO/NPU, async, and INT8.
+Project-URL: Homepage, https://github.com/leeyunjai82/ovkit
+Project-URL: Documentation, https://leeyunjai82.github.io/ovkit/
+Project-URL: Repository, https://github.com/leeyunjai82/ovkit
+Project-URL: Issues, https://github.com/leeyunjai82/ovkit/issues
+Project-URL: Models, https://huggingface.co/leeyunjai/ovkit-models
+Author: ovkit contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: computer-vision,detection,inference,npu,openvino,quantization
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: huggingface-hub>=0.20
+Requires-Dist: numpy>=1.21
+Requires-Dist: opencv-python-headless>=4.5
+Requires-Dist: openvino>=2024.0
+Requires-Dist: pillow>=9.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: all
+Requires-Dist: anomalib; extra == 'all'
+Requires-Dist: nncf; extra == 'all'
+Requires-Dist: openvino-genai; extra == 'all'
+Requires-Dist: optimum-intel; extra == 'all'
+Provides-Extra: anomaly
+Requires-Dist: anomalib; extra == 'anomaly'
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: genai
+Requires-Dist: openvino-genai; extra == 'genai'
+Requires-Dist: optimum-intel; extra == 'genai'
+Provides-Extra: quant
+Requires-Dist: nncf; extra == 'quant'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+<img src="docs/_static/logo.svg" width="110" alt="ovkit logo"/>
+
+# ovkit
+
+**OpenVINO inference in 3 lines.** One `Model` class, clean `Results`, 30+
+ready models — with `AUTO`/`NPU`/`GPU` devices, async throughput, and INT8.
+
+[![CI](https://github.com/leeyunjai82/ovkit/actions/workflows/ci.yml/badge.svg)](https://github.com/leeyunjai82/ovkit/actions/workflows/ci.yml)
+[![Docs](https://img.shields.io/badge/docs-github.io-0a7d8c)](https://leeyunjai82.github.io/ovkit/)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue)](pyproject.toml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-green)](LICENSE)
+[![Models](https://img.shields.io/badge/🤗%20models-ovkit--models-yellow)](https://huggingface.co/leeyunjai/ovkit-models)
+<!-- After the first PyPI release, add:
+[![PyPI](https://img.shields.io/pypi/v/ovkit)](https://pypi.org/project/ovkit/) -->
+
+[Docs](https://leeyunjai82.github.io/ovkit/) ·
+[한국어 문서](https://leeyunjai82.github.io/ovkit/ko/) ·
+[Model catalog](https://leeyunjai82.github.io/ovkit/models.html) ·
+[Examples](examples/)
+
+</div>
+
+```python
+from ovkit import Model
+
+r = Model("detect")("image.jpg")[0]   # download -> convert -> cache -> run
+r.save("out.jpg")                     # boxes drawn; r.boxes.xyxy / .conf / .cls
+```
+
+<!-- Demo GIF: record `python examples/webcam_demo.py` (or the web app) and
+     place it at docs/_static/demo.gif, then uncomment:
+<div align="center"><img src="docs/_static/demo.gif" width="640" alt="ovkit demo"/></div> -->
+
+Or without writing Python at all:
+
+```bash
+ovkit run detect image.jpg            # prints results, saves image_out.jpg
+```
+
+## Install
+
+```bash
+git clone https://github.com/leeyunjai82/ovkit.git && cd ovkit
+python -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
+pip install -e .
+```
+
+<!-- After the first PyPI release this becomes just: pip install ovkit -->
+Extras: `".[quant]"` (INT8/NNCF) · `".[genai]"` (LLM/STT) · `".[all]"`.
+Python 3.10+.
+
+## Supported tasks
+
+Every task below runs end-to-end through the same 3 lines — swap the alias:
+
+| Task | Alias | Output | Example |
+| ---- | ----- | ------ | ------- |
+| Object detection | `detect`, `face_detection`, `person_detection`, `vehicle_detection`, `text_detection`, `license_plate` | `r.boxes` | [detect.py](examples/detect.py) |
+| Classification | `classify`, `person_attributes`, `vehicle_attributes` | `r.probs` / text | [classify.py](examples/classify.py) |
+| Segmentation | `segment`, `instance_segmentation` | `r.masks` | [segment.py](examples/segment.py) |
+| Pose / landmarks | `pose`, `face_landmarks` | `r.keypoints` | [pose.py](examples/pose.py) |
+| Face analysis | `age_gender`, `emotion`, `head_pose`, `face_reid` | `r.text` (e.g. `"age 31 · male 98%"`) | [face_analysis.py](examples/face_analysis.py) |
+| OCR | `text_recognition` | `r.text` | [ocr.py](examples/ocr.py) |
+| Super-resolution | `super_resolution` | upscaled image via `r.plot()` | [super_resolution.py](examples/super_resolution.py) |
+| LLM / STT (GenAI) | `llm`, `stt` | generated text | [llm.py](examples/llm.py) / [stt.py](examples/stt.py) |
+| NLP / audio / time series | `qa`, `translation`, `noise_suppression`, `time_series` | tensors via `model.infer()` | [denoise_audio.py](examples/denoise_audio.py) |
+
+The registry exposes **one well-tested model per capability (35 total)**; the
+[HF mirror](https://huggingface.co/leeyunjai/ovkit-models) hosts the full
+Apache-2.0 OMZ set (other tiers, `int8`, `sparse` variants) — surfacing a
+variant is a one-line edit ([catalog](https://leeyunjai82.github.io/ovkit/models.html)).
+`ovkit list` shows everything with descriptions.
+
+## Devices
+
+| Device | How | Notes |
+| ------ | --- | ----- |
+| **AUTO** (default) | `Model("detect")` | OpenVINO picks the best device |
+| **CPU** | `Model("detect", device="CPU")` | works everywhere |
+| **GPU** | `device="GPU"` | Intel iGPU / Arc |
+| **NPU** | `device="NPU"` | Intel® Core™ Ultra AI accelerator |
+
+Single images run synchronously; `stream=True` uses an `AsyncInferQueue` for
+video/webcam throughput. INT8: `model.quantize(calib_images)` (NNCF).
+
+### Benchmarks
+
+```bash
+python scripts/benchmark.py        # prints a paste-ready CPU/GPU/NPU table
+```
+
+<!-- BENCHMARKS: run scripts/benchmark.py on your Intel hardware and paste the
+     generated Markdown table here (model x device, median ms + FPS). -->
+
+## Usage
+
+<details open>
+<summary><b>Python</b></summary>
+
+```python
+from ovkit import Model
+
+model = Model("face_detection")              # alias, name, .xml, or .onnx
+results = model("photo.jpg", conf=0.25)      # image / ndarray / folder / video
+for r in model.predict(0, stream=True):      # webcam (lazy generator)
+    annotated = r.plot()
+
+print(Model("age_gender")("face.jpg")[0].text)   # "age 31 · male 98%"
+```
+
+Inputs are **auto-detected**: image path / `ndarray` / folder / video / camera
+index → vision pipeline; `.npy` / `.wav` → raw inference. Grayscale models and
+all-image multi-input models (super-resolution) are handled automatically. Full
+control for any model: `model.infer({name: tensor})` with `model.inputs`.
+
+| `Results` | holds |
+| --------- | ----- |
+| `r.boxes` | `xyxy`, `xywh`, `conf`, `cls` |
+| `r.masks` / `r.keypoints` / `r.probs` | masks · `[x,y,conf]` · `top1`/`top5` |
+| `r.text` | decoded text (OCR, face attributes) |
+| `r.tensors` | raw `{name: ndarray}` |
+| `r.plot()` / `r.save(path)` | annotated image (or the model's output image) |
+
+</details>
+
+<details>
+<summary><b>CLI</b></summary>
+
+```bash
+ovkit run detect image.jpg --save out.jpg   # one-shot inference
+ovkit run age_gender face.jpg --device NPU
+ovkit list                                  # aliases + models with descriptions
+ovkit info face_detection                   # source / task / license
+ovkit download detect                       # warm the cache
+ovkit devices                               # available OpenVINO devices
+```
+
+</details>
+
+<details>
+<summary><b>GenAI (LLM / speech-to-text)</b></summary>
+
+```python
+from ovkit.genai import pipeline
+
+llm = pipeline("llm")                        # tinyllama_chat from the mirror
+print(llm.generate("Explain OpenVINO in one sentence.", max_new_tokens=64))
+
+stt = pipeline("stt")                        # whisper_base
+print(stt.generate(audio_16k_mono_float32))
+```
+
+Needs `pip install -e ".[genai]"`.
+
+</details>
+
+<details>
+<summary><b>Web demo (image / webcam / audio / text)</b></summary>
+
+```bash
+pip install -r examples/requirements.txt
+python examples/web_app.py                   # http://127.0.0.1:8000
+```
+
+Pick any model — the right input (upload / webcam / audio / text) appears
+automatically and results render with overlays.
+
+</details>
+
+## Adding a model
+
+Models are data, not code — one manifest entry
+(`src/ovkit/manifests/`):
+
+```yaml
+my_model:
+  src: hf
+  repo: leeyunjai/ovkit-models
+  filename: detect/my_model/model.xml
+  task: detect
+  description: Shown by `ovkit list`.
+  license: apache-2.0            # must be permissive — enforced at load time
+```
+
+Resolution: alias → local path → cache (`~/.cache/ovkit`) → download → convert
+→ cache, with atomic writes, `sha256` checks, upstream `fallback`, and
+`OVKIT_OFFLINE=1`. Maintainer tooling (mirror build / verify / self-check /
+benchmark) lives in [`scripts/`](scripts/) — see the
+[guide](https://leeyunjai82.github.io/ovkit/guide.html).
+
+## License
+
+ovkit is [Apache-2.0](LICENSE) and **license-clean by design**: only permissive
+(Apache/MIT/BSD) models and libraries — no AGPL model stacks, no non-commercial
+weights; every manifest entry must declare a permissive license (enforced at
+load time).