Merge pull request #363 from Labelbox/ms/3.11.0-dev

3.11.0-dev

Author: msokoloff1

CHANGELOG.md

@@ -1,12 +1,17 @@
 # Changelog
 
-## Deprecation Notice
-| Name                                  | Replacement                            | Removed After |
-| ------------------------------------- | -------------------------------------  | ------------- |
-| `ModelRun.delete_annotation_groups()` | `ModelRun.delete_model_run_data_rows()`|  2021-12-06   |
-| `ModelRun.annotation_groups()`        | `ModelRun.model_run_data_rows()`       |  2021-12-06   |
-| `DataRowMetadataSchema.id`            | `DataRowMetadataSchema.uid`            |  2021-12-06   |
------
+# Version 3.11.0 (2021-12-15)
+
+## Fix
+* `Dataset.create_data_rows()` now accepts an iterable of data row information instead of a list
+* `project.upsert_instructions()`
+    * now only supports pdfs since that is what the editor requires
+    * There was a bug that could cause this to modify the project ontology
+
+## Removed
+* `DataRowMetadataSchema.id` use `DataRowMetadataSchema.uid` instead
+* `ModelRun.delete_annotation_groups()` use `ModelRun.delete_model_run_data_rows()` instead
+* `ModelRun.annotation_groups()` use `ModelRun.model_run_data_rows()` instead
 
 # Version 3.10.0 (2021-11-18)
 ## Added

docs/source/conf.py

@@ -21,7 +21,7 @@
 copyright = '2021, Labelbox'
 author = 'Labelbox'
 
-release = '3.10.0'
+release = '3.11.0'
 
 # -- General configuration ---------------------------------------------------
 

labelbox/__init__.py

@@ -1,5 +1,5 @@
 name = "labelbox"
-__version__ = "3.10.0"
+__version__ = "3.11.0"
 
 from labelbox.schema.project import Project
 from labelbox.client import Client

labelbox/schema/data_row_metadata.py

@@ -30,16 +30,6 @@ class DataRowMetadataSchema(BaseModel):
     options: Optional[List["DataRowMetadataSchema"]]
     parent: Optional[SchemaId]
 
-    @property
-    def id(self):
-        """ DataRowMetadataSchema.id will be removed after 2021-12-06
-            use DataRowMetadataSchema.uid instead
-        """
-        warnings.warn(
-            "DataRowMetadataSchema.id will be removed after 2021-12-06 "
-            "use DataRowMetadataSchema.uid instead")
-        return self.uid
-
 
 DataRowMetadataSchema.update_forward_refs()
 

labelbox/schema/model_run.py

@@ -2,7 +2,6 @@
 from pathlib import Path
 import os
 import time
-import warnings
 
 from labelbox.pagination import PaginatedCollection
 from labelbox.schema.annotation_import import MEAPredictionImport
@@ -144,15 +143,6 @@ def model_run_data_rows(self):
             lambda client, res: ModelRunDataRow(client, self.model_id, res),
             ['annotationGroups', 'pageInfo', 'endCursor'])
 
-    def annotation_groups(self):
-        """ `ModelRun.annotation_groups will be removed after 2021-12-06
-            use ModelRun.model_run_data_rows instead`
-        """
-        warnings.warn(
-            "`ModelRun.annotation_groups` will be removed after 2021-12-06 use "
-            "`ModelRun.model_run_data_rows` instead")
-        return self.model_run_data_rows()
-
     def delete(self):
         """ Deletes specified model run.
 
@@ -183,15 +173,6 @@ def delete_model_run_data_rows(self, data_row_ids):
             data_row_ids_param: data_row_ids
         })
 
-    def delete_annotation_groups(self, data_row_ids):
-        """ `ModelRun.delete_annotation_groups will be removed after 2021-12-06
-            use ModelRun.delete_model_run_data_rows instead`
-        """
-        warnings.warn(
-            "`ModelRun.delete_annotation_groups` will be removed after 2021-12-06 use "
-            "`ModelRun.delete_model_run_data_rows` instead")
-        return self.delete_model_run_data_rows(data_row_ids)
-
 
 class ModelRunDataRow(DbObject):
     label_id = Field.String("label_id")

labelbox/schema/project.py

@@ -317,12 +317,12 @@ def upsert_instructions(self, instructions_file: str):
 
         Args:
             instructions_file (str): Path to a local file.
-                * Must be either a pdf, text, or html file.
+                * Must be a pdf file
 
         Raises:
             ValueError:
                 * project must be setup
-                * instructions file must end with one of ".text", ".txt", ".pdf", ".html"
+                * instructions file must have a ".pdf" extension
         """
 
         if self.setup_complete is None:
@@ -338,11 +338,10 @@ def upsert_instructions(self, instructions_file: str):
                 f"This function has only been tested to work with the Editor front end. Found %s",
                 frontend.name)
 
-        supported_instruction_formats = (".text", ".txt", ".pdf", ".html")
+        supported_instruction_formats = (".pdf")
         if not instructions_file.endswith(supported_instruction_formats):
             raise ValueError(
-                f"instructions_file must end with one of {supported_instruction_formats}. Found {instructions_file}"
-            )
+                f"instructions_file must be a pdf. Found {instructions_file}")
 
         lfo = list(self.labeling_frontend_options())[-1]
         instructions_url = self.client.upload_file(instructions_file)

tests/integration/media/sample_pdf.pdf

@@ -79,7 +79,7 @@ def test_extend_reservations(project):
 
 def test_attach_instructions(client, project):
     with pytest.raises(ValueError) as execinfo:
-        project.upsert_instructions('/tmp/instructions.txt')
+        project.upsert_instructions('tests/integration/media/sample_pdf.pdf')
     assert str(
         execinfo.value
     ) == "Cannot attach instructions to a project that has not been set up."
@@ -90,17 +90,14 @@ def test_attach_instructions(client, project):
     empty_ontology = {"tools": [], "classifications": []}
     project.setup(editor, empty_ontology)
 
-    with open('/tmp/instructions.txt', 'w') as file:
-        file.write("some instructions...")
-
-    project.upsert_instructions('/tmp/instructions.txt')
+    project.upsert_instructions('tests/integration/media/sample_pdf.pdf')
     assert json.loads(
         list(project.labeling_frontend_options())
         [-1].customization_options).get('projectInstructions') is not None
 
     with pytest.raises(ValueError) as exc_info:
         project.upsert_instructions('/tmp/file.invalid_file_extension')
-    assert "instructions_file must end with one of" in str(exc_info.value)
+    assert "instructions_file must be a pdf. Found" in str(exc_info.value)
 
 
 def test_same_ontology_after_instructions(