Skip to content

Latest commit

 

History

History
67 lines (40 loc) · 3.14 KB

README.md

File metadata and controls

67 lines (40 loc) · 3.14 KB
Raw

perception

A Wordpress Plugin which classifies Media Library images by detecting individual objects and faces within images using Google Cloud Vision API.

Installation

This repository is the source code and won't work on your website, if you are looking for the plugin itself you can download the latest version from here.

Features

Detects broad sets of categories within an image, which range from modes of transportation to animals, popular product logos, popular natural and man-made structures, topical entities like celebrities, or news events.

Working Demo

Requirements

Local Development

Docker is all you need for local development. With the docker daemon running, build and run the application using:

make start

the above command will build the image for both Wordpress and MySQL and run the containers and install Composer dependencies inside src folder.

Your Wordpress instance will be available on http://localhost:8000

To see the full list of available commands run make help

Important Notes

Please note that Google Cloud Vision API is a commercial service and while it's free for first 1000 units/month but you will be charged for any request after that. See their pricing here.

To better understand their pricing table, here is the list of the features we use in this plugin:

  • Label Detection
  • Landmark Detection
  • Logo Detection
  • Web Detection

Set up your project

  1. In the Cloud Platform Console, go to the Manage resources page and select or create a new project. Link
  2. Enable billing for your project. Link
  3. Enable the Cloud Vision API. Link

Authentication

For using this plugin, You need to provide a JSON file which contains your Project ID and Key. By following the steps below you can obtain them.

  1. In Cloud Platform Console, navigate to the Create service account key page.
  2. From the Service account dropdown, select New service account.
  3. Input a name into the Service account name form field.
  4. From the Role dropdown, select Project > Owner.
  5. Click the Create button. A JSON file that contains your key downloads to your computer.

Keep the JSON file on your computer, you will need it during the plugin installation.

Contributing

Contributions are welcome. Create a pull request to get started.

Issues

Please report any issues here.