Merge pull request #81 from serengil/feat-task-1002-package-version

package version added into the interface

README.md

@@ -87,6 +87,8 @@ for face in faces:
 
 <p align="center"><img src="https://raw.githubusercontent.com/serengil/retinaface/master/tests/outputs/alignment-procedure.png" width="80%" height="80%"></p>
 
+If you prefer to prioritize alignment before detection, you may opt to set the `align_first` parameter to True. By following this approach, you will eliminate the black pixel areas that arise as a result of alignment following detection. This functionality is applicable only when the provided image contains a single face.
+
 **Face Recognition** - [`Demo`](https://youtu.be/WnUVYQP4h44)
 
 Notice that face recognition module of insightface project is [ArcFace](https://sefiks.com/2020/12/14/deep-face-recognition-with-arcface-in-keras-and-python/), and face detection module is RetinaFace. ArcFace and RetinaFace pair is wrapped in [deepface](https://github.com/serengil/deepface) library for Python. Consider to use deepface if you need an end-to-end face recognition pipeline.
@@ -151,7 +153,7 @@ If you are using RetinaFace in your research, please consider to cite its [origi
 }
 ```
 
-Finally, if you use this RetinaFace re-implementation in your GitHub projects, please add retina-face dependency in the requirements.txt.
+Finally, if you use this RetinaFace re-implementation in your GitHub projects, please add `retina-face` dependency in the requirements.txt.
 
 ## Licence
 

package_info.json

@@ -0,0 +1,3 @@
+{
+    "version": "0.0.15"
+}

retinaface/RetinaFace.py

@@ -6,6 +6,7 @@
 import numpy as np
 import tensorflow as tf
 
+from retinaface import __version__
 from retinaface.model import retinaface_model
 from retinaface.commons import preprocess, postprocess
 from retinaface.commons.logger import Logger

retinaface/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.15"

setup.py

@@ -1,3 +1,4 @@
+import json
 import setuptools
 
 with open("README.md", "r", encoding="utf-8") as fh:
@@ -6,13 +7,17 @@
 with open("requirements.txt", "r", encoding="utf-8") as f:
     requirements = f.read().split("\n")
 
+with open("package_info.json", "r", encoding="utf-8") as f:
+    package_info = json.load(f)
+
+
 setuptools.setup(
     name="retina-face",  # pip install retina-face
-    version="0.0.14",
+    version=package_info["version"],
     author="Sefik Ilkin Serengil",
     author_email="[email protected]",
     description="RetinaFace: Deep Face Detection Framework in TensorFlow for Python",
-    data_files=[("", ["README.md", "requirements.txt"])],
+    data_files=[("", ["README.md", "requirements.txt", "package_info.json"])],
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/serengil/retinaface",

tests/test_package.py

@@ -0,0 +1,13 @@
+import json
+from retinaface import RetinaFace
+from retinaface.commons.logger import Logger
+
+logger = Logger("tests/test_package.py")
+
+
+def test_version():
+    with open("./package_info.json", "r", encoding="utf-8") as f:
+        package_info = json.load(f)
+
+    assert RetinaFace.__version__ == package_info["version"]
+    logger.info("✅ versions are matching in both package_info.json and retinaface/__init__.py")