luadocs/content/lua.scripts.manual/scripts/contrib/photils.md
Bill Ferguson b69d752221 [lua scripts] created manual from script comments
[lua scripts api] created manual from embedded library documentation

[lua api] created stub to contain lua api manual
2020-12-12 15:14:19 -05:00

41 lines
1,001 B
Markdown

---
title: photils
id: photils
weight: 250
draft: false
author: "people"
---
## Name
photils.lua - auto tag images based on feature recognition
## Description
A darktable plugin that tries to predict keywords based on the selected image.
This plugin uses photils-cli to handle this task. Photils-cli is an application
that passes the image through a neural network, classifies it, and extracts the
suggested tags. Everything happens offline without the need that your data are
sent over the internet.
## Usage
* require this script from your main lua file
To do this add this line to the file .config/darktable/luarc:
require "contrib/photils"
* Select an image
* Press "get tags"
* Select the tags you want from a list of suggestions
* Press "Attach .. Tags" to add the selected tags to your image
## Additional Software Required
* photils-cli - https://github.com/scheckmedia/photils-cli at the moment only
available for Linux and MacOS
## Limitations
## Author
Tobias Scheck