Skip to content

Commit 13bdba8

Browse files
msokoloff1msokoloff1
authored
Merge pull request #132 from Labelbox/develop
2.5.3 Release
2 parents 4bf87e0 + 44e94cd commit 13bdba8

28 files changed

+5075
-4644
lines changed

‎CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Changelog
22

3+
# Version 2.5.3 (2021-04-01)
4+
## Added
5+
* Cleanup and add additional example notebooks
6+
* Improved README for SDK and examples
7+
* Easier to retrieve per annotation `BulkImportRequest` status, errors, and inputs
8+
* See `BulkImportRequest.errors`, `BulkImportRequest.statuses`, `BulkImportRequest.inputs` for more information
9+
310
# Version 2.5.2 (2021-03-25)
411
## Fix
512
* Ontology builder defaults to None for missing fields instead of empty lists

‎README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,27 @@
11
# Labelbox Python SDK
22

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.
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 [Labelbox](http://labelbox.com/) for more information.
44

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

7+
## Table of Contents
8+
9+
* [Requirements](#requirements)
10+
* [Installation](#installation)
11+
* [Authentication](#authentication)
12+
* [Documentation](#documentation)
13+
* [Contribution](#contribution)
14+
* [Testing](#testing)
15+
716
## Requirements
817

9-
* Use Python 3.6, 3.7 or 3.8.
10-
* Create an account by visiting http://app.labelbox.com/.
11-
* [Generate an API key](https://labelbox.com/docs/api/getting-started#create_api_key).
18+
* Use Python 3.6, 3.7 or 3.8
19+
* [Create an account](http://app.labelbox.com/)
20+
* [Generate an API key](https://labelbox.com/docs/api/getting-started#create_api_key)
1221

13-
## Installation & authentication
22+
## Installation
1423

15-
0. Prerequisite: Install pip
24+
Prerequisite: Install pip
1625

1726
`pip` is a package manager for Python. **On macOS**, you can set it up to use the default python3 install via -
1827
```
@@ -26,12 +35,15 @@ If the installation completes with a warning re: pip not being in your path, you
2635
export PATH=/Users/<your-macOS-username>/Library/Python/3.8/bin:$PATH
2736
```
2837

29-
1. Install using Python's Pip manager.
38+
Install using Python's Pip manager.
3039
```
3140
pip install labelbox
3241
```
3342

34-
2. Pass your API key as an environment variable. Then, import and initialize the API Client.
43+
## Authentication
44+
45+
Labelbox uses API keys to validate requests. You can create and manage API keys on [Labelbox](https://app.labelbox.com/account/api-keys). Pass your API key as an environment variable. Then, import and initialize the API Client.
46+
3547
```
3648
user@machine:~$ export LABELBOX_API_KEY="<your api key here>"
3749
user@machine:~$ python3
@@ -44,7 +56,7 @@ client = Client()
4456

4557
[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).
4658

47-
## Repo Organization and Contribution
59+
## Contribution
4860
Please consult `CONTRIB.md`
4961

5062
## Testing

‎examples/README.md

Lines changed: 43 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,47 @@
11
## Labelbox SDK Examples
22

33
* Learn how to use the SDK by following along
4+
* Run in google colab, view the notebooks on github, or clone the repo and run locally
45

5-
Structure:
6-
7-
1. basics
8-
* [Fundamentals](basics/basics.ipynb)
9-
* CRUD
10-
* [Data rows](basics/data_rows.ipynb)
11-
* [Datasets](basics/datasets.ipynb)
12-
* [Labels](basics/labels.ipynb)
13-
* [Ontologies](basics/ontologies.ipynb)
14-
* [Projects](basics/projects.ipynb)
15-
2. label_export
16-
* [Image annotation export](label_export/images.ipynb)
17-
* [Text annotation export](label_export/text.ipynb)
18-
* [Video annotation export](label_export/video.ipynb)
19-
3. model_assisted_labeling
20-
* [Image mal example](model_assisted_labeling/image_mal.ipynb)
21-
* [Named entity recognition mal example](model_assisted_labeling/ner_mal.ipynb)
22-
* [Debugging mal](model_assisted_labeling/debugging_mal.ipynb)
23-
4. project_configuration
24-
* [Project setup](project_configuration/project_setup.ipynb)
25-
* [Queue management](project_configuration/queue_management.ipynb)
26-
* [Webhooks](project_configuration/webhooks.ipynb)
6+
7+
------
8+
9+
## [Basics](basics)
10+
11+
| Notebook | Github | Google Colab |
12+
| --------------------------- | --------------------------------- | ------------ |
13+
| Fundamentals | [Github](basics/basics.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/basics/basics.ipynb) |
14+
| Data Rows | [Github](basics/data_rows.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/basics/data_rows.ipynb) |
15+
| Datasets | [Github](basics/datasets.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/basics/datasets.ipynb) |
16+
| Labels | [Github](basics/labels.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/basics/labels.ipynb) |
17+
| Ontologies | [Github](basics/ontologies.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/basics/ontologies.ipynb) |
18+
| Projects | [Github](basics/projects.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/basics/projects.ipynb) |
19+
------
20+
21+
## [Label Export](label_export)
22+
23+
| Notebook | Github | Google Colab |
24+
| --------------------------- | --------------------------------- | ------------ |
25+
| Image Annotation Export | [Github](label_export/images.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/label_export/images.ipynb) |
26+
| Text Annotation Export | [Github](label_export/text.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/label_export/text.ipynb) |
27+
| Video Annotation Export | [Github](label_export/video.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/label_export/video.ipynb) |
28+
------
29+
30+
## [Model Assisted Labeling](model_assisted_labeling)
31+
32+
| Notebook | Github | Google Colab |
33+
| --------------------------- | --------------------------------- | ------------ |
34+
| MAL Basics | [Github](model_assisted_labeling/mal_basics.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/model_assisted_labeling/mal_basics.ipynb) |
35+
| Image MAL | [Github](model_assisted_labeling/image_mal.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/model_assisted_labeling/image_mal.ipynb) |
36+
| Named Entity Recognition MAL | [Github](model_assisted_labeling/ner_mal.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/model_assisted_labeling/ner_mal.ipynb) |
37+
| Debugging MAL | [Github](model_assisted_labeling/debugging_mal.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/model_assisted_labeling/debugging_mal.ipynb) |
38+
| MAL with Subclasses | [Github](model_assisted_labeling/mal_with_subclasses.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/model_assisted_labeling/mal_with_subclasses.ipynb) |
39+
------
40+
41+
## [Project Configuration](project_configuration)
42+
43+
| Notebook | Github | Google Colab |
44+
| --------------------------- | --------------------------------- | ------------ |
45+
| Project Setup | [Github](project_configuration/project_setup.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/project_configuration/project_setup.ipynb) |
46+
| Debugging MAL | [Github](project_configuration/queue_management.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/project_configuration/queue_management.ipynb) |
47+
| MAL with Subclasses | [Github](project_configuration/webhooks.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/project_configuration/webhooks.ipynb) |

0 commit comments

Comments
 (0)