Merge pull request #17 from tomas-gajarsky/feature/conda

Feature/conda

Author: tomas-gajarsky

.dockerignore

@@ -73,6 +73,8 @@ venv.bak/
 # Documentation
 docs/
 
-# FaceTorch specific
-data/images/collages/
-output/
+# Hydra
+outputs/
+
+# facetorch specific
+models/

.github/workflows/conda-env.yml

@@ -22,3 +22,6 @@ jobs:
     - name: Install dependencies
       run: |
         conda env update --file environment.yml --name base
+    - name: Install facetorch from conda-forge
+      run: |
+        conda install -c conda-forge facetorch

.github/workflows/docker-push.yml

@@ -15,19 +15,19 @@ jobs:
         env:
           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
           DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
-        run: docker login -u $DOCKER_USERNAME -p $DOCKER_PASSWORD  docker.io
+        run: docker login -u $DOCKER_USERNAME -p $DOCKER_PASSWORD docker.io
       - name: Docker compose push facetorch
         run: docker compose push facetorch
   docker-push-gpu:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: Docker compose build facetorch-gpu
-        run: docker compose build facetorch-gpu
+        run: docker compose build facetorch-gpu-no-device
       - name: Login to Docker hub
         env:
           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
           DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
-        run: docker login -u $DOCKER_USERNAME -p $DOCKER_PASSWORD  docker.io
+        run: docker login -u $DOCKER_USERNAME -p $DOCKER_PASSWORD docker.io
       - name: Docker compose push facetorch-gpu
-        run: docker compose push facetorch-gpu
+        run: docker compose push facetorch-gpu-no-device

.gitignore

@@ -108,3 +108,4 @@ cython_debug/
 ## User folders
 models/
 outputs/
+tests/data/output/

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## 0.0.8
+
+Released on August 12, 2022.
+
+### Added
+
+* conda-forge documentation
+* entrypoints to docker compose services
+
+### Changed
+
+* workflow for testing conda installation
+* workflow for pushing facetorch-gpu Docker image to Docker Hub
+
+
 ## 0.0.7
 
 Released on August 11, 2022.
@@ -18,6 +33,7 @@ Released on August 10, 2022.
 
 * GitHub workflows
 
+
 ## 0.0.5
 
 Released on August 7, 2022.

README.md

@@ -2,10 +2,13 @@
 ![build](https://github.com/tomas-gajarsky/facetorch/actions/workflows/build.yml/badge.svg?branch=main)
 ![lint](https://github.com/tomas-gajarsky/facetorch/actions/workflows/lint.yml/badge.svg?branch=main)
 [![PyPI](https://img.shields.io/pypi/v/facetorch)](https://pypi.org/project/facetorch/)
+[![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/facetorch)](https://anaconda.org/conda-forge/facetorch)
+
 [![PyPI - License](https://img.shields.io/pypi/l/facetorch)](https://raw.githubusercontent.com/tomas-gajarsky/facetorch/main/LICENSE)
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 
-[documentation](https://tomas-gajarsky.github.io/facetorch/facetorch/index.html)
+
+[Documentation](https://tomas-gajarsky.github.io/facetorch/facetorch/index.html), [Docker Hub](https://hub.docker.com/repository/docker/tomasgajarsky/facetorch) [(GPU)](https://hub.docker.com/repository/docker/tomasgajarsky/facetorch-gpu)
 
 Facetorch is a Python library that can detect faces and analyze facial features using deep neural networks. The goal is to gather open sourced face analysis models from the community, optimize them for performance using TorchScript and combine them to create a face analysis tool that one can:
 
@@ -23,7 +26,10 @@ The models are not perfect and may be biased.
 ```bash
 pip install facetorch
 ```
-
+[Conda](https://anaconda.org/conda-forge/facetorch)
+```bash
+conda install -c conda-forge facetorch
+```
 ## Usage
 
 ### Prerequisites
@@ -39,7 +45,7 @@ Docker Compose provides an easy way of building a working facetorch environment
 
 ### Configure
 
-The project is configured by files located in *conf* with the main file *conf/config.yaml*.
+The project is configured by files located in *conf* with the main file: *conf/config.yaml*.
 
 ## Components
 FaceAnalyzer is the main class of facetorch as it is the orchestrator responsible for initializing and running the following components:
@@ -72,8 +78,8 @@ analyzer
     |   RetinaFace  |  biubug6  | MIT license |    1    |
 
 1. biubug6
-    * code: [biubug6/Pytorch_Retinaface](https://github.com/biubug6/Pytorch_Retinaface)
-    * paper: [RetinaFace: Single-Shot Multi-Level Face Localisation in the Wild](https://openaccess.thecvf.com/content_CVPR_2020/html/Deng_RetinaFace_Single-Shot_Multi-Level_Face_Localisation_in_the_Wild_CVPR_2020_paper.html)
+    * code: [Pytorch_Retinaface](https://github.com/biubug6/Pytorch_Retinaface)
+    * paper: [Deng et al. - RetinaFace: Single-Shot Multi-Level Face Localisation in the Wild](https://openaccess.thecvf.com/content_CVPR_2020/html/Deng_RetinaFace_Single-Shot_Multi-Level_Face_Localisation_in_the_Wild_CVPR_2020_paper.html)
 
 
 ### Predictor
@@ -137,8 +143,8 @@ analyzer
 
 ## Development
 Run the Docker container:
-* CPU: ```docker compose -f docker-compose.dev.yml run facetorch-dev bash```
-* GPU: ```docker compose -f docker-compose.dev.yml run facetorch-dev-gpu bash```
+* CPU: ```docker compose -f docker-compose.dev.yml run facetorch-dev```
+* GPU: ```docker compose -f docker-compose.dev.yml run facetorch-dev-gpu```
 
 ### Add predictor
 #### Prerequisites
@@ -172,10 +178,10 @@ the requirements of the new model.
 2. Write a test for the new predictor in ```/tests/test_<predictor_name>.py```
 
 #### Test and submit
-1. Run linting test: ```flake8 --config=.flake8```
-2. Run tests and generate coverage: ```pytest tests --verbose --cov-report html:coverage --cov facetorch```
-3. Add the new predictor to the README model table.
-4. Submit a pull request to add the new predictor to the main codebase.
+1. Run linting: ```black facetorch```
+2. Add the new predictor to the README model table.
+3. Update CHANGELOG and version
+4. Submit a pull request to the repository
 
 
 ### Update environment
@@ -189,16 +195,16 @@ GPU:
 * Lock the environment: ```conda lock -p linux-64 -f gpu.environment.yml --lockfile gpu.conda-lock.yml```
 * Install the locked environment: ```conda-lock install --name env gpu.conda-lock.yml```
 
+### Run tests + coverage
+* Run tests and generate coverage: ```pytest tests --verbose --cov-report html:coverage --cov facetorch```
+
 ### Generate documentation
 * Generate documentation from docstrings using pdoc3:  ```pdoc --html facetorch --output-dir docs --force --template-dir pdoc/templates/```
 
 ### Profiling
 1. Run profiling of the example script: ```python -m cProfile -o profiling/example.prof scripts/example.py```
 2. Open profiling file in the browser: ```snakeviz profiling/example.prof```
 
-### Docker Hub
-[facetorch Docker Hub](https://hub.docker.com/repository/docker/tomasgajarsky/facetorch)
-
 ## Acknowledgements
 I want to thank the open source code community and the researchers who have published the models. This project would not be possible without their work.
 

docker-compose.dev.yml

@@ -11,8 +11,6 @@ services:
     ports:
       - "8080:8080"
     entrypoint: ["/bin/bash"]
-    environment:
-      - PYTHONPATH="$${PYTHONPATH}:/opt/facetorch"
 
   facetorch-dev-gpu:
     build:
@@ -32,25 +30,22 @@ services:
               capabilities: [ gpu ]
     entrypoint: ["/bin/bash"]
 
-  facetorch-dev-example:
+  facetorch-tests:
     build:
       context: .
-      dockerfile: ./docker/Dockerfile.dev
+      dockerfile: ./docker/Dockerfile.tests
     volumes:
       - ./:/opt/facetorch
     ports:
       - "8080:8080"
-    entrypoint: ["conda", "run", "--no-capture-output", "-n", "env", "python", "scripts/example.py"]
+    entrypoint: ["conda", "run", "--no-capture-output", "-n", "env", "pytest", "-v", "--cov=facetorch", "--cov-report=term", "--cov-fail-under=95"]
 
-  facetorch-tests:
+  facetorch-dev-example:
     build:
       context: .
-      dockerfile: ./docker/Dockerfile.tests
+      dockerfile: ./docker/Dockerfile.dev
     volumes:
       - ./:/opt/facetorch
     ports:
       - "8080:8080"
-    # entrypoint: ["/bin/bash"]
-    # entrypoint: ["conda", "run", "--no-capture-output", "-n", "env", "--cwd", "/opt/facetorch", "pip", "list"]
-    entrypoint: ["conda", "run", "--no-capture-output", "-n", "env", "pytest", "-v", "--cov=facetorch", "--cov-report=term", "--cov-fail-under=95"]
-    # environment: [ "PYTHONPATH=/opt/facetorch" ]
+    entrypoint: ["conda", "run", "--no-capture-output", "-n", "env", "python", "scripts/example.py"]

docker-compose.yml

@@ -9,6 +9,7 @@ services:
       dockerfile: ./docker/Dockerfile
     volumes:
         - ./:/opt/facetorch
+    entrypoint: ["/bin/bash"]
 
   facetorch-gpu:
     image: tomasgajarsky/facetorch-gpu:latest
@@ -24,4 +25,13 @@ services:
             - driver: nvidia
               device_ids: ["0"]
               capabilities: [gpu]
+    entrypoint: ["/bin/bash"]
 
+  facetorch-gpu-no-device:
+    image: tomasgajarsky/facetorch-gpu:latest
+    build:
+      context: .
+      dockerfile: ./docker/Dockerfile.gpu
+    volumes:
+        - ./:/opt/facetorch
+    entrypoint: ["/bin/bash"]

docker/Dockerfile

@@ -8,4 +8,6 @@ WORKDIR $WORKDIR
 RUN pip install --upgrade pip
 
 # Install facetorch from PyPI
-RUN pip install facetorch
+RUN pip install facetorch
+
+COPY . .

docker/Dockerfile.gpu

@@ -22,4 +22,6 @@ RUN ln -sf /usr/bin/python3.9 /usr/bin/python3 & \
 RUN pip install --upgrade pip
 
 # Install facetorch from PyPI
-RUN pip install facetorch
+RUN pip install facetorch
+
+COPY . .