docs: update (#4893)

* docs: update

* chore:format
This commit is contained in:
Alex 2023-11-07 15:52:44 -06:00 committed by GitHub
parent c2c26c471a
commit bb28cae671
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 67 additions and 9 deletions

View file

@ -4,6 +4,10 @@ You can use the CLI to upload an existing gallery to the Immich server
[Immich CLI Repository](https://github.com/immich-app/CLI) [Immich CLI Repository](https://github.com/immich-app/CLI)
:::tip Google Photos Takeout
If you are looking to import your Google Photos takeout, we recommed this community maintained tool [immich-go](https://github.com/simulot/immich-go)
:::
## Requirements ## Requirements
- Node.js 16 or above - Node.js 16 or above

View file

@ -1,5 +1,7 @@
# Facial Recognition # Facial Recognition
## Overview
Immich recognizes faces in your photos and videos and groups them together. You can then assign names to the faces and search for them. Immich recognizes faces in your photos and videos and groups them together. You can then assign names to the faces and search for them.
The list of people is shown in the Explore page. The list of people is shown in the Explore page.
@ -13,3 +15,16 @@ Upon clicking on a person, a list of assets that contain their face will be show
The asset detail view will also show the faces that are recognized in the asset. The asset detail view will also show the faces that are recognized in the asset.
<img src={require('./img/facial-recognition-3.png').default} title='Facial Recognition 3' /> <img src={require('./img/facial-recognition-3.png').default} title='Facial Recognition 3' />
## Actions
Additional actions you can do with a detected person are:
- Change the feature face photo of the person
- Set date of birth
- Merge two or more detected faces into one person
- Hide face
It can be found from the app bar when you access the detial view of a person
<img src={require('./img/facial-recognition-4.png').default} title='Facial Recognition 4' width="70%"/>

Binary file not shown.

After

Width:  |  Height:  |  Size: 416 KiB

View file

@ -1,6 +1,6 @@
import MobileAppDownload from '../partials/_mobile-app-download.md'; import MobileAppDownload from '../partials/_mobile-app-download.md';
import MobileAppLogin from '../partials/_mobile-app-login.md'; import MobileAppLogin from '../partials/_mobile-app-login.md';
import MobileAppBackup from '../partials/_mobile-app-login.md'; import MobileAppBackup from '../partials/_mobile-app-backup.md';
# Mobile App # Mobile App

View file

@ -17,6 +17,12 @@ The default configuration looks like this:
"targetAudioCodec": "aac", "targetAudioCodec": "aac",
"targetResolution": "720", "targetResolution": "720",
"maxBitrate": "0", "maxBitrate": "0",
"bframes": -1,
"refs": 0,
"gopSize": 0,
"npl": 0,
"temporalAQ": false,
"cqMode": "auto",
"twoPass": false, "twoPass": false,
"transcode": "required", "transcode": "required",
"tonemap": "hable", "tonemap": "hable",
@ -44,9 +50,15 @@ The default configuration looks like this:
"sidecar": { "sidecar": {
"concurrency": 5 "concurrency": 5
}, },
"library": {
"concurrency": 5
},
"storageTemplateMigration": { "storageTemplateMigration": {
"concurrency": 5 "concurrency": 5
}, },
"migration": {
"concurrency": 5
},
"thumbnailGeneration": { "thumbnailGeneration": {
"concurrency": 5 "concurrency": 5
}, },
@ -55,16 +67,16 @@ The default configuration looks like this:
} }
}, },
"machineLearning": { "machineLearning": {
"classification": {
"minScore": 0.7,
"enabled": true,
"modelName": "microsoft/resnet-50"
},
"enabled": true, "enabled": true,
"url": "http://immich-machine-learning:3003", "url": "http://immich-machine-learning:3003",
"classification": {
"enabled": true,
"modelName": "microsoft/resnet-50",
"minScore": 0.9
},
"clip": { "clip": {
"enabled": true, "enabled": true,
"modelName": "ViT-B-32::openai" "modelName": "ViT-B-32__openai"
}, },
"facialRecognition": { "facialRecognition": {
"enabled": true, "enabled": true,
@ -74,6 +86,14 @@ The default configuration looks like this:
"minFaces": 1 "minFaces": 1
} }
}, },
"map": {
"enabled": true,
"tileUrl": "https://tile.openstreetmap.org/{z}/{x}/{y}.png"
},
"reverseGeocoding": {
"enabled": true,
"citiesFileOverride": "cities500"
},
"oauth": { "oauth": {
"enabled": false, "enabled": false,
"issuerUrl": "", "issuerUrl": "",
@ -96,8 +116,27 @@ The default configuration looks like this:
"thumbnail": { "thumbnail": {
"webpSize": 250, "webpSize": 250,
"jpegSize": 1440, "jpegSize": 1440,
"quality": 90, "quality": 80,
"colorspace": "p3" "colorspace": "p3"
},
"newVersionCheck": {
"enabled": true
},
"trash": {
"enabled": true,
"days": 30
},
"theme": {
"customCss": ""
},
"library": {
"scan": {
"enabled": true,
"cronExpression": "0 0 * * *"
}
},
"stylesheets": {
"css": ""
} }
} }
``` ```

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 321 KiB

After

Width:  |  Height:  |  Size: 404 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 335 KiB

After

Width:  |  Height:  |  Size: 334 KiB

View file

@ -34,7 +34,7 @@ function HomepageHeader() {
</Link> </Link>
</div> </div>
<img src="/img/immich-screenshots.png" alt="logo" /> <img src="/img/immich-screenshots.png" alt="screenshots" width={'85%'} />
<div className="flex flex-col sm:flex-row place-items-center place-content-center mt-4 gap-1"> <div className="flex flex-col sm:flex-row place-items-center place-content-center mt-4 gap-1">
<div className="h-24"> <div className="h-24">

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 MiB

After

Width:  |  Height:  |  Size: 1.8 MiB