From 54b4f8afbdde96dc331b6dee7ed637681bfc46f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Skyler=20M=C3=A4ntysaari?= Date: Sat, 6 May 2023 15:43:24 +0300 Subject: [PATCH] chore(docs): Update FAQ on how to disable typsense and ml (#2384) --- docs/docs/FAQ.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/docs/FAQ.md b/docs/docs/FAQ.md index 4171a574f9..76c1b07928 100644 --- a/docs/docs/FAQ.md +++ b/docs/docs/FAQ.md @@ -41,6 +41,14 @@ This often happens when using a reverse proxy or cloudflare tunnel in front of I Immich uses optional machine-learning features to enhance search results. This feature, however, can be too heavy to run on a Raspberry Pi. To disable machine learning, comment out the `immich-machine-learning` section of your docker-compose.yml and set `IMMICH_MACHINE_LEARNING_URL=false` in your .env file. +### How to disable machine-learning and TypeSense? + +:::warning +Disabling both will result in poor search experience and typesense utilizes CLIP embeddings which are generated by machine-learning. +::: + +These features can be disabled by commenting out `immich-typesense` and `immich-machine-learning` sections of the docker-compose.yml and setting `IMMICH_MACHINE_LEARNING_URL=false` & `TYPESENSE_ENABLED=false` in your .env file. + ### What happens to existing files after I choose a new [Storage Template](/docs/administration/storage-template.mdx)? Template changes will only apply to new assets. To retroactively apply the template to previously uploaded assets, run the Storage Migration Job, available on the [Jobs](/docs/administration/jobs.md) page.