immich/machine-learning
renovate[bot] 259700c45f
chore(deps): update mambaorg/micromamba:bookworm-slim docker digest to e296d47 (#5487)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-12-04 19:37:08 -05:00
..
app chore(ml): increase spool threshold to 64MiB (#5176) 2023-11-20 09:05:35 -06:00
export chore(deps): update mambaorg/micromamba:bookworm-slim docker digest to e296d47 (#5487) 2023-12-04 19:37:08 -05:00
.dockerignore feat: facial recognition (#2180) 2023-05-17 12:07:17 -05:00
.gitignore feat: facial recognition (#2180) 2023-05-17 12:07:17 -05:00
Dockerfile chore(deps): update python:3.11-slim-bookworm docker digest to cc75851 (#5462) 2023-12-04 13:26:41 -06:00
README.md chore(docs): updated ML documentation (#4063) 2023-09-12 13:22:42 +07:00
README_es_ES.md Add Spanish translations of Readme (#3511) 2023-08-02 06:51:08 -05:00
README_fr_FR.md Add french documentation (#4010) 2023-09-08 13:48:39 +07:00
locustfile.py feat(ml): export clip models to ONNX and host models on Hugging Face (#4700) 2023-10-31 05:02:04 -05:00
log_conf.json chore(ml): memory optimisations (#3934) 2023-08-31 18:30:53 -05:00
poetry.lock pin python (#5272) 2023-11-22 19:42:17 -05:00
pyproject.toml Version v1.89.0 2023-11-29 19:20:24 +00:00
responses.json fix(ml): load models in separate threads (#4034) 2023-09-09 16:02:44 +07:00
start.sh fix(ml): set higher default worker timeout (#4007) 2023-09-07 08:27:29 +07:00

README.md

Immich Machine Learning

  • Image classification
  • CLIP embeddings
  • Facial recognition

Setup

This project uses Poetry, so be sure to install it first. Running poetry install --no-root --with dev will install everything you need in an isolated virtual environment.

To add or remove dependencies, you can use the commands poetry add $PACKAGE_NAME and poetry remove $PACKAGE_NAME, respectively. Be sure to commit the poetry.lock and pyproject.toml files to reflect any changes in dependencies.

Load Testing

To measure inference throughput and latency, you can use Locust using the provided locustfile.py. Locust works by querying the model endpoints and aggregating their statistics, meaning the app must be deployed. You can change the models or adjust options like score thresholds through the Locust UI.

To get started, you can simply run locust --web-host 127.0.0.1 and open localhost:8089 in a browser to access the UI. See the Locust documentation for more info on running Locust.

Note that in Locust's jargon, concurrency is measured in users, and each user runs one task at a time. To achieve a particular per-endpoint concurrency, multiply that number by the number of endpoints to be queried. For example, if there are 3 endpoints and you want each of them to receive 8 requests at a time, you should set the number of users to 24.