Skip to content

Commit c1a3ac2

Browse files
Updated composite notebook (#1672)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 714f7b1 commit c1a3ac2

File tree

1 file changed

+12
-20
lines changed

1 file changed

+12
-20
lines changed

examples/exports/composite_mask_export.ipynb

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,20 @@
3535
"\n",
3636
"Composite masks are a combination of mask instances grouped in a single mask URL. \n",
3737
"\n",
38-
"The purpose of this demo is to demonstrate how to transition from exporting single masks to exporting composite masks. "
38+
"This demo aims to demonstrate how to transition from exporting single masks to exporting composite masks. "
3939
],
4040
"cell_type": "markdown"
4141
},
4242
{
4343
"metadata": {},
4444
"source": [
45-
"## Imports"
45+
"## Set up"
4646
],
4747
"cell_type": "markdown"
4848
},
4949
{
5050
"metadata": {},
51-
"source": "%pip install -q \"labelbox[data]\"",
51+
"source": "%pip install -q --upgrade \"labelbox[data]\"",
5252
"cell_type": "code",
5353
"outputs": [],
5454
"execution_count": null
@@ -63,14 +63,14 @@
6363
{
6464
"metadata": {},
6565
"source": [
66-
"## API Key and Client\n",
67-
"See the developer guide for [creating an API key](https://docs.labelbox.com/reference/create-api-key)."
66+
"## API key and client\n",
67+
"Provide a valid API key below to properly connect to the Labelbox client. Please review [Create API key guide](https://docs.labelbox.com/reference/create-api-key) for more information."
6868
],
6969
"cell_type": "markdown"
7070
},
7171
{
7272
"metadata": {},
73-
"source": "API_KEY = \"\"\nclient = lb.Client(api_key=API_KEY)\nclient.enable_experimental = (\n True ## This is required if using the export() streamable method\n)",
73+
"source": "API_KEY = None\nclient = lb.Client(api_key=API_KEY)",
7474
"cell_type": "code",
7575
"outputs": [],
7676
"execution_count": null
@@ -85,10 +85,10 @@
8585
{
8686
"metadata": {},
8787
"source": [
88-
"#### Composite masks\n",
88+
"### Composite masks\n",
8989
"**IMPORTANT :** The URL for the ```composite_mask``` from exports older than 30 days will no longer be accessible. To obtain a functional URL after this period, please generate a new export for the mask.\n",
90-
"1. A single mask url contains all mask instances from a single label. For videos a composite mask contains all mask instances for the frame in each label. \n",
91-
"2. The export and mask URL adhere to the following convention:\n",
90+
"1. A composite URL contains all mask instances from a single label. For videos a composite mask contains all mask instances per frame in each label. \n",
91+
"2. The export and mask URL adheres to the following convention:\n",
9292
" - ***Image example***\n",
9393
"```json \n",
9494
" {\n",
@@ -157,16 +157,8 @@
157157
{
158158
"metadata": {},
159159
"source": [
160-
"---"
161-
],
162-
"cell_type": "markdown"
163-
},
164-
{
165-
"metadata": {},
166-
"source": [
167-
"#### Single mask instance:\n",
168-
"We are planning on removing single mask instances, but for now they will be displayed adjecent to the composite mask.\n",
169-
"1. A single mask instance and mask url is generated for each individual annotation for each label.\n",
160+
"### Single mask instance:\n",
161+
"1. A single mask instance and mask url is generated for each individual annotation per label.\n",
170162
"2. The export and mask URL adhere to the following convention: \n",
171163
"```json\n",
172164
" {\n",
@@ -183,7 +175,7 @@
183175
{
184176
"metadata": {},
185177
"source": [
186-
"## Create an export from an Image project with mask annotations\n",
178+
"## Create an export from a project with mask annotations\n",
187179
"To better showcase composite masks, make sure you have different mask tools and mask annotations in your project"
188180
],
189181
"cell_type": "markdown"

0 commit comments

Comments
 (0)