deepface
A Lightweight Face Recognition and Facial Attribute Analysis (Age, Gender, Emotion and Race) Library for Python
File Explorer
Download Latest Version (.zip)- External_Integration_Layer.md
- Facial_Analysis_Engine.md
- Model_Management_System.md
- on_boarding.md
- Utility_Infrastructure_Layer.md
- 01-report-bug.yaml
- 02-request-feature.yaml
- 03-documentation.yaml
- config.yml
- tests.yml
- CODE_OF_CONDUCT.md
- FUNDING.yml
- pull_request_template.md
- settings.json
- Evaluate-Results.ipynb
- Perform-Experiments.ipynb
- README.md
- boosted_lightface_7.txt
- Perform-Boosting-Experiments-LightGBM.ipynb
- Perform-Boosting-Experiments-XGBoost.ipynb
- deepface-api.postman_collection.json
- __init__.py
- container.py
- variables.py
- __init__.py
- service.py
- __init__.py
- routes.py
- service.py
- __init__.py
- __init__.py
- app.py
- .env.example
- __init__.py
- __init__.py
- constant.py
- embed_utils.py
- folder_utils.py
- image_utils.py
- logger.py
- package_utils.py
- weight_utils.py
- __init__.py
- confidence.py
- minmax.py
- threshold.py
- __init__.py
- Age.py
- Emotion.py
- Gender.py
- Race.py
- __init__.py
- CenterFace.py
- Dlib.py
- FastMtCnn.py
- MediaPipe.py
- MtCnn.py
- OpenCv.py
- RetinaFace.py
- Ssd.py
- Yolo.py
- YuNet.py
- __init__.py
- ArcFace.py
- Buffalo_L.py
- DeepID.py
- Dlib.py
- Facenet.py
- FbDeepFace.py
- GhostFaceNet.py
- OpenFace.py
- SFace.py
- VGGFace.py
- __init__.py
- FasNet.py
- FasNetBackbone.py
- __init__.py
- Demography.py
- Detector.py
- FacialRecognition.py
- __init__.py
- inventory.py
- milvus.py
- mongo.py
- neo4j.py
- pgvector.py
- pinecone.py
- postgres.py
- qdrant.py
- types.py
- weaviate.py
- __init__.py
- datastore.py
- demography.py
- detection.py
- encryption.py
- exceptions.py
- modeling.py
- normalization.py
- preprocessing.py
- recognition.py
- representation.py
- streaming.py
- verification.py
- __init__.py
- DeepFace.py
- 01_pgvector.sql
- 001_create_table.sql
- docker-compose.yml
- integration.sh
- distance-to-confidence.ipynb
- benchmarks.jpg
- celebrity-look-alike-2.jpg
- celebrity-look-alike.jpg
- deepface-api.jpg
- deepface-icon-labeled.png
- deepface-icon.png
- deepface-realtime.jpg
- detector-outputs-20240414.jpg
- detector-portfolio-v6.jpg
- embedding.jpg
- encrypt-embeddings.jpg
- face-anti-spoofing.jpg
- facenet-pca.png
- model-portfolio-20240316.jpg
- parental-look-alike-scaled.jpg
- patreon.png
- retinaface-results.jpeg
- stock-1.jpg
- stock-2.jpg
- stock-3.jpg
- stock-6-v2.jpg
- verify-credit.jpg
- dockerize.sh
- push-release.sh
- service.sh
- target.jpg
- test_postgres_register.py
- test_postgres_search.py
- couple.jpg
- face-recognition-pivot.csv
- img1.jpg
- img10.jpg
- img11.jpg
- img11_reflection.jpg
- img12.jpg
- img13.jpg
- img14.jpg
- img15.jpg
- img16.jpg
- img17.jpg
- img18.jpg
- img19.jpg
- img2.jpg
- img20.jpg
- img21.jpg
- img22.jpg
- img23.jpg
- img24.jpg
- img25.jpg
- img26.jpg
- img27.jpg
- img28.jpg
- img29.jpg
- img3.jpg
- img30.jpg
- img31.jpg
- img32.jpg
- img33.jpg
- img34.jpg
- img35.jpg
- img36.jpg
- img37.jpg
- img38.jpg
- img39.jpg
- img4.jpg
- img40.jpg
- img41.jpg
- img42.jpg
- img43.jpg
- img44.jpg
- img45.jpg
- img46.jpg
- img47.jpg
- img48.jpg
- img49.jpg
- img5.jpg
- img50.jpg
- img51.jpg
- img53.jpg
- img54.jpg
- img55.jpg
- img56.jpg
- img57.jpg
- img58.jpg
- img59.jpg
- img6.jpg
- img61.jpg
- img62.jpg
- img67.jpg
- img7.jpg
- img8.jpg
- img9.jpg
- master.csv
- selfie-many-people.jpg
- face-recognition-how.py
- overlay.py
- stream.py
- test_analyze.py
- test_api.py
- test_commons.py
- test_encrypt.py
- test_enforce_detection.py
- test_extract_faces.py
- test_find.py
- test_find_batched.py
- test_landmark_sanitization.py
- test_output_normalization.py
- test_represent.py
- test_signature.py
- test_singleton.py
- test_verify.py
- test_version.py
- visual-test.py
- .gitattributes
- .gitignore
- .pylintrc
- CITATION.cff
- Dockerfile
- entrypoint.sh
- LICENSE
- Makefile
- mypy.ini
- package_info.json
- README.md
- requirements-dev.txt
- requirements.txt
- requirements_additional.txt
- requirements_local
- setup.py
# Installation Guide
1. Get the code
git clone https://github.com/serengil/deepface
Downloads the entire project code from GitHub to your computer.
cd deepface
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker/docker-compose.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Python
EasyPrerequisites
$ pip install deepface
Installs the Python libraries listed in requirements.txt (or similar).
$ pip install -e .
Installs the Python libraries listed in requirements.txt (or similar).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
4. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)