Merge pull request #742 from Labelbox/mkozik/qqc-772

[QQC-772] Add deprecation warnings for creating Dataset projects & using LPOs

Author: mkozik-lb

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
 # In progress
+
+## Added
+* Add deprecation warning for queue_mode == QueueMode.Dataset when creating a new project.
+* Add deprecation warning for LPOs.
+
 ## Changed
 * Default behavior for metrics to not include subclasses in the calculation.
 * Updated `create_batch` method to accept consensus settings.

labelbox/client.py

@@ -34,6 +34,7 @@
 from labelbox.schema.project import Project
 from labelbox.schema.role import Role
 from labelbox.schema.slice import CatalogSlice
+from labelbox.schema.queue_mode import QueueMode
 
 from labelbox.schema.media_type import MediaType
 
@@ -615,11 +616,17 @@ def create_project(self, **kwargs) -> Project:
         >>> project = client.create_project(
                 name="<project_name>",
                 description="<project_description>",
-                media_type=MediaType.Image
+                media_type=MediaType.Image,
+                queue_mode=QueueMode.Batch
             )
 
         Args:
-            **kwargs: Keyword arguments with Project attribute values.
+            name (str): A name for the project
+            description (str): A short summary for the project
+            media_type (MediaType): The type of assets that this project will accept
+            queue_mode (Optional[QueueMode]): The queue mode to use
+            auto_audit_percentage (Optional[float]): The percentage of data rows that will require more than 1 label
+            auto_audit_number_of_labels (Optional[float]): Number of labels required for data rows selected for multiple labeling (auto_audit_percentage)
         Returns:
             A new Project object.
         Raises:
@@ -630,7 +637,7 @@ def create_project(self, **kwargs) -> Project:
         queue_mode = kwargs.get("queue_mode")
         if media_type:
             if MediaType.is_supported(media_type):
-                kwargs["media_type"] = media_type.value
+                media_type = media_type.value
             else:
                 raise TypeError(f"{media_type} is not a valid media type. Use"
                                 f" any of {MediaType.get_supported_members()}"
@@ -642,11 +649,20 @@ def create_project(self, **kwargs) -> Project:
 
         if not queue_mode:
             logger.warning(
-                "Default createProject behavior will soon be adjusted to prefer"
-                "batch projects. Pass in `queue_mode` parameter explicitly to opt-out for the"
+                "Default createProject behavior will soon be adjusted to prefer "
+                "batch projects. Pass in `queue_mode` parameter explicitly to opt-out for the "
                 "time being.")
-
-        return self._create(Entity.Project, kwargs)
+        elif queue_mode == QueueMode.Dataset:
+            logger.warning(
+                "QueueMode.Dataset will eventually be deprecated, and is no longer "
+                "recommended for new projects. Prefer QueueMode.Batch instead.")
+
+        return self._create(Entity.Project, {
+            **kwargs,
+            **({
+                'media_type': media_type
+            } if media_type else {})
+        })
 
     def get_roles(self) -> List[Role]:
         """

labelbox/schema/project.py

@@ -768,6 +768,10 @@ def set_labeling_parameter_overrides(self, data) -> bool:
         Returns:
             bool, indicates if the operation was a success.
         """
+        logger.warning(
+            "LabelingParameterOverrides are deprecated for new projects, and will eventually be removed "
+            "completely. Prefer to use batch based queuing with priority & consensus number of labels instead."
+        )
         self.validate_labeling_parameter_overrides(data)
         data_str = ",\n".join(
             "{dataRow: {id: \"%s\"}, priority: %d, numLabels: %d }" %