|
35 | 35 | "\n",
|
36 | 36 | "Composite masks are a combination of mask instances grouped in a single mask URL. \n",
|
37 | 37 | "\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. " |
39 | 39 | ],
|
40 | 40 | "cell_type": "markdown"
|
41 | 41 | },
|
42 | 42 | {
|
43 | 43 | "metadata": {},
|
44 | 44 | "source": [
|
45 |
| - "## Imports" |
| 45 | + "## Set up" |
46 | 46 | ],
|
47 | 47 | "cell_type": "markdown"
|
48 | 48 | },
|
49 | 49 | {
|
50 | 50 | "metadata": {},
|
51 |
| - "source": "%pip install -q \"labelbox[data]\"", |
| 51 | + "source": "%pip install -q --upgrade \"labelbox[data]\"", |
52 | 52 | "cell_type": "code",
|
53 | 53 | "outputs": [],
|
54 | 54 | "execution_count": null
|
|
63 | 63 | {
|
64 | 64 | "metadata": {},
|
65 | 65 | "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." |
68 | 68 | ],
|
69 | 69 | "cell_type": "markdown"
|
70 | 70 | },
|
71 | 71 | {
|
72 | 72 | "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)", |
74 | 74 | "cell_type": "code",
|
75 | 75 | "outputs": [],
|
76 | 76 | "execution_count": null
|
|
85 | 85 | {
|
86 | 86 | "metadata": {},
|
87 | 87 | "source": [
|
88 |
| - "#### Composite masks\n", |
| 88 | + "### Composite masks\n", |
89 | 89 | "**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", |
92 | 92 | " - ***Image example***\n",
|
93 | 93 | "```json \n",
|
94 | 94 | " {\n",
|
|
157 | 157 | {
|
158 | 158 | "metadata": {},
|
159 | 159 | "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", |
170 | 162 | "2. The export and mask URL adhere to the following convention: \n",
|
171 | 163 | "```json\n",
|
172 | 164 | " {\n",
|
|
183 | 175 | {
|
184 | 176 | "metadata": {},
|
185 | 177 | "source": [
|
186 |
| - "## Create an export from an Image project with mask annotations\n", |
| 178 | + "## Create an export from a project with mask annotations\n", |
187 | 179 | "To better showcase composite masks, make sure you have different mask tools and mask annotations in your project"
|
188 | 180 | ],
|
189 | 181 | "cell_type": "markdown"
|
|
0 commit comments