Improve API reference.

Author: florijanstamenkovic

labelbox/client.py

@@ -218,8 +218,6 @@ def _get_single(self, db_object_type, uid):
         Raises:
             labelbox.exceptions.ResourceNotFoundError: If there is no object
                 of the given type for the given ID.
-            labelbox.exceptions.LabelboxError: Any error raised by
-                `Client.execute` can also be raised by this function.
         """
         query_str, params = query.get_single(db_object_type, uid)
         res = self.execute(query_str, params)
@@ -271,9 +269,6 @@ def _get_all(self, db_object_type, where):
                 for filtering.
         Return:
             An iterable of `db_object_type` instances.
-        Raises:
-            labelbox.exceptions.LabelboxError: Any error raised by
-                `Client.execute` can also be raised by this function.
         """
         not_deleted = db_object_type.deleted == False
         where = not_deleted if where is None else where & not_deleted
@@ -291,9 +286,6 @@ def get_projects(self, where=None):
                 for filtering.
         Return:
             An iterable of Projects (typically a PaginatedCollection).
-        Raises:
-            labelbox.exceptions.LabelboxError: Any error raised by
-                `Client.execute` can also be raised by this function.
         """
         return self._get_all(Project, where)
 
@@ -305,9 +297,6 @@ def get_datasets(self, where=None):
                 for filtering.
         Return:
             An iterable of Datasets (typically a PaginatedCollection).
-        Raises:
-            labelbox.exceptions.LabelboxError: Any error raised by
-                `Client.execute` can also be raised by this function.
         """
         return self._get_all(Dataset, where)
 
@@ -319,9 +308,6 @@ def get_labeling_frontends(self, where=None):
                 for filtering.
         Return:
             An iterable of LabelingFrontends (typically a PaginatedCollection).
-        Raises:
-            labelbox.exceptions.LabelboxError: Any error raised by
-                `Client.execute` can also be raised by this function.
         """
         return self._get_all(LabelingFrontend, where)
 

labelbox/schema/dataset.py

@@ -32,10 +32,9 @@ def create_data_row(self, **kwargs):
             treated as an external URL.
         Raises:
             InvalidQueryError: If `DataRow.row_data` field value is not provided
-                in `data`.
-                any of the field names given in `data`.
+                in `kwargs`.
             InvalidAttributeError: in case the DB object type does not contain
-                any of the field names given in `data`.
+                any of the field names given in `kwargs`.
 
         """
         DataRow = Entity.DataRow

labelbox/schema/project.py

@@ -193,7 +193,11 @@ def setup(self, labeling_frontend, labeling_frontend_options):
         self.update(setup_complete=timestamp)
 
     def set_labeling_parameter_overrides(self, data):
-        """ Adds labeling parameter overrides to this project.
+        """ Adds labeling parameter overrides to this project. Example:
+
+            >>> project.set_labeling_parameter_overrides([
+            >>>     (data_row_1, 2, 3), (data_row_2, 1, 4)])
+
         Args:
             data (iterable): An iterable of tuples. Each tuple must contain
                 (DataRow, priority, numberOfLabels) for the new override.