Skip to content
/ tagid Public

Get started with PiktID's API for developers. This repository explains how to integrate TagID, a product which provides high quality captions and keywords.

Notifications You must be signed in to change notification settings

piktid/tagid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

TagID by PiktID logo

TagID by PiktID

TagID

Official Website Discord Follow

TagID is a GenAI tagging tool which produces accurate textual descriptions of images.

About

TagID utilizes generative models to intelligently describe and annotate images. It can be extremely powerful in the following scenarios:

  • Image keywording: It provides quick and accurate keywords to facilitate storing of your images.
  • Image captioning: It provides precise short and long captions which can be use to help users understand what is the message of the image.

Getting Started

Open In Colab

The following instructions suppose you have already installed a recent version of Python. For a general overview, please visit the API documentation. To use any PiktID API, an access token is required.

Step 0 - Register here. 10 credits are given for free to all new users.

Step 1 - Clone the TagID library

# Installation commands
$ git clone https://github.com/piktid/tagid.git
$ cd tagid
$ pip install -r requirements.txt

Step 2 - Export the email and password as environmental variables

$ export TAGID_EMAIL={Your email here}
$ export TAGID_PASSWORD={Your password here}

Step 3 - Change in main.py the URL of the image to be described or pass it as argument

...
url = 'your-url'
...

Step 4 - Run the main function

$ python3 main.py --url 'your-url'

You can also pass the path to the local file

$ python3 main.py --filepath 'your/path/to/the/file'

Without any additional argument, TagID provides keywords and captions. However, you can also ask questions about the image as in the following:

$ python3 main.py --question 'What is the subject of the image?'

Contact

[email protected]

About

Get started with PiktID's API for developers. This repository explains how to integrate TagID, a product which provides high quality captions and keywords.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages