Skip to content

Commit e3a9b88

Browse files
author
Matt Sokoloff
committed
update docs
1 parent ba951a0 commit e3a9b88

File tree

4 files changed

+12
-6
lines changed

4 files changed

+12
-6
lines changed

docs/source/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ Client
1414
:exclude-members: upload_data, upload_file
1515
:show-inheritance:
1616

17+
AssetAttachment
18+
--------------------------------------
19+
20+
.. automodule:: labelbox.schema.asset_attachment
21+
:members:
22+
:show-inheritance:
23+
1724
AssetMetadata
1825
--------------------------------------
1926

labelbox/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
from labelbox.schema.task import Task
1414
from labelbox.schema.labeling_frontend import LabelingFrontend
1515
from labelbox.schema.asset_metadata import AssetMetadata
16+
from labelbox.schema.asset_attachment import AssetAttachment
1617
from labelbox.schema.webhook import Webhook
1718
from labelbox.schema.prediction import Prediction, PredictionModel
1819
from labelbox.schema.ontology import Ontology

labelbox/schema/asset_metadata.py

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,8 @@
88

99

1010
class AssetMetadata(DbObject):
11-
""" Asset metadata (AKA Attachments) provides extra context about an asset while labeling.
12-
13-
Attributes:
14-
meta_type (str): IMAGE, VIDEO, TEXT, or IMAGE_OVERLAY
15-
meta_value (str): URL to an external file or a string of text
11+
"""
12+
`AssetMetadata` is deprecated. Use `AssetAttachment` instead
1613
"""
1714

1815
def __init__(self, *args, **kwargs):

labelbox/schema/data_row.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ class DataRow(DbObject, Updateable, BulkDeletable):
2323
created_by (Relationship): `ToOne` relationship to User
2424
organization (Relationship): `ToOne` relationship to Organization
2525
labels (Relationship): `ToMany` relationship to Label
26-
metadata (Relationship): `ToMany` relationship to AssetMetadata
26+
attachments (Relationship) `ToMany` relationship with AssetAttachment
27+
metadata (Relationship): This Relationship is Deprecated. Please use `DataRow.attachments()` instead
2728
predictions (Relationship): `ToMany` relationship to Prediction
2829
"""
2930
external_id = Field.String("external_id")

0 commit comments

Comments
 (0)