Skip to content

Commit 2aa0972

Browse files
Merge pull request #676 from Labelbox/rsun/QQC-362
[QQC-362] Document new project update restrictions regarding quality …
2 parents f11ac19 + d62f3b2 commit 2aa0972

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

labelbox/schema/project.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,22 @@ class QueueMode(Enum):
9393
Dataset = "Dataset"
9494

9595
def update(self, **kwargs):
96+
""" Updates this project with the specified attributes
97+
98+
Args:
99+
kwargs: a dictionary containing attributes to be upserted
100+
101+
Note that the quality setting cannot be changed after a project has been created. The quality mode
102+
for a project is inferred through the following attributes:
103+
Benchmark:
104+
auto_audit_number_of_labels = 1
105+
auto_audit_percentage = 1.0
106+
Consensus:
107+
auto_audit_number_of_labels > 1
108+
auto_audit_percentage <= 1.0
109+
Attempting to switch between benchmark and consensus modes is an invalid operation and will result
110+
in an error.
111+
"""
96112
mode: Optional[Project.QueueMode] = kwargs.pop("queue_mode", None)
97113
if mode:
98114
self._update_queue_mode(mode)

0 commit comments

Comments
 (0)