Skip to main content

Labelbox Python API

Project description

Labelbox Python SDK

Labelbox is the enterprise-grade training data solution with fast AI enabled labeling tools, labeling automation, human workforce, data management, a powerful API for integration & SDK for extensibility. Visit Labelbox for more information.

The Labelbox Python API offers a simple, user-friendly way to interact with the Labelbox back-end.

Table of Contents

Requirements

Installation

Prerequisite: Install pip

pip is a package manager for Python. On macOS, you can set it up to use the default python3 install via -

curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3 get-pip.py

If the installation completes with a warning re: pip not being in your path, you'll need to add it by modifying your shell config (.zshrc, .bashrc or similar). You might have to modify the command below depending on the version of python3 on your machine.

export PATH=/Users/<your-macOS-username>/Library/Python/3.8/bin:$PATH

Install SDK locally, using Python's Pip manager

pip3 install -e .

Install dependencies

pip3 install -r requirements.txt

To install dependencies required for data processing modules use:

pip install "labelbox[data]"

Documentation

Authentication

Labelbox uses API keys to validate requests. You can create and manage API keys on Labelbox. Pass your API key as an environment variable. Then, import and initialize the API Client.

user@machine:~$ export LABELBOX_API_KEY="<your local api key here>"
user@machine:~$ python3

from labelbox import Client
client = Client()
  • Update api_key and endpoint if not using the production cloud deployment
# On prem
client = Client( endpoint = "<local deployment>")

# Local
client = Client(api_key=os.environ['LABELBOX_TEST_API_KEY_LOCAL'], endpoint="http://localhost:8080/graphql")

# Staging
client = Client(api_key=os.environ['LABELBOX_TEST_API_KEY_LOCAL'], endpoint="https://api.lb-stage.xyz/graphql")

Contribution

Please consult CONTRIB.md

Testing

  1. Update the Makefile with your local, staging, prod API key. Ensure that docker has been installed on your system. Make sure the key is not from a free tier account.
  2. To test on local:
user@machine:~$ export LABELBOX_TEST_API_KEY_LOCAL="<your local api key here>"
make test-local  # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_LOCAL=specify_here_or_export_me
  1. To test on staging:
user@machine:~$ export LABELBOX_TEST_API_KEY_STAGING="<your staging api key here>"
make test-staging # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_STAGING=specify_here_or_export_me
  1. To test on prod:
user@machine:~$ export LABELBOX_TEST_API_KEY_PROD="<your prod api key here>"
make test-prod # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_PROD=specify_here_or_export_me
  1. If you make any changes and need to rebuild the image used for testing, force a rebuild with the -B flag
make -B {build|test-staging|test-prod}
  1. Testing against Delegated Access will be skipped unless the local env contains the key: DA_GCP_LABELBOX_API_KEY. These tests will be included when run against a PR. If you would like to test it manually, please reach out to the Devops team for information on the key.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

labelbox-3.46.0.tar.gz (161.7 kB view details)

Uploaded Source

Built Distribution

labelbox-3.46.0-py3-none-any.whl (208.3 kB view details)

Uploaded Python 3

File details

Details for the file labelbox-3.46.0.tar.gz.

File metadata

  • Download URL: labelbox-3.46.0.tar.gz
  • Upload date:
  • Size: 161.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for labelbox-3.46.0.tar.gz
Algorithm Hash digest
SHA256 31bc090a8a98e79223a6873cad4b55e648f9e3dcc13636df0c2828d65a4fbe00
MD5 5a356b36c5df33fa34f17bcb3934478f
BLAKE2b-256 8db0986a1eca325a42d6a5c015fadbdfa9e8bd4ffb59fba04146a6090b2da53d

See more details on using hashes here.

File details

Details for the file labelbox-3.46.0-py3-none-any.whl.

File metadata

  • Download URL: labelbox-3.46.0-py3-none-any.whl
  • Upload date:
  • Size: 208.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for labelbox-3.46.0-py3-none-any.whl
Algorithm Hash digest
SHA256 826ba793b486e7c6a6ed977aeb0da339819cb55f6ca36169393d2c6ac0b53aec
MD5 346204dba69e32066e6aa688ad97aa2d
BLAKE2b-256 9a1b340a38bf96f3710dcb9ca1974924db0fd0a026b3243cbf3f9454e4b0ce10

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page