Skip to content

Commit f27ed21

Browse files
author
Matt Sokoloff
committed
formatted, added table to readme, small style changes
1 parent b187d96 commit f27ed21

19 files changed

+144
-5644
lines changed

‎examples/README.md‎

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,44 @@
55

66
### Tutorials:
77

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

‎examples/basics/basics.ipynb‎

Lines changed: 19 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
},
3737
{
3838
"cell_type": "code",
39-
"execution_count": null,
39+
"execution_count": 1,
4040
"id": "indie-bracket",
4141
"metadata": {},
4242
"outputs": [],
@@ -59,7 +59,7 @@
5959
},
6060
{
6161
"cell_type": "code",
62-
"execution_count": 4,
62+
"execution_count": 3,
6363
"id": "crude-receiver",
6464
"metadata": {},
6565
"outputs": [],
@@ -101,7 +101,7 @@
101101
},
102102
{
103103
"cell_type": "code",
104-
"execution_count": 6,
104+
"execution_count": 4,
105105
"id": "instructional-reply",
106106
"metadata": {},
107107
"outputs": [],
@@ -125,7 +125,7 @@
125125
},
126126
{
127127
"cell_type": "code",
128-
"execution_count": 7,
128+
"execution_count": 5,
129129
"id": "thick-gasoline",
130130
"metadata": {},
131131
"outputs": [],
@@ -135,7 +135,7 @@
135135
},
136136
{
137137
"cell_type": "code",
138-
"execution_count": 8,
138+
"execution_count": 6,
139139
"id": "victorian-consumer",
140140
"metadata": {},
141141
"outputs": [],
@@ -147,7 +147,7 @@
147147
},
148148
{
149149
"cell_type": "code",
150-
"execution_count": 9,
150+
"execution_count": 7,
151151
"id": "industrial-onion",
152152
"metadata": {},
153153
"outputs": [
@@ -178,7 +178,7 @@
178178
},
179179
{
180180
"cell_type": "code",
181-
"execution_count": 12,
181+
"execution_count": 8,
182182
"id": "guided-institute",
183183
"metadata": {},
184184
"outputs": [
@@ -208,7 +208,7 @@
208208
},
209209
{
210210
"cell_type": "code",
211-
"execution_count": 13,
211+
"execution_count": 9,
212212
"id": "according-subdivision",
213213
"metadata": {},
214214
"outputs": [],
@@ -229,7 +229,7 @@
229229
},
230230
{
231231
"cell_type": "code",
232-
"execution_count": 17,
232+
"execution_count": 10,
233233
"id": "ideal-processing",
234234
"metadata": {},
235235
"outputs": [
@@ -251,26 +251,15 @@
251251
},
252252
{
253253
"cell_type": "code",
254-
"execution_count": 19,
254+
"execution_count": null,
255255
"id": "convinced-force",
256256
"metadata": {},
257-
"outputs": [
258-
{
259-
"data": {
260-
"text/plain": [
261-
"<Label ID: cklw9cboq00063h68gqrsvi15>"
262-
]
263-
},
264-
"execution_count": 19,
265-
"metadata": {},
266-
"output_type": "execute_result"
267-
}
268-
],
257+
"outputs": [],
269258
"source": [
270-
"# Note that if you selected a project_id without any labels this will raise StopIteration\n",
259+
"# Note that if you selected a `project_id` without any labels this will raise `StopIteration`\n",
271260
"# Iterate over them to get the items out.\n",
272261
"next(labels_paginated_collection)\n",
273-
"# Be careful not to call list(paginated_collection) on a large collection"
262+
"# list(paginated...) should be avoided for queries that could return more than a dozen results"
274263
]
275264
},
276265
{
@@ -285,7 +274,7 @@
285274
},
286275
{
287276
"cell_type": "code",
288-
"execution_count": 28,
277+
"execution_count": 12,
289278
"id": "cubic-joint",
290279
"metadata": {},
291280
"outputs": [
@@ -307,7 +296,7 @@
307296
" where=((Project.name == PROJECT_NAME) &\n",
308297
" (Project.description == \"new description field\")))\n",
309298
"\n",
310-
"# The above two queries return PaginatedCollections because the filter parameters aren't guarenteed to be unique.\n",
299+
"# The above two queries return PaginatedCollections because the filter parameters aren't guaranteed to be unique.\n",
311300
"# So even if there is one element returned it is in a paginatedCollection.\n",
312301
"print(projects)\n",
313302
"print(next(projects, None))\n",
@@ -341,7 +330,7 @@
341330
},
342331
{
343332
"cell_type": "code",
344-
"execution_count": 31,
333+
"execution_count": 13,
345334
"id": "handmade-yugoslavia",
346335
"metadata": {},
347336
"outputs": [
@@ -364,7 +353,7 @@
364353
},
365354
{
366355
"cell_type": "code",
367-
"execution_count": 32,
356+
"execution_count": 14,
368357
"id": "future-bargain",
369358
"metadata": {},
370359
"outputs": [
@@ -395,7 +384,7 @@
395384
},
396385
{
397386
"cell_type": "code",
398-
"execution_count": 37,
387+
"execution_count": 15,
399388
"id": "persistent-briefs",
400389
"metadata": {},
401390
"outputs": [],
@@ -417,7 +406,7 @@
417406
},
418407
{
419408
"cell_type": "code",
420-
"execution_count": null,
409+
"execution_count": 16,
421410
"id": "thirty-interval",
422411
"metadata": {},
423412
"outputs": [],

0 commit comments

Comments
 (0)