Merge branch 'develop' into paultancre-SN-131

paultancre · web-flow · commit 54f69214cb77 · 2024-05-15T17:03:43.000+01:00
diff --git a/examples/basics/projects.ipynb b/examples/basics/projects.ipynb
@@ -59,6 +59,7 @@
       "source": [
         "import labelbox as lb\n",
         "import labelbox.types as lb_types\n",
+        "from labelbox.schema.conflict_resolution_strategy import ConflictResolutionStrategy\n",
         "import uuid"
       ],
       "cell_type": "code",
@@ -138,7 +139,7 @@
     {
       "metadata": {},
       "source": [
-        "### Add a data rows to a project \n"
+        "### Add data rows to a project \n"
       ],
       "cell_type": "markdown"
     },
@@ -226,19 +227,14 @@
         "\n",
         "In this section, we are creating an ontology to attach to a project and creating labels to import as ground truths. We need this setup to demonstrate other methods later in the demo. For more information, please reference our [Ontology](https://docs.labelbox.com/reference/ontology) and [Import Image Annotation](https://docs.labelbox.com/reference/import-image-annotations) development guides."
       ],
-      "cell_type": "raw"
-    },
-    {
-      "metadata": {},
-      "source": [],
       "cell_type": "markdown"
     },
     {
       "metadata": {},
       "source": [
-        "Create your ontology"
+        "#### Create your ontology"
       ],
-      "cell_type": "raw"
+      "cell_type": "markdown"
     },
     {
       "metadata": {},
@@ -263,14 +259,13 @@
     {
       "metadata": {},
       "source": [
-        "Attach ontology to project"
+        "#### Attach ontology to project"
       ],
       "cell_type": "markdown"
     },
     {
       "metadata": {},
       "source": [
-        "\n",
         "project.setup_editor(ontology)"
       ],
       "cell_type": "code",
@@ -280,7 +275,7 @@
     {
       "metadata": {},
       "source": [
-        "Create labels and upload them to project as ground truths"
+        "### Create labels and upload them to project as ground truths"
       ],
       "cell_type": "markdown"
     },
@@ -290,7 +285,7 @@
         "# Create labels\n",
         "labels = []\n",
         "for global_key in global_keys:\n",
-        "    labels.append(lb_types.Label(data=lb_types.ImageData(global_key=global_key),\n",
+        "    labels.append(lb_types.Label(data={\"global_key\":global_key},\n",
         "                   annotations=[\n",
         "                        # Create radio classification annotation for labels\n",
         "                        lb_types.ClassificationAnnotation(\n",
@@ -384,6 +379,118 @@
       "outputs": [],
       "execution_count": null
     },
+    {
+      "metadata": {},
+      "source": [
+        "### Copy labels and data rows from one project to a different project\n",
+        "In the below steps we will be copying data rows with their corresponding labels from one project to a different project with a similar ontology. First, we must set up a new project with a ontology that matches the tooling of our source project ontology."
+      ],
+      "cell_type": "markdown"
+    },
+    {
+      "metadata": {},
+      "source": [
+        "# Create an empty destination project\n",
+        "destination_project = client.create_project(name=\"destination-test-project\",\n",
+        "                                description=\"a description\",\n",
+        "                                media_type=lb.MediaType.Image)\n",
+        "\n",
+        "# Create ontology and attach to destination project\n",
+        "destination_ontology_builder = lb.OntologyBuilder(classifications=[  # List of Classification objects\n",
+        "        lb.Classification(class_type=lb.Classification.Type.RADIO,\n",
+        "                          name=\"destination_radio_question\",\n",
+        "                          options=[\n",
+        "                              lb.Option(value=\"destination_first_radio_answer\"),\n",
+        "                              lb.Option(value=\"destination_second_radio_answer\")\n",
+        "                          ]),\n",
+        "])\n",
+        "\n",
+        "destination_ontology = client.create_ontology(\"dest-test-ontology\",\n",
+        "                                  ontology_builder.asdict())\n",
+        "\n",
+        "destination_project.setup_editor(destination_ontology)"
+      ],
+      "cell_type": "code",
+      "outputs": [],
+      "execution_count": null
+    },
+    {
+      "metadata": {},
+      "source": [
+        "#### Copy data rows and labels\n",
+        "To copy our data rows and labels to our project from a source project we will be using the `send_to_annotate_from_catalog` method with our Labelbox client.\n",
+        "\n",
+        "##### Parameters\n",
+        "\n",
+        "When you send data rows with labels to our destination project, you may choose to include or exclude certain parameters, at a minimum a `source_project_id` will need to be provided:\n",
+        "\n",
+        "* `source_project_id`\n",
+        "    - The id of the project were our data rows with labels will originate.\n",
+        "* `annotation_ontology_mapping`\n",
+        "    - A dictionary containing the mapping of the source project's ontology feature schema ids to the destination project's ontology feature schema ids. If left empty only the data rows will be sent to our destination project with no labels.\n",
+        "* `exclude_data_rows_in_project`\n",
+        "    - Excludes data rows that are already in the project. \n",
+        "* `override_existing_annotations_rule` \n",
+        "    - The strategy defining how to handle conflicts in classifications between the data rows that already exist in the project and incoming labels from the source project. \n",
+        "        * Defaults to ConflictResolutionStrategy.KeepExisting\n",
+        "        * Options include:\n",
+        "            * ConflictResolutionStrategy.KeepExisting\n",
+        "            * ConflictResolutionStrategy.OverrideWithPredictions\n",
+        "            * ConflictResolutionStrategy.OverrideWithAnnotations\n",
+        "* `param batch_priority`\n",
+        "    - The priority of the batch."
+      ],
+      "cell_type": "markdown"
+    },
+    {
+      "metadata": {},
+      "source": [
+        "# Get ontology dictionary to obtain featureSchemaIds\n",
+        "source_ontology_normalized = ontology.normalized\n",
+        "destination_ontology_normalized = destination_ontology.normalized\n",
+        "\n",
+        "ANNOTATION_ONTOLOGY_MAPPING = {\n",
+        "    source_ontology_normalized[\"classifications\"][0][\"featureSchemaId\"]:destination_ontology_normalized[\"classifications\"][0][\"featureSchemaId\"], # Classification featureSchemaID\n",
+        "    source_ontology_normalized[\"classifications\"][0][\"options\"][0][\"featureSchemaId\"]:destination_ontology_normalized[\"classifications\"][0][\"options\"][0][\"featureSchemaId\"], # Different Classification Answer featureSchemaIDs\n",
+        "    source_ontology_normalized[\"classifications\"][0][\"options\"][1][\"featureSchemaId\"]:destination_ontology_normalized[\"classifications\"][0][\"options\"][1][\"featureSchemaId\"]\n",
+        "}"
+      ],
+      "cell_type": "code",
+      "outputs": [],
+      "execution_count": null
+    },
+    {
+      "metadata": {},
+      "source": [
+        "send_to_annotate_params = {\n",
+        "    \"source_project_id\": project.uid,\n",
+        "    \"annotations_ontology_mapping\": ANNOTATION_ONTOLOGY_MAPPING,\n",
+        "    \"exclude_data_rows_in_project\": False,\n",
+        "    \"override_existing_annotations_rule\": ConflictResolutionStrategy.OverrideWithPredictions,\n",
+        "    \"batch_priority\": 5,\n",
+        "}\n",
+        "\n",
+        "# Get task id to workflow you want to send data rows. If sent to initial labeling queue, labels will be pre-labels. \n",
+        "queue_id = [queue.uid for queue in destination_project.task_queues() if queue.queue_type == \"MANUAL_REVIEW_QUEUE\" ][0]\n",
+        "\n",
+        "task = client.send_to_annotate_from_catalog(\n",
+        "    destination_project_id=destination_project.uid,\n",
+        "    task_queue_id=queue_id, # ID of workflow task, set ID to None if you want to send data rows with labels to the Done queue.\n",
+        "    batch_name=\"Prediction Import Demo Batch\",\n",
+        "    data_rows=lb.GlobalKeys(\n",
+        "        global_keys # Provide a list of global keys from source project\n",
+        "    ),\n",
+        "    params=send_to_annotate_params\n",
+        "    )\n",
+        "\n",
+        "task.wait_till_done()\n",
+        "\n",
+        "print(f\"Errors: {task.errors}\")"
+      ],
+      "cell_type": "code",
+      "outputs": [],
+      "execution_count": null
+    },
     {
       "metadata": {},
       "source": [
@@ -395,7 +502,9 @@
       "metadata": {},
       "source": [
         "# project.delete()\n",
+        "# destination_project.delete()\n",
         "# dataset.delete()\n",
+        "# client.delete_unused_ontology(destination_ontology.uid)\n",
         "# client.delete_unused_ontology(ontology.uid)"
       ],
       "cell_type": "code",
diff --git a/examples/model_experiments/model_predictions_to_project.ipynb b/examples/model_experiments/model_predictions_to_project.ipynb
@@ -30,7 +30,7 @@
     {
       "metadata": {},
       "source": [
-        "# Import Model Run Predictions To a Project\n",
+        "# Import Model Run Predictions to a Project\n",
         "Throughout the process of training your machine learning (ML) model, you may want to export your model-run predictions and import them to your new project. In this notebook, we will demonstrate the process on how to get those predictions moved over."
       ],
       "cell_type": "markdown"
diff --git a/libs/labelbox/src/labelbox/client.py b/libs/labelbox/src/labelbox/client.py
@@ -2002,7 +2002,7 @@ def send_to_annotate_from_catalog(self, destination_project_id: str,
                                       task_queue_id: Optional[str],
                                       batch_name: str,
                                       data_rows: Union[DataRowIds, GlobalKeys],
-                                      params: SendToAnnotateFromCatalogParams):
+                                      params: Dict[str, Any]):
         """
         Sends data rows from catalog to a specified project for annotation.
 
@@ -2033,6 +2033,8 @@ def send_to_annotate_from_catalog(self, destination_project_id: str,
 
         """
 
+        validated_params = SendToAnnotateFromCatalogParams(**params)
+
         mutation_str = """mutation SendToAnnotateFromCatalogPyApi($input: SendToAnnotateFromCatalogInput!) {
                             sendToAnnotateFromCatalog(input: $input) {
                               taskId
@@ -2044,26 +2046,14 @@ def send_to_annotate_from_catalog(self, destination_project_id: str,
             task_queue_id)
         data_rows_query = self.build_catalog_query(data_rows)
 
-        source_model_run_id = params.get("source_model_run_id", None)
-        predictions_ontology_mapping = params.get(
-            "predictions_ontology_mapping", None)
         predictions_input = build_predictions_input(
-            predictions_ontology_mapping,
-            source_model_run_id) if source_model_run_id else None
+            validated_params.predictions_ontology_mapping,
+            validated_params.source_model_run_id
+        ) if validated_params.source_model_run_id else None
 
-        source_project_id = params.get("source_project_id", None)
-        annotations_ontology_mapping = params.get(
-            "annotations_ontology_mapping", None)
         annotations_input = build_annotations_input(
-            annotations_ontology_mapping,
-            source_project_id) if source_project_id else None
-
-        batch_priority = params.get("batch_priority", 5)
-        exclude_data_rows_in_project = params.get(
-            "exclude_data_rows_in_project", False)
-        override_existing_annotations_rule = params.get(
-            "override_existing_annotations_rule",
-            ConflictResolutionStrategy.KeepExisting)
+            validated_params.annotations_ontology_mapping, validated_params.
+            source_project_id) if validated_params.source_project_id else None
 
         res = self.execute(
             mutation_str, {
@@ -2072,18 +2062,18 @@ def send_to_annotate_from_catalog(self, destination_project_id: str,
                         destination_project_id,
                     "batchInput": {
                         "batchName": batch_name,
-                        "batchPriority": batch_priority
+                        "batchPriority": validated_params.batch_priority
                     },
                     "destinationTaskQueue":
                         destination_task_queue,
                     "excludeDataRowsInProject":
-                        exclude_data_rows_in_project,
+                        validated_params.exclude_data_rows_in_project,
                     "annotationsInput":
                         annotations_input,
                     "predictionsInput":
                         predictions_input,
                     "conflictLabelsResolutionStrategy":
-                        override_existing_annotations_rule,
+                        validated_params.override_existing_annotations_rule,
                     "searchQuery": {
                         "scope": None,
                         "query": [data_rows_query]
diff --git a/libs/labelbox/src/labelbox/schema/send_to_annotate_params.py b/libs/labelbox/src/labelbox/schema/send_to_annotate_params.py
@@ -3,14 +3,15 @@
 from typing import Optional, Dict
 
 from labelbox.schema.conflict_resolution_strategy import ConflictResolutionStrategy
+from labelbox import pydantic_compat
 
 if sys.version_info >= (3, 8):
     from typing import TypedDict
 else:
     from typing_extensions import TypedDict
 
 
-class SendToAnnotateFromCatalogParams(TypedDict):
+class SendToAnnotateFromCatalogParams(pydantic_compat.BaseModel):
     """
     Extra parameters for sending data rows to a project through catalog. At least one of source_model_run_id or
     source_project_id must be provided.
@@ -30,14 +31,26 @@ class SendToAnnotateFromCatalogParams(TypedDict):
     :param batch_priority: Optional[int] - The priority of the batch. Defaults to 5.
     """
 
-    source_model_run_id: Optional[str]
-    predictions_ontology_mapping: Optional[Dict[str, str]]
-    source_project_id: Optional[str]
-    annotations_ontology_mapping: Optional[Dict[str, str]]
-    exclude_data_rows_in_project: Optional[bool]
-    override_existing_annotations_rule: Optional[ConflictResolutionStrategy]
-    batch_priority: Optional[int]
-
+    source_model_run_id: Optional[str] = None
+    source_project_id: Optional[str] = None
+    predictions_ontology_mapping: Optional[Dict[str, str]] = {}
+    annotations_ontology_mapping: Optional[Dict[str, str]] = {}
+    exclude_data_rows_in_project: Optional[bool] = False
+    override_existing_annotations_rule: Optional[
+        ConflictResolutionStrategy] = ConflictResolutionStrategy.KeepExisting
+    batch_priority: Optional[int] = 5
+
+    @pydantic_compat.root_validator
+    def check_project_id_or_model_run_id(cls, values):
+        if not values.get("source_model_run_id") and not values.get("source_project_id"):
+            raise ValueError(
+                'Either source_project_id or source_model_id are required'
+            )
+        if values.get("source_model_run_id") and values.get("source_project_id"):
+            raise ValueError(
+                'Provide only a source_project_id or source_model_id not both'
+            ) 
+        return values
 
 class SendToAnnotateFromModelParams(TypedDict):
     """

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`{`
`31`	`31`	`"metadata": {},`
`32`	`32`	`"source": [`
`33`		`- "# Import Model Run Predictions To a Project\n",`
	`33`	`+ "# Import Model Run Predictions to a Project\n",`
`34`	`34`	`"Throughout the process of training your machine learning (ML) model, you may want to export your model-run predictions and import them to your new project. In this notebook, we will demonstrate the process on how to get those predictions moved over."`
`35`	`35`	`],`
`36`	`36`	`"cell_type": "markdown"`