Labelbox

With Labelbox, enterprises can easily curate and annotate data, generate high-quality human feedback data for computer vision and language models, evaluate and improve model performance, and automate tasks by seamlessly combining AI and human-centric workflows. The academic and research community also relies on Labelbox for cutting-edge AI research and experimentation.

Visit Labelbox for more information.

Table of Contents

• Quick Start
• Contribution Guidelines
• Develop with AI Assistance
• Documentation
• Jupyter Notebooks

Quick Start

Sign Up

If you haven't already, create a free account at Labelbox.

Generate an API key

Log into Labelbox and navigate to Account > API Keys to generate an API key.

Install

To install the SDK, run the following command.

pip install labelbox

If you'd like to install the SDK with enhanced functionality, which additional optional capabilities surrounding data processing, run the following command.

pip install "labelbox[data]"

Please note that if you prefer to build and install your own version of the SDK, it is important to be aware that only tagged commits have been thoroughly tested. Building from the head of develop branch carries some level of risk.

Validate Installation and API Key

After installing the SDK and getting an API Key, it's time to validate them both.

import labelbox as lb

client = lb.Client(API_KEY) # API_KEY = API Key generated from labelbox.com
dataset = client.create_dataset(name="Test Dataset")
data_rows = [{"row_data": "My First Data Row", "global_key": "first-data-row"}]
task = dataset.create_data_rows(data_rows)
task.wait_till_done()

You should be set! Running the snippet above should create a dataset called Test Dataset with its content being My First Data Row. You can log into Labelbox to verify this. If you have any issues please file a Github Issue or contact Labelbox Support directly. For more advanced examples and information on the SDK, see Documentation below.

Contribution Guidelines

We encourage anyone to contribute to this repository to help improve it. Please refer to Contributing Guide for detailed information on how to contribute. This guide also includes instructions for how to build and run the SDK locally.

Documentation

The SDK is well-documented to help developers get started quickly and use the SDK effectively. Here are links to that documentation:

• Labelbox Official Documentation
• Jupyter Notebook Examples
• Python SDK Reference

Jupyter Notebooks

We have samples in the examples directory to help you get started with the SDK.

Make sure your notebook will use your source code:

1. ipython profile create
2. ipython locate - will show where the config file is. This is the config file used by the Jupyter server, since it runs via ipython
3. Open the file (this should be ipython_config.py and it is usually located in ~/.ipython/profile_default) and add the following line of code:

c.InteractiveShellApp.exec_lines = [
  'import sys; sys.path.insert(0, "<labelbox-python root folder>")'
]

4. Go to the root of your project and run jupyter notebook to start the server.

Provenance

To enhance the software supply chain security of Labelbox's users, every Labelbox SDK release is built by the publish workflow and comes with signed build provenance:

• A SLSA Level 3 Provenance document (multiple.intoto.jsonl) attached to the GitHub release.
• A GitHub artifact attestation for the wheel and sdist, which records the repository, workflow and commit that built them.
• A PyPI attestation for each file published to PyPI.

Verifying the provenance confirms that the package was built from this repository by our release workflow and has not been tampered with. For example, for the wheel of a given release:

export VERSION=<version> # sdk release version
export TAG=v${VERSION} # github tag
pip download --no-deps labelbox==${VERSION}

# GitHub attestation, with the GitHub CLI
gh attestation verify ./labelbox-${VERSION}-py3-none-any.whl \
  --repo Labelbox/labelbox-python \
  --signer-workflow Labelbox/labelbox-python/.github/workflows/publish.yml

# SLSA provenance, with slsa-verifier
curl --location -O \
  https://github.com/Labelbox/labelbox-python/releases/download/${TAG}/multiple.intoto.jsonl
slsa-verifier verify-artifact --source-branch develop \
  --source-uri "git+https://github.com/Labelbox/labelbox-python" \
  --provenance-path multiple.intoto.jsonl ./labelbox-${VERSION}-py3-none-any.whl

GitHub attestations start with the first release after v7.17.0. Releases v7.7.0 through v7.17.0 have only the PyPI attestation, because the SLSA provenance upload was broken for them. Releases v.3.72.2 through v7.6.0 have the SLSA provenance and verify the same way.