Merge pull request #668 from Labelbox/develop

3.25.3

Author: msokoloff1

CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
+# Version 3.25.3 (2022-08-10)
+## Fixed
+* Label export will continue polling if the downloadUrl is None
 
 # Version 3.25.2 (2022-07-26)
 ## Updated
@@ -651,3 +654,7 @@ a `Label`. Default value is 0.0.
 
 ## Version 2.2 (2019-10-18)
 Changelog not maintained before version 2.2.
+
+### Changed
+* `Model.create_model_run()`
+    * Add training metadata config as a model run creation param

README.md

@@ -20,7 +20,7 @@ The Labelbox Python API offers a simple, user-friendly way to interact with the
 
 - Use Python 3.7, 3.8 or 3.9
 - [Create an account](http://app.labelbox.com/)
-- [Generate an API key](https://labelbox.com/docs/api/getting-started#create_api_key)
+- [Generate an API key](https://docs.labelbox.com/docs/create-an-api-key)
 
 ## Installation
 
@@ -59,9 +59,9 @@ pip install labelbox[data]
 
 ## Documentation
 
-- [Visit our docs](https://labelbox.com/docs/python-api) to learn how the SDK works
+- [Visit our docs](https://docs.labelbox.com/reference) to learn how the SDK works
 - Checkout our [notebook examples](examples/) to follow along with interactive tutorials
-- view our [API reference](https://labelbox.com/docs/python-api/api-reference).
+- view our [API reference](https://labelbox-python.readthedocs.io/en/latest/index.html).
 
 ## Authentication
 

examples/annotation_import/image.ipynb

@@ -350,7 +350,8 @@
    "source": [
     "lb_model = client.create_model(name=f\"{project.name}-model\",\n",
     "                               ontology_id=project.ontology().uid)\n",
-    "lb_model_run = lb_model.create_model_run(\"0.0.0\")\n",
+    "lb_model_run_hyperparameters = {\"batch_size\": 1000}\n",
+    "lb_model_run = lb_model.create_model_run(\"0.0.0\", lb_model_run_hyperparameters)\n",
     "lb_model_run.upsert_labels([label.uid for label in labels])"
    ]
   },

examples/model_diagnostics/model_diagnostics_guide.ipynb

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

labelbox/__init__.py

@@ -18,23 +18,26 @@ class Model(DbObject):
     name = Field.String("name")
     model_runs = Relationship.ToMany("ModelRun", False)
 
-    def create_model_run(self, name) -> "ModelRun":
+    def create_model_run(self, name, config=None) -> "ModelRun":
         """ Creates a model run belonging to this model.
 
         Args:
             name (string): The name for the model run.
+            config (json): Model run's training metadata config
         Returns:
             ModelRun, the created model run.
         """
         name_param = "name"
+        config_param = "config"
         model_id_param = "modelId"
         ModelRun = Entity.ModelRun
-        query_str = """mutation CreateModelRunPyApi($%s: String!, $%s: ID!) {
-            createModelRun(data: {name: $%s, modelId: $%s}) {%s}}""" % (
-            name_param, model_id_param, name_param, model_id_param,
-            query.results_query_part(ModelRun))
+        query_str = """mutation CreateModelRunPyApi($%s: String!, $%s: Json, $%s: ID!) {
+            createModelRun(data: {name: $%s, trainingMetadata: $%s, modelId: $%s}) {%s}}""" % (
+            name_param, config_param, model_id_param, name_param, config_param,
+            model_id_param, query.results_query_part(ModelRun))
         res = self.client.execute(query_str, {
             name_param: name,
+            config_param: config,
             model_id_param: self.uid
         })
         return ModelRun(self.client, res["createModelRun"])

labelbox/schema/model.py

@@ -32,6 +32,7 @@ class ModelRun(DbObject):
     created_at = Field.DateTime("created_at")
     created_by_id = Field.String("created_by_id", "createdBy")
     model_id = Field.String("model_id")
+    training_metadata = Field.Json("training_metadata")
 
     class Status(Enum):
         EXPORTING_DATA = "EXPORTING_DATA"

labelbox/schema/model_run.py

@@ -333,7 +333,7 @@ def _validate_datetime(string_date: str) -> bool:
         while True:
             res = self.client.execute(query_str, {id_param: self.uid})
             res = res["exportLabels"]
-            if not res["shouldPoll"]:
+            if not res["shouldPoll"] and res["downloadUrl"] is not None:
                 url = res['downloadUrl']
                 if not download:
                     return url

labelbox/schema/project.py

@@ -1,4 +1,4 @@
 [pytest]
-addopts = -s -vv -x --reruns 5 --reruns-delay 10
+addopts = -s -vv -x --reruns 5 --reruns-delay 10 --durations=100
 markers =
     slow: marks tests as slow (deselect with '-m "not slow"')

pytest.ini

@@ -14,8 +14,11 @@ def test_model_run(client, configured_project_with_label, rand_gen):
     model = client.create_model(data["name"], data["ontology_id"])
 
     name = rand_gen(str)
-    model_run = model.create_model_run(name)
+    config = {"batch_size": 100, "reruns": None}
+    model_run = model.create_model_run(name, config)
     assert model_run.name == name
+    assert model_run.training_metadata["batchSize"] == config["batch_size"]
+    assert model_run.training_metadata["reruns"] == config["reruns"]
     assert model_run.model_id == model.uid
     assert model_run.created_by_id == client.get_user().uid
 
@@ -32,6 +35,12 @@ def test_model_run(client, configured_project_with_label, rand_gen):
     assert fetch_model_run == model_run
 
 
+def test_model_run_no_config(rand_gen, model):
+    name = rand_gen(str)
+    model_run = model.create_model_run(name)
+    assert model_run.name == name
+
+
 def test_model_run_delete(client, model_run):
     models_before = list(client.get_models())
     model_before = models_before[0]