Merge pull request #338 from Labelbox/update_docs

Update docs

Author: jtsodapop

docs/source/index.rst

@@ -154,3 +154,23 @@ Enums
    :members:
    :show-inheritance:
 
+ModelRun
+----------------------------
+
+.. automodule:: labelbox.schema.model_run
+   :members:
+   :show-inheritance:
+
+Model
+----------------------------
+
+.. automodule:: labelbox.schema.model
+   :members:
+   :show-inheritance:
+
+DataRowMetadata
+----------------------------
+
+.. automodule:: labelbox.schema.data_row_metadata
+   :members:
+   :show-inheritance:   

labelbox/schema/data_row_metadata.py

@@ -32,6 +32,9 @@ class DataRowMetadataSchema(BaseModel):
 
     @property
     def id(self):
+        """ `DataRowMetadataSchema.id is being deprecated after version 3.9 
+            in favor of DataRowMetadataSchema.uid`
+        """
         warnings.warn("`id` is being deprecated in favor of `uid`")
         return self.uid
 

labelbox/schema/model_run.py

@@ -145,6 +145,9 @@ def model_run_data_rows(self):
             ['annotationGroups', 'pageInfo', 'endCursor'])
 
     def annotation_groups(self):
+        """ `ModelRun.annotation_groups is being deprecated after version 3.9 
+            in favor of ModelRun.model_run_data_rows`
+        """
         warnings.warn(
             "`ModelRun.annotation_groups` is being deprecated in favor of `ModelRun.model_run_data_rows`"
         )
@@ -181,6 +184,9 @@ def delete_model_run_data_rows(self, data_row_ids):
         })
 
     def delete_annotation_groups(self, data_row_ids):
+        """ `ModelRun.delete_annotation_groups is being deprecated after version 3.9 
+            in favor of ModelRun.delete_model_run_data_rows`
+        """
         warnings.warn(
             "`ModelRun.delete_annotation_groups` is being deprecated in favor of `ModelRun.delete_model_run_data_rows`"
         )