|
1 | 1 | # Labelbox Python API
|
2 | 2 |
|
3 |
| -Labelbox is the training data workbench for ML teams. It allows you to label |
4 |
| -data with the fastest and most intuitive annotation tools. Visit |
5 |
| -https://labelbox.com/ for more information. |
| 3 | +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 http://labelbox.com/ for more information. |
6 | 4 |
|
7 |
| -The Labelbox Python API allows you to interact with Labelbox back-end in a |
8 |
| -simple, user-friendly way. |
| 5 | +The Labelbox Python API offers a simple, user-friendly way to interact with the Labelbox back-end. |
9 | 6 |
|
10 | 7 | ## Requirements
|
11 | 8 |
|
12 |
| -To use the Labelbox Python API you will need a Labelbox account. Once you login |
13 |
| -to the Labelbox web page, generate an API key as described in the documentation: |
14 |
| -https://labelbox.com/docs/api/api-keys. Store the key to a safe location. You |
15 |
| -will need it for using the Labelbox Python API. |
| 9 | +* Use Python 3.6 or 3.7. |
| 10 | +* Create an account by visiting http://app.labelbox.com/. |
| 11 | +* [Generate an API key](https://labelbox.com/docs/api/api-keys). |
16 | 12 |
|
17 |
| -## Installation |
| 13 | +## Installation & authentication |
18 | 14 |
|
19 |
| -Labelbox Python API can be installed using Python's Pip manager: |
| 15 | +1. Install using Python's Pip manager. |
20 | 16 | ```
|
21 | 17 | pip install labelbox
|
22 | 18 | ```
|
23 | 19 |
|
24 |
| -## Usage |
25 |
| - |
26 |
| -### API Key |
27 |
| - |
28 |
| -Your Labelbox API key is required to execute the library. It can be passed to |
29 |
| -Labelbox Python API via an environment variable `LABELBOX_API_KEY`. It is then |
30 |
| -automatically picked up by the `Client`: |
31 |
| -``` |
32 |
| -from labelbox import Client |
33 |
| -client = Client() # will use the API key from the environment variable |
| 20 | +2. Pass your API key as an environment variable. Then, import and initialize the API Client. |
34 | 21 | ```
|
| 22 | +user@machine:~$ export LABELBOX_API_KEY="<your api key here>" |
| 23 | +user@machine:~$ python3 |
35 | 24 |
|
36 |
| -Alternatively you can pass it to the `Client` object initialization: |
37 |
| -``` |
38 | 25 | from labelbox import Client
|
39 |
| -client = Client("<your_api_key_here>") |
40 |
| -``` |
41 |
| - |
42 |
| -### Basic commands |
43 |
| - |
44 |
| -The Labelbox Python API allows you to create, update and delete all standard |
45 |
| -Labelbox data types, such as Projects, Datasets, DataRows, Labels and others. |
46 |
| -For more info about the Labelbox data model please visit |
47 |
| -https://labelbox.com/docs. |
48 |
| - |
49 |
| -Here is an example code for uploading some data from scratch: |
50 |
| -``` |
51 |
| -from labelbox import Client |
52 |
| -
|
53 | 26 | client = Client()
|
54 |
| -
|
55 |
| -# Create a project and a dataset , automatically reflected on the server |
56 |
| -project = client.create_project(name="My Great Project") |
57 |
| -dataset = client.create_dataset(name="My Dataset") |
58 |
| -project.datasets.connect(dataset) |
59 |
| -
|
60 |
| -# Upload some files to the dataset |
61 |
| -task = dataset.create_data_rows(['file1.jpg', 'file2.jpg']) |
62 |
| -# Bulk DataRow creation might take a while on the server-side |
63 |
| -task.wait_till_done() |
64 |
| -
|
65 |
| -# Your data is now uploaded to Labelbox and ready for labeling! |
66 | 27 | ```
|
67 | 28 |
|
68 |
| -### Documentation and API specification |
| 29 | +## Documentation |
69 | 30 |
|
70 |
| -Documentation for the Labelbox Python Client package can be found at |
71 |
| -https://labelbox.helpdocs.io/docs/python-api. The API documentation |
72 |
| -is available at |
73 |
| -https://labelbox.helpdocs.io/docs/python-api/api-reference. |
| 31 | +[Visit our docs](https://labelbox.com/docs/python-api) to learn how to [create a project](https://labelbox.com/docs/python-api/create-first-project), read through some helpful user guides, and view our [API reference](https://labelbox.com/docs/python-api/api-reference). |
0 commit comments