From 6d09cb6b6de60b01aa22de08fcc8d3bfcd7250a7 Mon Sep 17 00:00:00 2001
From: Alex <alex.tran1502@gmail.com>
Date: Tue, 20 Dec 2022 08:54:52 -0600
Subject: [PATCH] Update docs and readme

---
 README.md                              |  9 ++++-----
 docs/docs/installation/requirements.md | 23 +++++++++++++++++++++++
 2 files changed, 27 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 58049fa923..270969ac6e 100644
--- a/README.md
+++ b/README.md
@@ -67,17 +67,16 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
 | Selective album(s) for backup               | Yes     | N/A |
 | Download photos and videos to local device  | Yes     | Yes |
 | Multi-user support                          | Yes     | Yes |
-| Album                                       | Yes     | Yes |
-| Shared Albums                               | Yes     | Yes |
-| Quick navigation with draggable scrollbar   | Yes     | Yes |
+| Album and Shared albums                     | Yes     | Yes |
+| Scrubbable/draggable scrollbar              | Yes     | Yes |
 | Support RAW (HEIC, HEIF, DNG, Apple ProRaw) | Yes     | Yes |
 | Metadata view (EXIF, map)                   | Yes     | Yes |
 | Search by metadata, objects and image tags  | Yes     | No  |
 | Administrative functions (user management)  | N/A     | Yes |
 | Background backup                           | Android | N/A |
 | Virtual scroll                              | Yes     | Yes |
-| OAuth Support                               | Yes     | Yes |
-| LivePhotos Backup and Playback (iOS only)   | Yes     | Yes |
+| OAuth support                               | Yes     | Yes |
+| LivePhoto backup and playback               | iOS     | Yes |
 | User-defined storage structure              | Yes     | Yes |
 
 # Support the project
diff --git a/docs/docs/installation/requirements.md b/docs/docs/installation/requirements.md
index 1c1cc5a723..483e568ff0 100644
--- a/docs/docs/installation/requirements.md
+++ b/docs/docs/installation/requirements.md
@@ -21,6 +21,29 @@ You can also use Podman to run the application. However, additional configuratio
 - **RAM**: At least 2GB, preferred 4GB.
 - **CPU**: At least 2 cores, preferred 4 cores.
 
+:::info Machine Learning on older CPU
+
+TensorFlow doesn't run with older CPU architecture, it requires a CPU with AVX and AVX2 instruction set. If you encounter the error `illegal instruction core dump` check for your CPU flags with the command and make sure you see `AVX` and `AVX2`:
+
+```bash
+more /proc/cpuinfo | grep flags
+```
+
+#### Promox
+
+If you are running virtualization in Proxmox, the VM doesn't have the flag enabled.
+
+You need to change the CPU type from `kvm64` to `host` under VMs hardware tab.
+
+`Hardware > Processors > Edit > Advanced > Type (dropdown menu) > host`
+
+#### Other platforms
+
+You can use the machine learning image that is built for Non-AVX CPU. The image is community maintained and can be found in the repository below
+
+https://github.com/bertmelis/immich-machine-learning-no-avx
+:::
+
 ## Installation methods
 
 There are a couple installation methods that you can use to install the application. You can choose the one that suits you the best.