UniFace: A Unified Face Analysis Library for Python | Detection, alignment, landmarks, face-mesh, recognition, parsing, gaze, attributes and anti-spoofing under one API.
Python computer-visiondeep-learningface-alignmentface-analysisface-anonymizationface-anti-spoofingface-attributesface-detectionface-meshface-parsingface-quality-assessmentface-recognitionface-segmentationface-trackingfacial-landmarksgaze-estimationhead-pose-estimationonnxruntimeportrait-mattingpython
chore: Minor changes to workflow names and docs (#111)
Yakhyokhuja Valikhujaev0eb042425cf2
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.ymlindex 43824a0..026b040 100644--- a/.github/workflows/ci.yml+++ b/.github/workflows/ci.yml@@ -1,4 +1,4 @@-name: Build+name: CIon:push:diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.ymlindex 33b71bb..096d963 100644--- a/.github/workflows/docs.yml+++ b/.github/workflows/docs.yml@@ -1,8 +1,8 @@-name: Deploy docs+name: Deploy Documentationon:release:- types: [released] # Fires only for stable releases (not pre-releases), after publish.yml creates the Release+ types: [released]workflow_dispatch:permissions:@@ -14,7 +14,7 @@ jobs:steps:- uses: actions/checkout@v4with:- fetch-depth: 0 # Fetch full history for git-committers and git-revision-date plugins+ fetch-depth: 0- uses: actions/setup-python@v5with:diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.ymlindex 4312a50..52b2e42 100644--- a/.github/workflows/publish.yml+++ b/.github/workflows/publish.yml@@ -3,7 +3,7 @@ name: Publish to PyPIon:push:tags:- - "v*.*.*" # Trigger only on version tags like v0.1.9+ - "v*.*.*"concurrency:group: ${{ github.workflow }}-${{ github.ref }}diff --git a/README.md b/README.mdindex e15c7a7..f580892 100644--- a/README.md+++ b/README.md@@ -1,4 +1,4 @@-<h1 align="center">UniFace: All-in-One Face Analysis Library</h1>+<h1 align="center">UniFace: A Unified Face Analysis Library for Python</h1><div align="center">@@ -14,12 +14,12 @@</div><div align="center">- <img src="https://raw.githubusercontent.com/yakhyo/uniface/main/.github/logos/uniface_rounded_q80.webp" width="90%" alt="UniFace - All-in-One Open-Source Face Analysis Library">+ <img src="https://raw.githubusercontent.com/yakhyo/uniface/main/.github/logos/uniface_rounded_q80.webp" width="90%" alt="UniFace - A Unified Face Analysis Library for Python"></div>----**UniFace** is a lightweight, production-ready face analysis library built on ONNX Runtime. It provides high-performance face detection, recognition, landmark detection, face parsing, gaze estimation, and attribute analysis with hardware acceleration support across platforms.+**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.---@@ -226,7 +226,7 @@ cv2.imwrite("green_screen.jpg", result)| [02_face_alignment.ipynb](examples/02_face_alignment.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/02_face_alignment.ipynb) | Face alignment for recognition || [03_face_verification.ipynb](examples/03_face_verification.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/03_face_verification.ipynb) | Compare faces for identity || [04_face_search.ipynb](examples/04_face_search.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/04_face_search.ipynb) | Find a person in group photos |-| [05_face_analyzer.ipynb](examples/05_face_analyzer.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/05_face_analyzer.ipynb) | All-in-one analysis |+| [05_face_analyzer.ipynb](examples/05_face_analyzer.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/05_face_analyzer.ipynb) | Unified face analysis || [06_face_parsing.ipynb](examples/06_face_parsing.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/06_face_parsing.ipynb) | Semantic face segmentation || [07_face_anonymization.ipynb](examples/07_face_anonymization.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/07_face_anonymization.ipynb) | Privacy-preserving blur || [08_gaze_estimation.ipynb](examples/08_gaze_estimation.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/08_gaze_estimation.ipynb) | Gaze direction estimation |diff --git a/docs/concepts/overview.md b/docs/concepts/overview.mdindex df60408..4146ca5 100644--- a/docs/concepts/overview.md+++ b/docs/concepts/overview.md@@ -64,16 +64,14 @@ graph TB## Design Principles-### 1. ONNX-First+### 1. Cross-Platform Inference-UniFace runs inference primarily via ONNX Runtime for core components:+UniFace uses portable model runtimes to provide consistent inference across macOS, Linux, and Windows. Most core components run through ONNX Runtime, while optional components may use PyTorch where appropriate.- **Cross-platform**: Same models work on macOS, Linux, Windows- **Hardware acceleration**: Automatic selection of optimal provider- **Production-ready**: No Python-only dependencies for inference-Some optional components (e.g., emotion TorchScript, torchvision NMS) require PyTorch.-### 2. Minimal DependenciesCore dependencies are kept minimal:diff --git a/docs/index.md b/docs/index.mdindex bbe743e..0d48c0c 100644--- a/docs/index.md+++ b/docs/index.md@@ -10,7 +10,7 @@ template: home.html# UniFace { .hero-title }-<p class="hero-subtitle">All-in-One Open-Source Face Analysis Library</p>+<p class="hero-subtitle">A Unified Face Analysis Library for Python</p>[](https://pypi.org/project/uniface/)[](https://www.python.org/)@@ -20,7 +20,7 @@ template: home.html[](https://www.kaggle.com/yakhyokhuja/code)[](https://discord.gg/wdzrjr7R5j)-<!-- <img src="https://raw.githubusercontent.com/yakhyo/uniface/main/.github/logos/uniface_rounded_q80.webp" alt="UniFace - All-in-One Open-Source Face Analysis Library" style="max-width: 70%; margin: 1rem 0;"> -->+<!-- <img src="https://raw.githubusercontent.com/yakhyo/uniface/main/.github/logos/uniface_rounded_q80.webp" alt="UniFace - A Unified Face Analysis Library for Python" style="max-width: 70%; margin: 1rem 0;"> -->[Get Started](quickstart.md){ .md-button .md-button--primary }[View on GitHub](https://github.com/yakhyo/uniface){ .md-button }@@ -31,7 +31,7 @@ template: home.html<div class="feature-card" markdown>### :material-face-recognition: Face Detection-ONNX-optimized detectors (RetinaFace, SCRFD, YOLO) with 5-point landmarks.+RetinaFace, SCRFD, and YOLO detectors with 5-point landmarks.</div><div class="feature-card" markdown>@@ -90,7 +90,7 @@ FAISS-backed embedding store for fast multi-identity face search.## Installation-UniFace runs inference primarily via **ONNX Runtime**; some optional components (e.g., emotion TorchScript, torchvision NMS) require **PyTorch**.+UniFace uses portable model runtimes for consistent inference across macOS, Linux, and Windows. Most core components run through **ONNX Runtime**, while optional components may use **PyTorch** where appropriate.**CPU / Apple Silicon**```bashdiff --git a/docs/notebooks.md b/docs/notebooks.mdindex 3f5add0..31e450d 100644--- a/docs/notebooks.md+++ b/docs/notebooks.md@@ -12,7 +12,7 @@ Run UniFace examples directly in your browser with Google Colab, or download and| [Face Alignment](https://github.com/yakhyo/uniface/blob/main/examples/02_face_alignment.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/02_face_alignment.ipynb) | Align faces for recognition || [Face Verification](https://github.com/yakhyo/uniface/blob/main/examples/03_face_verification.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/03_face_verification.ipynb) | Compare faces for identity || [Face Search](https://github.com/yakhyo/uniface/blob/main/examples/04_face_search.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/04_face_search.ipynb) | Find a person in group photos |-| [Face Analyzer](https://github.com/yakhyo/uniface/blob/main/examples/05_face_analyzer.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/05_face_analyzer.ipynb) | All-in-one face analysis |+| [Face Analyzer](https://github.com/yakhyo/uniface/blob/main/examples/05_face_analyzer.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/05_face_analyzer.ipynb) | Unified face analysis || [Face Parsing](https://github.com/yakhyo/uniface/blob/main/examples/06_face_parsing.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/06_face_parsing.ipynb) | Semantic face segmentation || [Face Anonymization](https://github.com/yakhyo/uniface/blob/main/examples/07_face_anonymization.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/07_face_anonymization.ipynb) | Privacy-preserving blur || [Gaze Estimation](https://github.com/yakhyo/uniface/blob/main/examples/08_gaze_estimation.ipynb) | [](https://colab.research.google.com/github/yakhyo/uniface/blob/main/examples/08_gaze_estimation.ipynb) | Gaze direction estimation |diff --git a/examples/01_face_detection.ipynb b/examples/01_face_detection.ipynbindex dda052f..eead195 100644--- a/examples/01_face_detection.ipynb+++ b/examples/01_face_detection.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/02_face_alignment.ipynb b/examples/02_face_alignment.ipynbindex bc07a21..cecb754 100644--- a/examples/02_face_alignment.ipynb+++ b/examples/02_face_alignment.ipynb@@ -17,7 +17,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/03_face_verification.ipynb b/examples/03_face_verification.ipynbindex 0bb8360..f6585a2 100644--- a/examples/03_face_verification.ipynb+++ b/examples/03_face_verification.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/04_face_search.ipynb b/examples/04_face_search.ipynbindex a6c1ac7..9fabede 100644--- a/examples/04_face_search.ipynb+++ b/examples/04_face_search.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/05_face_analyzer.ipynb b/examples/05_face_analyzer.ipynbindex a0b1998..de71b14 100644--- a/examples/05_face_analyzer.ipynb+++ b/examples/05_face_analyzer.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/06_face_parsing.ipynb b/examples/06_face_parsing.ipynbindex 1e8b153..ac024a8 100644--- a/examples/06_face_parsing.ipynb+++ b/examples/06_face_parsing.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/07_face_anonymization.ipynb b/examples/07_face_anonymization.ipynbindex cd08cb0..af35317 100644--- a/examples/07_face_anonymization.ipynb+++ b/examples/07_face_anonymization.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/08_gaze_estimation.ipynb b/examples/08_gaze_estimation.ipynbindex f4756ae..f947119 100644--- a/examples/08_gaze_estimation.ipynb+++ b/examples/08_gaze_estimation.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/09_face_segmentation.ipynb b/examples/09_face_segmentation.ipynbindex 7ebdcaf..3619766 100644--- a/examples/09_face_segmentation.ipynb+++ b/examples/09_face_segmentation.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/10_face_vector_store.ipynb b/examples/10_face_vector_store.ipynbindex c807aac..d9b3de6 100644--- a/examples/10_face_vector_store.ipynb+++ b/examples/10_face_vector_store.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/11_head_pose_estimation.ipynb b/examples/11_head_pose_estimation.ipynbindex 9c48fb5..939cc92 100644--- a/examples/11_head_pose_estimation.ipynb+++ b/examples/11_head_pose_estimation.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/12_face_recognition.ipynb b/examples/12_face_recognition.ipynbindex fb9fc17..1c1926c 100644--- a/examples/12_face_recognition.ipynb+++ b/examples/12_face_recognition.ipynb@@ -14,7 +14,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/examples/13_portrait_matting.ipynb b/examples/13_portrait_matting.ipynbindex 469e3be..34f6da5 100644--- a/examples/13_portrait_matting.ipynb+++ b/examples/13_portrait_matting.ipynb@@ -13,7 +13,7 @@" <a style=\"margin-bottom:6px;\" href=\"https://github.com/yakhyo/uniface\"><img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/yakhyo/uniface.svg?style=social\"></a>\n","</div>\n","\n",- "**UniFace** is a lightweight, production-ready, all-in-one face analysis library built on ONNX Runtime.\n",+ "**UniFace** is a lightweight, production-ready Python library for face detection, recognition, tracking, landmark analysis, face parsing, gaze estimation, and face attributes.\n","\n","π **GitHub**: [github.com/yakhyo/uniface](https://github.com/yakhyo/uniface) | π **Docs**: [yakhyo.github.io/uniface](https://yakhyo.github.io/uniface)\n","\n",diff --git a/mkdocs.yml b/mkdocs.ymlindex 961a250..eaa6c4e 100644--- a/mkdocs.yml+++ b/mkdocs.yml@@ -1,5 +1,5 @@site_name: UniFace-site_description: All-in-One Face Analysis Library with ONNX Runtime+site_description: A Unified Face Analysis Library for Pythonsite_author: Yakhyokhuja Valikhujaevsite_url: https://yakhyo.github.io/unifacediff --git a/pyproject.toml b/pyproject.tomlindex 061811b..26a7b7b 100644--- a/pyproject.toml+++ b/pyproject.toml@@ -1,7 +1,7 @@[project]name = "uniface"version = "3.5.1rc1"-description = "UniFace: A Comprehensive Library for Face Detection, Recognition, Tracking, Landmark Analysis, Face Parsing, Gaze Estimation, Age, and Gender Detection"+description = "UniFace: A Unified Face Analysis Library for Python"readme = "README.md"license = "MIT"authors = [{ name = "Yakhyokhuja Valikhujaev", email = "[email protected]" }]