IMGRecog.js
This is a small Node.js tool to scan and tag images using Google Vision, Clarifai and Sightengine.
Features
- support for 3 different computer vision APIs: Google Vision, Clarifai and Sightengine
- results (JSON) are handled as simple tags with a tag name and score (from 0 to 1)
- can detect objects, labels, landmarks, logos, brands and unsafe content
- actions to delete or move images according to certain criterias
- can be used via the command line or programatically
What about TensorFlow?
There are tons of great libraries and tools out there doing computer vision with TensorFlow, and the point here is not to reinvent the wheel.
Setup
To install globally on your machine please use:
$ npm install -g imgrecog.js
Or to install locally on your current project:
$ npm install imgrecog.js --save
Using the Google Vision API
You'll need to download your Google Cloud Vision API credentials file from the Google Cloud Console. If you need help please follow these instructions.
By default, the credentials file imgrecog.auth.json will be grabbed from the following locations:
- where the tool is installed
- current user's home folder
- current executing directory (highest priority)
You can specify the path to the credentials file using the googleKeyfile option, or via the command line arg --glgkeyfile.
Using the Clarifai API
If you want to process images with the Clarifai API, please get the API key for your app on the Portal. Set it via the option clarifaiKey, or via the command line arg --clakey.
Using the Sightengine API
If you want to process images with the Sightengine API, please get your API user and secret from your Dashboard. Set them via the options sightengineUser and sightengineSecret, or via the command line args --steuser and --stesecret.
Command line usage
$ imgrecog.js -[options] --[actions] folders
Detect logos on images in the current directory:
$ imgrecog.js --logos .
Delete unsafe and bloat images on user's home directory:
$ imgrecog.js --delunsafe --delbloat ~/
Detect everything, high API limits, and then move images to the "processed" folder.
$ imgrecog.js --deep --objects --labels --logos --landmarks --unsafe --limit 999999 --move ~/photos/processed ~/photos/camera
For help and the full list of options, ask for help:
$ imgrecog.js --help
Importing as a library
import ImgRecog from "imgrecog.js"
// const ImgRecog = require("imgrecog.js")
Options
The tool will look for a imgrecog.options.json file on the following places:
- where the tool is installed
- current user's home folder
- current executing directory
If not found, it will assume all the default options.
When running from the command line, all options should be passed as arguments, or via environment variables with the "IMGRECOG_" prefix (examples: IMGRECOG_LIMIT, IMGRECOG_VERBOSE etc).
extensions -e
File extensions should be scanned. Defaults to common image files: "png", "jpg", "jpeg", "gif", "bmp"
output -o
Full path to the output file with the scanning results. Defaults to imgrecog.results.json on the current folder.
limit -l
Limit API calls to the Google Vision API, as a safe $$ precaution. Defaults to 1000 calls per execution.
parallel -p
How many tasks can be executed in parallel. Defaults to 4.
deep -d
Include subfolders when scanning. Defaults to false.
verbose -v
Activate verbose mode with extra logging. Defaults to false.
authfile --auth
Path to the credentials file to authenticate with the Google Vision API. Defaults to imgrecog.auth.json on common folders.
sightengineUser --steuser
API user to be used for the Sightengine API. Defaults to none (disable Sightengine).
sightengineSecret --stesecret
API secret to be used for the Sightengine API. Defaults to none (disable Sightengine).
Detection features
objects --objects
Detect objects and things on the scanned images.
labels --labels
Detect labels and general tags on the scanned images.
landmarks --landmarks
Detect landmarks and famous locations on the scanned images.
logos --logos
Detect logos and brands on the scanned images.
unsafe --unsafe
Detect unsafe images with explicit content (adult, violence, medical, racy, spoof).
Actions
deleteBloat --delbloat
This will delete images:
- smaller than 50 KB
- having a very high score for any of the tags: "meme", "photo caption", "screenshot", "website", "explicit-spoof", plus a high conbined score counting the tags "advertising", "document", "map", "text"
deleteUnsafe --delunsafe
This will delete images:
- having a very high score for any of the tags: "explicit-adult", "explicit-violence", plus a high combined score also counting the tags "explicit-racy", "explicit-medical"
move --move
This will move all the scanned images to the specified folder, replicating their original path. For example if you set move to /var/photos/scanned, then an image /home/someuser/photos/dsc123.jpg will be moved to /var/photos/scanned/home/someuser/photos/dsc123.jpg.
Real world use cases
Coming soon...