Skip to content

Commit 90716f4

Browse files
author
Richard Sun
committed
[QQC-362] Document new project update restrictions regarding quality mode
1 parent f11ac19 commit 90716f4

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+
* Note that the quality setting cannot be changed after a project has been created. The quality mode
101+
for a project is inferred through the following attributes:
102+
Benchmark:
103+
auto_audit_number_of_labels = 1
104+
auto_audit_percentage = 1.0
105+
Consensus:
106+
auto_audit_number_of_labels > 1
107+
auto_audit_percentage <= 1.0
108+
Attempting to switch between benchmark and consensus modes is an invalid operation and will result
109+
in an error.
110+
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)