Merge pull request #184 from Labelbox/ms/docstring-update

docstring update

Author: msokoloff1

docs/source/index.rst

@@ -14,6 +14,13 @@ Client
    :exclude-members: upload_data, upload_file
    :show-inheritance:
 
+AssetAttachment
+--------------------------------------
+
+.. automodule:: labelbox.schema.asset_attachment
+   :members:
+   :show-inheritance:
+
 AssetMetadata
 --------------------------------------
 

labelbox/__init__.py

@@ -13,6 +13,7 @@
 from labelbox.schema.task import Task
 from labelbox.schema.labeling_frontend import LabelingFrontend
 from labelbox.schema.asset_metadata import AssetMetadata
+from labelbox.schema.asset_attachment import AssetAttachment
 from labelbox.schema.webhook import Webhook
 from labelbox.schema.prediction import Prediction, PredictionModel
 from labelbox.schema.ontology import Ontology

labelbox/schema/asset_metadata.py

@@ -8,11 +8,8 @@
 
 
 class AssetMetadata(DbObject):
-    """ Asset metadata (AKA Attachments) provides extra context about an asset while labeling.
-
-    Attributes:
-        meta_type (str): IMAGE, VIDEO, TEXT, or IMAGE_OVERLAY
-        meta_value (str): URL to an external file or a string of text
+    """
+        `AssetMetadata` is deprecated. Use `AssetAttachment` instead
     """
 
     def __init__(self, *args, **kwargs):

labelbox/schema/data_row.py

@@ -23,7 +23,8 @@ class DataRow(DbObject, Updateable, BulkDeletable):
         created_by (Relationship): `ToOne` relationship to User
         organization (Relationship): `ToOne` relationship to Organization
         labels (Relationship): `ToMany` relationship to Label
-        metadata (Relationship): `ToMany` relationship to AssetMetadata
+        attachments (Relationship) `ToMany` relationship with AssetAttachment
+        metadata (Relationship): This Relationship is Deprecated. Please use `DataRow.attachments()` instead
         predictions (Relationship): `ToMany` relationship to Prediction
     """
     external_id = Field.String("external_id")
@@ -70,14 +71,15 @@ def __init__(self, *args, **kwargs):
         self.attachments.supports_sorting = False
 
     def create_attachment(self, attachment_type, attachment_value):
-        """ Attaches asset metadata to a DataRow.
+        """ Adds an AssetAttachment to a DataRow.
+            Labelers can view these attachments while labeling.
 
             >>> datarow.create_attachment("TEXT", "This is a text message")
 
         Args:
-            meta_type (str): Asset attachment type, must be one of:
+            attachment_type (str): Asset attachment type, must be one of:
                 VIDEO, IMAGE, TEXT, IMAGE_OVERLAY (AssetAttachment.AttachmentType)
-            meta_value (str): Asset attachment value.
+            attachment_value (str): Asset attachment value.
         Returns:
             `AssetAttachment` DB object.
         Raises: