Merge pull request #161 from Labelbox/ms/model-run

[DIAG-196] model-run entity

Author: msokoloff1

labelbox/__init__.py

@@ -18,3 +18,4 @@
 from labelbox.schema.ontology import Ontology
 from labelbox.schema.role import Role, ProjectRole
 from labelbox.schema.invite import Invite, InviteLimit
+from labelbox.schema.model_run import ModelRun

labelbox/client.py

@@ -377,7 +377,7 @@ def get_organization(self):
         """
         return self._get_single(Organization, None)
 
-    def _get_all(self, db_object_type, where):
+    def _get_all(self, db_object_type, where, filter_deleted=True):
         """ Fetches all the objects of the given type the user has access to.
 
         Args:
@@ -387,8 +387,9 @@ def _get_all(self, db_object_type, where):
         Returns:
             An iterable of `db_object_type` instances.
         """
-        not_deleted = db_object_type.deleted == False
-        where = not_deleted if where is None else where & not_deleted
+        if filter_deleted:
+            not_deleted = db_object_type.deleted == False
+            where = not_deleted if where is None else where & not_deleted
         query_str, params = query.get_all(db_object_type, where)
 
         return PaginatedCollection(
@@ -500,7 +501,7 @@ def create_project(self, **kwargs):
     def get_roles(self):
         """
         Returns:
-            Roles: Provides information on available roles within an organization. 
+            Roles: Provides information on available roles within an organization.
             Roles are used for user management.
         """
         return role.get_roles(self)
@@ -531,4 +532,4 @@ def get_models(self, where=None):
         Returns:
             An iterable of Models (typically a PaginatedCollection).
         """
-        return self._get_all(Model, where)
+        return self._get_all(Model, where, filter_deleted=False)

labelbox/schema/__init__.py

@@ -15,3 +15,4 @@
 import labelbox.schema.ontology
 import labelbox.schema.invite
 import labelbox.schema.role
+import labelbox.schema.model_run

labelbox/schema/model.py

@@ -3,7 +3,7 @@
 
 
 class Model(DbObject):
-        """A model represents a program that has been trained and
+    """A model represents a program that has been trained and
         can make predictions on new data.
         Attributes:
             name (str)
@@ -12,5 +12,7 @@ class Model(DbObject):
             slices (Relationship): `ToMany` relationship to Slice (TODO)
         """
 
-        name = Field.String("name")
-        ontology = Relationship.ToOne("Ontology", True)
+    name = Field.String("name")
+
+    model_runs = Relationship.ToMany("ModelRun", False)
+    ontology = Relationship.ToOne("Ontology", False)

labelbox/schema/model_run.py

@@ -0,0 +1,15 @@
+from labelbox.orm.model import Field, Relationship
+from labelbox.orm.db_object import DbObject
+
+
+class ModelRun(DbObject):
+    name = Field.String("name")
+    updated_at = Field.DateTime("updated_at")
+    created_at = Field.DateTime("created_at")
+    created_by_id = Field.String("created_by_id", "createdBy")
+
+    def upsert_labels(self):
+        ...
+
+    def add_predictions(self, predictions):
+        ...