From b42d18c736943ac7c625b8c2d61d874373b1f8f7 Mon Sep 17 00:00:00 2001 From: Alex Cota Date: Tue, 29 Sep 2020 13:51:53 -0700 Subject: [PATCH] Update docstrings in project.py Clarified which methods are supported by the Legacy editor vs new Editor. --- labelbox/schema/project.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/labelbox/schema/project.py b/labelbox/schema/project.py index 3d387b7f8..6fa1f5b10 100644 --- a/labelbox/schema/project.py +++ b/labelbox/schema/project.py @@ -55,7 +55,8 @@ class Project(DbObject, Updateable, Deletable): ontology = Relationship.ToOne("Ontology", True) def create_label(self, **kwargs): - """ Creates a label on this Project. + """ Creates a label on a Legacy Editor project. Not + supported in the new Editor. Kwargs: Label attributes. At the minimum the label `DataRow`. @@ -306,7 +307,8 @@ def extend_reservations(self, queue_type): return res["extendReservations"] def create_prediction_model(self, name, version): - """ Creates a PredictionModel connected to this Project. + """ Creates a PredictionModel connected to a Legacy Editor + Project. Args: name (str): The new PredictionModel's name. version (int): The new PredictionModel's version. @@ -322,7 +324,8 @@ def create_prediction_model(self, name, version): return model def create_prediction(self, label, data_row, prediction_model=None): - """ Creates a Prediction within this Project. + """ Creates a Prediction within a Legacy Editor Project. + Args: label (str): The `label` field of the new Prediction. data_row (DataRow): The DataRow for which the Prediction is created. @@ -369,7 +372,7 @@ def upload_annotations( name: str, annotations: Union[str, Union[str, Path], Iterable[dict]], ) -> 'BulkImportRequest': # type: ignore - """ Uploads annotations to a project. + """ Uploads annotations to a new Editor project. Args: name: name of the BulkImportRequest job