Skip to content

Improve face_recognition.md #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thomas-mc-work wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve face_recognition.md #30

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6ac6e5
Improve face_recognition.md
thomas-mc-work Jan 23, 2026
44faa3d
Update face_recognition.md
thomas-mc-work Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 27 additions & 15 deletions content/lua.scripts.manual/scripts/contrib/face_recognition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,41 @@ author: "people"

## Name

face_recognition.lua - add a new storage option and calls face_recognition after export
face_recognition.lua - Calls externel tool [face_recognition](https://github.com/ageitgey/face_recognition/) and applies the results

## Description

Add a new storage option to send images to face_recognition.
Images are exported to darktable tmp dir first.
A directory with known faces must exist, the image name are the
tag names which will be used.
Multiple images for one face can exist, add a number to it, the
number will be removed from the tag, for example:
People|IknowYou1.jpg
People|IknowYou2.jpg
People|Another.jpg
People|Youtoo.jpg
Adds on option to apply face recognition on a selection of photos. The results are written into customizable tags.

## Preparation

1. Install the face recognition solution https://github.com/ageitgey/face_recognition: `pipx install face-recognition`
2. Prepare your known faces in the following fashion:

You need a directory which holds the photos of all known faces. The file names are the tag names which will be used. You can add a number suffix to provide multiple photos of the same persone to improve the result. The number will be removed from the tag.

@anoderay anoderay Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo "persone"

@anoderay anoderay Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also maybe "number will be removed from the tag" = "number will not appear in the applied tag"


Example:

- `People|Family|IknowYou1.jpg`
- `People|Family|IknowYou2.jpg`
- `People|Friend|Another.jpg`
- `People|Youtoo.jpg`

3. Enable this script from script manager (included in the default installation of darktable. Thus no additional manual download required) and point it to the faces folder from the previous step.

## Technical process

1. Selected images are exported into a temporary location with a lowered resolution
2. The external tool is invoced with the photo and the path to the face folder as parameters

@anoderay anoderay Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

invoced = invoked

3. The result is parsed an dapplied as tags

@anoderay anoderay Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing space in "dapplied"


## Usage

* start this script from script manager.
* start the recognition from the corresponding module ("face recognition") on the right side in the library view

@wpferguson wpferguson Jun 26, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you probably need to select some images before you try running the script


## Additional Software Required
## Source

* https://github.com/ageitgey/face_recognition
* https://github.com/darktable-org/lua-scripts/tree/master/lib
https://github.com/darktable-org/lua-scripts/blob/master/contrib/face_recognition.lua

## Limitations

Expand Down