Description of Labelbox-Python SDK and our developer guides.
Welcome to Labelbox-Python SDK developer guides! The Labelbox-Python SDK is an open-source project that provides access to the Labelbox API and can automate many actions and workflows in the Labelbox app. The SDK’s source code can be found on our Github page. For a complete granular API reference, visit our readthedocs page.
SDK versions earlier than 3.68 are no longer supported. Please update to a supported version to maintain compatibility.
To install, run either pip install labelbox
orpip install "labelbox[data]"
in your command line.
Module | Description |
---|---|
"labelbox[data]" | Installs all required dependencies (libraries, tools to manipulate annotations, and more.) |
labelbox | Installs all required libraries for client-only functionality |
For more in-depth installation information, please visit our installation guide .
Our developer documentation is designed to help you understand the different methods in the Labelbox-Python SDK. You are encouraged to run the code blocks locally as you read through the guides. Some guides include links to Google Colab Notebooks and our GitHub repository at the top of the page. These links allow you to run Python code quickly, demonstrating how specific methods work and providing example workflows.
To get the best experience from the SDK, we recommend the following:
Always use bulk operations. Unless you are testing or working on small datasets, use bulk operations for faster and more reliable performance.
create_data_rows
instead of create_data_row
project.export()
instead of project.labels()
Label.bulk_delete(labels)
instead of [label.delete() for label in labels]
Use get_one()
and get_many()
methods to get elements of a paginated collection instead of list
.
list(dataset.data_rows())[0]
is going to query for every single data_row
in your dataset.Make sure to use the latest version of the SDK.
GraphQL APIs may be updated or deprecated at any time without notice. For this reason, Labelbox strongly advises that customers use the Python SDK for all development.
Labelbox has a dedicated community page that hosts discussions over a variety of Labelbox workflows and functionalities, including topics about our main platform and Labelbox-Python SDK. You can find our community page using this link. Please feel free to contribute to our community. On this page, you can also find How-To guides from Labelbox employees that discuss some topics in more detail.
To learn how to contribute towards the Labelbox-Python SDK and our example notebooks, refer to our dedicated contributing guide .
For feedback or to report any issues with our documentation, please email docs@labelbox.com .