Recognize for Nextcloud
Smart media tagging for Nextcloud
This app goes through your media collection and adds fitting tags, automatically categorizing your photos and music.
📷 👪 Recognizes faces and groups photos by face📷 🏔 Recognizes animals, landscapes, food, vehicles, buildings and other objects📷 🗼 Recognizes landmarks and monuments👂 🎵 Recognizes music genres⚡ Tagging works via Nextcloud's Collaborative Tags, allowing access by any of your apps👂 listen to your tagged music with the audioplayer app📷 view your tagged photos with the photos app
Examples
(Screenshot by @_DigitalWriter_)
Privacy
This app does not send any sensitive data to cloud providers or similar services. All image processing is done on your nextcloud machine, using Tensorflow.js running in Node.js, which comes bundled with this app.
Categories
This is the list of recognized things and which categories they are currently mapped to. I'm happy to accept pull requests for this file to fine tune predictions.
Behind the scenes
Recognize uses
- a pre-trained EfficientNet v2 model for ImageNet object detection.
- a pre-trained model trained on the Landmarks v1 dataset for landmark recognition.
- face-api.js to extract and compare face features.
- a Musicnn neural network architecture to classify audio files into music genres. Also see the original musicnn repository.
- a pre-trained MoViNet model for video classification
Learn more about what's going on behind the scenes in this wiki article and this forum post.
Install
Requirements
- php 8.0 and above
- App "collaborative tags" enabled
- For native speed:
- Processor: x86 64-bit (with support for AVX instructions)
- System with glibc (usually the norm on Linux; FreeBSD, Alpine linux and thus also Nextcloud AIO are not such systems)
- For sub-native speed (using WASM mode)
- Processor: x86 64-bit, arm64, armv7l (no AVX needed)
- System with glibc or musl (incl. Alpine linux and thus also Nextcloud AIO)
- ~4GB of free RAM (if you're cutting it close, make sure you have some swap available)
- This app is currently incompatible with the Suspicious Login app due to a dependency conflict (ie. you can only have one of the two installed)
Tmp
This app temporarily stores files to be recognized in /tmp. If you're using docker, you might find that adding an additional volume for /tmp speeds things up and eases the burden on your disk:
docker run: Add --mount type=tmpfs,destination=/tmp to command line.
docker compose: Add the following to the volume section docker-compose.yml:
app:
image: nextcloud:26
...
volumes:
- type: tmpfs
target: /tmp
...
...One click
Go to "Apps" in your nextcloud, search for "recognize" and click install.
Help: If one-click install fails
Configuration
Any configuration is done in Settings/Recognize of your Nextcloud instance.
Ignoring directories
If you want path/to/your/folder/* to be excluded from image recognition, add a file path/to/your/folder/.noimage. If you want to exclude it from music genre recognition, add a file path/to/your/folder/.nomusic. If you want to exclude it from video recognition, add a file path/to/your/folder/.novideo. If you want to exclude it from all recognition, add a file path/to/your/folder/.nomedia.
Manual install
Dependencies
Setup
cd /path/to/nextcloud/apps/
git clone https://github.com/marcelklehr/recognize.git
cd recognize
make
Maintainers
🛠️ State of maintenance
While there are some things that could be done to further improve this app, the app is currently maintained with limited effort. This means:
- The main functionality works for the majority of the use cases
- We will ensure that the app will continue to work like this for future releases and we will fix bugs that we classify as 'critical'
- We will not invest further development resources ourselves in advancing the app with new features
- We do review and enthusiastically welcome community PR's
We would be more than excited if you would like to collaborate with us. We will merge pull requests for new features and fixes. We also would love to welcome co-maintainers.
If you are a customer of Nextcloud and you have a strong business case for any development of this app, we will consider your wishes for our roadmap. Please contact your account manager to talk about the possibilities.
Contribute
We always welcome contributions. Have an issue or an idea for a feature? Let us know. Additionally, we happily accept pull requests.
In order to make the process run more smoothly, you can make sure of the following things:
- Announce that you're working on a feature/bugfix in the relevant issue
- Make sure the tests are passing
- If you have any questions you can let the maintainers above know privately via email, or simply open an issue on github
Please read the Code of Conduct. This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other.
More information on how to contribute: https://nextcloud.com/contribute/
Happy hacking
License
This software is licensed under the terms of the AGPL written by the Free Software Foundation and available at COPYING.
The recognize logo Smart tag by Xinh Studio from the Noun Project is licensed under a Creative Commons Attribution license.