Skip to content

Commit 9695a04

Browse files
committed
update add_label docstring
1 parent fdac781 commit 9695a04

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/groundlight/client.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1193,7 +1193,7 @@ def add_label(
11931193
Provide a new label (annotation) for an image query. This is used to provide ground-truth labels
11941194
for training detectors, or to correct the results of detectors.
11951195
1196-
**Example usage**::
1196+
**Example usage for binary detectors**::
11971197
11981198
gl = Groundlight()
11991199
@@ -1208,12 +1208,15 @@ def add_label(
12081208
rois = [ROI(x=100, y=100, width=50, height=50)]
12091209
gl.add_label(image_query, "YES", rois=rois)
12101210
1211+
Examples for other answer modes can be found in the documentation for each of the modes.
1212+
12111213
:param image_query: Either an ImageQuery object (returned from methods like
12121214
`ask_ml`) or an image query ID string starting with "iq_".
12131215
12141216
:param label: The label value to assign, typically "YES" or "NO" for binary
12151217
classification detectors. For multi-class detectors, use one of
1216-
the defined class names.
1218+
the defined class names. See answer mode documentation for all
1219+
possible label options for all modes.
12171220
12181221
:param rois: Optional list of ROI objects defining regions of interest in the
12191222
image. Each ROI specifies a bounding box with x, y coordinates

0 commit comments

Comments
 (0)