Skip to content

Commit 7390210

Browse files
authored
Merge pull request #420 from Labelbox/develop
3.13.0
2 parents a7e9fd4 + b9c30fe commit 7390210

File tree

81 files changed

+8534
-10802
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+8534
-10802
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
11
# Changelog
2+
# Version 3.12.1 (2022-02-07)
3+
## Added
4+
* Added `from_shapely` method to create annotation types from Shapely objects
5+
* Added `start` and `end` filter on the following methods
6+
- `Project.export_labels()`
7+
- `Project.label_generator()`
8+
- `Project.video_label_generator()`
9+
* Improved type hinting
10+
11+
212
# Version 3.12.0 (2022-01-19)
313
## Added
414
* Tiled Imagery annotation type

README.md

Lines changed: 19 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,16 @@ The Labelbox Python API offers a simple, user-friendly way to interact with the
1818

1919
## Requirements
2020

21-
* Use Python 3.6, 3.7 or 3.8
22-
* [Create an account](http://app.labelbox.com/)
23-
* [Generate an API key](https://labelbox.com/docs/api/getting-started#create_api_key)
21+
- Use Python 3.6, 3.7 or 3.8
22+
- [Create an account](http://app.labelbox.com/)
23+
- [Generate an API key](https://labelbox.com/docs/api/getting-started#create_api_key)
2424

2525
## Installation
2626

2727
Prerequisite: Install pip
2828

2929
`pip` is a package manager for Python. **On macOS**, you can set it up to use the default python3 install via -
30+
3031
```
3132
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
3233
python3 get-pip.py
@@ -39,55 +40,28 @@ export PATH=/Users/<your-macOS-username>/Library/Python/3.8/bin:$PATH
3940
```
4041

4142
Install SDK locally, using Python's Pip manager
43+
4244
```
4345
pip3 install -e .
4446
```
4547

4648
Install dependencies
47-
```
48-
pip3 install -r requirements.txt
49-
```
50-
To install dependencies required for data processing modules use:
51-
```
52-
pip install labelbox[data]
53-
```
54-
### Note for Windows users
55-
The package `rasterio` installed by `labelbox[data]` relies on GDAL which could be difficult to install on Microsoft Windows.
56-
57-
You may see the following error message:
5849

5950
```
60-
INFO:root:Building on Windows requires extra options to setup.py to locate needed GDAL files. More information is available in the README.
61-
62-
ERROR: A GDAL API version must be specified. Provide a path to gdal-config using a GDAL_CONFIG environment variable or use a GDAL_VERSION environment variable.
51+
pip3 install -r requirements.txt
6352
```
6453

65-
As a workaround:
66-
67-
1. Download the binary files for GDAL and rasterio:
68-
69-
a. From https://www.lfd.uci.edu/~gohlke/pythonlibs/#gdal, download `GDAL‑3.3.2‑cp38‑cp38‑win_amd64.wh`
70-
71-
b. From https://www.lfd.uci.edu/~gohlke/pythonlibs/#rasterio, download `rasterio‑1.2.9‑cp38‑cp38‑win_amd64.whl`
72-
73-
Note: You need to download the right files for your Python version. In the files above `cp38` means CPython 3.8.
74-
75-
2. After downloading the files, please run the following commands, in this particular order.
54+
To install dependencies required for data processing modules use:
7655

7756
```
78-
pip install GDAL‑3.3.2‑cp38‑cp38‑win_amd64.wh
79-
pip install rasterio‑1.2.9‑cp38‑cp38‑win_amd64.whl
8057
pip install labelbox[data]
8158
```
8259

83-
This should resolve the error message.
84-
85-
8660
## Documentation
8761

88-
* [Visit our docs](https://labelbox.com/docs/python-api) to learn how the SDK works
89-
* Checkout our [notebook examples](examples/) to follow along with interactive tutorials
90-
* view our [API reference](https://labelbox.com/docs/python-api/api-reference).
62+
- [Visit our docs](https://labelbox.com/docs/python-api) to learn how the SDK works
63+
- Checkout our [notebook examples](examples/) to follow along with interactive tutorials
64+
- view our [API reference](https://labelbox.com/docs/python-api/api-reference).
9165

9266
## Authentication
9367

@@ -100,7 +74,9 @@ user@machine:~$ python3
10074
from labelbox import Client
10175
client = Client()
10276
```
103-
* Update api_key and endpoint if not using the production cloud deployment
77+
78+
- Update api_key and endpoint if not using the production cloud deployment
79+
10480
```
10581
# On prem
10682
client = Client( endpoint = "<local deployment>")
@@ -113,29 +89,35 @@ client = Client(api_key=os.environ['LABELBOX_TEST_API_KEY_LOCAL'], endpoint="htt
11389
```
11490

11591
## Contribution
92+
11693
Please consult `CONTRIB.md`
11794

11895
## Testing
96+
11997
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.
12098
2. To test on `local`:
99+
121100
```
122101
user@machine:~$ export LABELBOX_TEST_API_KEY_LOCAL="<your local api key here>"
123102
make test-local # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_LOCAL=specify_here_or_export_me
124103
```
125104

126105
3. To test on `staging`:
106+
127107
```
128108
user@machine:~$ export LABELBOX_TEST_API_KEY_STAGING="<your staging api key here>"
129109
make test-staging # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_STAGING=specify_here_or_export_me
130110
```
131111

132112
4. To test on `prod`:
113+
133114
```
134115
user@machine:~$ export LABELBOX_TEST_API_KEY_PROD="<your prod api key here>"
135116
make test-prod # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_PROD=specify_here_or_export_me
136117
```
137118

138119
5. If you make any changes and need to rebuild the image used for testing, force a rebuild with the `-B` flag
120+
139121
```
140122
make -B {build|test-staging|test-prod}
141123
```

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Train a model using data annotated on Labelbox
3535

3636
| Notebook | Github | Google Colab |
3737
| --------------------------- | --------------------------------- | ------------ |
38-
| Object Detection (Detectron2) | [Github](coco_object.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/integrations/detectron2/coco_panoptic.ipynb) |
38+
| Object Detection (Detectron2) | [Github](coco_object.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/integrations/detectron2/coco_object.ipynb) |
3939
| Panoptic Detection (Detectron2) | [Github](coco_panoptic.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/integrations/detectron2/coco_panoptic.ipynb)
4040
------
4141

0 commit comments

Comments
 (0)