Skip to content

Commit 81e1e09

Browse files
brandon-wadaAuto-format Bot
andauthored
Doc fix for create detector (#316)
Quick fix to make the other create detector methods more easily discovered --------- Co-authored-by: Auto-format Bot <[email protected]>
1 parent cec8e61 commit 81e1e09

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/groundlight/client.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@ def _verify_connectivity(self) -> None:
207207
f"Error connecting to Groundlight using API token '{self.api_token_prefix}...'"
208208
f" at endpoint '{self.endpoint}'. Endpoint might be invalid or unreachable? "
209209
"Check https://status.groundlight.ai/ for service status."
210+
f"Original Error was: {str(e)}"
210211
)
211212
raise GroundlightClientError(msg) from e
212213

@@ -361,6 +362,10 @@ def create_detector( # noqa: PLR0913
361362
"""
362363
Create a new Detector with a given name and query.
363364
365+
Counting and Multiclass detectors are in Beta, and can be created through the
366+
ExperimentalApi via the :meth:`ExperimentalApi.create_counting_detector` and
367+
:meth:`ExperimentalApi.create_multiclass_detector` methods.
368+
364369
**Example usage**::
365370
366371
gl = Groundlight()
@@ -383,8 +388,8 @@ def create_detector( # noqa: PLR0913
383388
384389
# Create a detector in a specific group
385390
detector = gl.create_detector(
386-
name="vehicle-counter",
387-
query="How many vehicles are in the parking lot?",
391+
name="vehicle-monitor",
392+
query="Are there vehicles are in the parking lot?",
388393
group_name="parking-monitoring",
389394
patience_time=60.0
390395
)

0 commit comments

Comments
 (0)