clarifai 8.12.0rc5

Clarifai Python Utilities

clarifai-python-utils

This is the official Clarifai Python utilities project. This repo includes higher level convenience classes, functions, and scripts to make using our API easier. This is built on top of the Clarifai Python gRPC Client.

• Try the Clarifai demo at: https://clarifai.com/demo
• Sign up for a free account at: https://clarifai.com/signup
• Read the documentation at: https://docs.clarifai.com/

Installation

pip install -U clarifai

Installation from source (for development)

python -m venv ~/virtualenv/clarifai-python-utils
source ~/virtualenv/clarifai-python-utils/bin/activate
cd clarifai-python-utils
python setup.py develop

Versioning

This library doesn't use semantic versioning. The first two version numbers (X.Y out of X.Y.Z) follow the API (backend) versioning, and whenever the API gets updated, this library follows it.

The third version number (Z out of X.Y.Z) is used by this library for any independent releases of library-specific improvements and bug fixes.

Getting started

Here is a quick example of listing all the concepts in an application.

Set some env vars first

export CLARIFAI_USER_ID={the user_id of the app_id of the app you want to access resources in}
export CLARIFAI_APP_ID={the app_id of the app you want to access resources in}
export CLARIFAI_PAT={your personal access token}

from clarifai.client import create_stub
from clarifai.listing.lister import ClarifaiResourceLister

# Create a client with auth information from those env vars.
stub = create_stub()

# Create the resource lister.
lister = ClarifaiResourceLister(stub, auth.user_id, auth.app_id, page_size=16)

# List all the concepts in the app:
concepts = []
for c in lister.concepts_generator():
  concepts.append(c)

Testing

pip install tests/requirements.txt
pytest tests/

Linting

The repo will be linted when changed in a github workflow. To speed up development it's recommended to install pre-commit and tools

pip install -r requirements-dev.txt
pre-commit install

You could run all checks by

pre-commit run --all-files