You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/basics/data_row_metadata.ipynb
+36-37Lines changed: 36 additions & 37 deletions
Original file line number
Diff line number
Diff line change
@@ -24,14 +24,7 @@
24
24
"source": [
25
25
"## Overview\n",
26
26
"\n",
27
-
"We are launching a new feature called DataRow Metadata. Metadata is being developed to help users better understand their data to help with labeling, model diagnostics, and data selection. This **should not be confused with attachements** formerly called metadata. Attachments provides additional context for labelers but is not searchable within Catalog.\n",
28
-
"\n",
29
-
"The metadata feature is in beta and aspect are subject change. During the Beta data must metadata must be uploaded to ***reserved fields*** defined by Labelbox. In the near future we will support user defined ***custom fields***. THe current available fields are:\n",
30
-
"\n",
31
-
"* **tag**: a free text field\n",
32
-
"* **split**: enum of train-valid-test\n",
33
-
"* **captureDateTime**: ISO 8601 datetime field. All times must be in UTC\n",
34
-
"* **embedding**: A 128 length list 32 bit floats used for similarity search. All datarows share the same similarity index."
27
+
"Metadata is useful to be better understand data on the platform to help with labeling review, model diagnostics, and data selection. This **should not be confused with attachments**. Attachments provide additional context for labelers but is not searchable within Catalog."
35
28
]
36
29
},
37
30
{
@@ -41,9 +34,7 @@
41
34
"id": "f61dSEA0o4zY"
42
35
},
43
36
"source": [
44
-
"### Installation\n",
45
-
"\n",
46
-
"You must install a `3.0.0` release or above of the SDK"
37
+
"### Installation"
47
38
]
48
39
},
49
40
{
@@ -120,14 +111,25 @@
120
111
"source": [
121
112
"## Metadata ontology\n",
122
113
"\n",
123
-
"We use a similar system for managing metadata as we do feature schemas. Metadata scheams are strongly typed to ensure we can provide the best experience in the App. Each metadata field can be uniquely accessed by id. Names are unique within the kind of metadata, reserved or custom.\n",
114
+
"We use a similar system for managing metadata as we do feature schemas. Metadata schemas are strongly typed to ensure we can provide the best experience in the App. Each metadata field can be uniquely accessed by id. Names are unique within the kind of metadata, reserved or custom. A DataRow can have a maximum of 5 metadata fields at a time.\n",
124
115
"\n",
125
-
"Metadata fields support a couple of core kinds:\n",
116
+
"### Metadata kinds\n",
126
117
"\n",
127
118
"* **Enum**: A classification with options, only one option can be selected at a time\n",
128
119
"* **DateTime**: A utc ISO datetime \n",
129
120
"* **Embedding**: 128 float 32 vector used for similarity\n",
130
-
"* **String**: A string of less than 500 characters"
121
+
"* **String**: A string of less than 500 characters\n",
122
+
"\n",
123
+
"### Reserved fields\n",
124
+
"\n",
125
+
"* **tag**: a free text field\n",
126
+
"* **split**: enum of train-valid-test\n",
127
+
"* **captureDateTime**: ISO 8601 datetime field. All times must be in UTC\n",
128
+
"* **embedding**: A 128 length list 32 bit floats used for similarity search. All datarows share the same similarity index.\n",
129
+
"\n",
130
+
"### Custom fields\n",
131
+
"\n",
132
+
"You can create your own fields from within the app by navigating to the [metadata schema page](https://app.labelbox.com/schema/metadata)"
131
133
]
132
134
},
133
135
{
@@ -431,22 +433,15 @@
431
433
" )"
432
434
]
433
435
},
434
-
{
435
-
"cell_type": "markdown",
436
-
"id": "1x-5KSChNSpK",
437
-
"metadata": {
438
-
"id": "1x-5KSChNSpK"
439
-
},
440
-
"source": [
441
-
"### Upload"
442
-
]
443
-
},
444
436
{
445
437
"cell_type": "code",
446
438
"execution_count": null,
447
439
"id": "-FUkp4CEPuzx",
448
440
"metadata": {
449
-
"id": "-FUkp4CEPuzx"
441
+
"id": "-FUkp4CEPuzx",
442
+
"pycharm": {
443
+
"is_executing": true
444
+
}
450
445
},
451
446
"outputs": [],
452
447
"source": [
@@ -465,6 +460,17 @@
465
460
"Currently there is no option for exporting metadata in bulk. We will be working to support that functionality in the near future."
466
461
]
467
462
},
463
+
{
464
+
"cell_type": "markdown",
465
+
"source": [
466
+
"### Upload\n",
467
+
"\n",
468
+
"Uploads will overwrite the current value for the feature if it is already present."
0 commit comments