Skip to content

Commit 94d2d81

Browse files
Update docstrings in project.py (#71)
Clarified which methods are supported by the Legacy editor vs new Editor.
1 parent 6d82615 commit 94d2d81

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

labelbox/schema/project.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ class Project(DbObject, Updateable, Deletable):
5555
ontology = Relationship.ToOne("Ontology", True)
5656

5757
def create_label(self, **kwargs):
58-
""" Creates a label on this Project.
58+
""" Creates a label on a Legacy Editor project. Not
59+
supported in the new Editor.
5960
6061
Kwargs:
6162
Label attributes. At the minimum the label `DataRow`.
@@ -306,7 +307,8 @@ def extend_reservations(self, queue_type):
306307
return res["extendReservations"]
307308

308309
def create_prediction_model(self, name, version):
309-
""" Creates a PredictionModel connected to this Project.
310+
""" Creates a PredictionModel connected to a Legacy Editor
311+
Project.
310312
Args:
311313
name (str): The new PredictionModel's name.
312314
version (int): The new PredictionModel's version.
@@ -322,7 +324,8 @@ def create_prediction_model(self, name, version):
322324
return model
323325

324326
def create_prediction(self, label, data_row, prediction_model=None):
325-
""" Creates a Prediction within this Project.
327+
""" Creates a Prediction within a Legacy Editor Project.
328+
326329
Args:
327330
label (str): The `label` field of the new Prediction.
328331
data_row (DataRow): The DataRow for which the Prediction is created.
@@ -369,7 +372,7 @@ def upload_annotations(
369372
name: str,
370373
annotations: Union[str, Union[str, Path], Iterable[dict]],
371374
) -> 'BulkImportRequest': # type: ignore
372-
""" Uploads annotations to a project.
375+
""" Uploads annotations to a new Editor project.
373376
374377
Args:
375378
name: name of the BulkImportRequest job

0 commit comments

Comments
 (0)