Skip to content

Update docstrings in project.py #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 29, 2020
Merged

Update docstrings in project.py #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions labelbox/schema/project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down