Doc fix for create detector #316
Conversation
| @@ -207,6 +207,7 @@ def _verify_connectivity(self) -> None: | |||
| f"Error connecting to Groundlight using API token '{self.api_token_prefix}...'" | |||
| f" at endpoint '{self.endpoint}'. Endpoint might be invalid or unreachable? " | |||
| "Check https://status.groundlight.ai/ for service status." | |||
| f"Original Error was: {str(e)}" | |||
There was a problem hiding this comment.
Oh, this was going to go into a different PR but I accidentally got it here. Tom and Tim noticed that we should immediately return the error at this point
src/groundlight/client.py
Outdated
| @@ -384,7 +388,7 @@ def create_detector( # noqa: PLR0913 | |||
| # Create a detector in a specific group | |||
| detector = gl.create_detector( | |||
| name="vehicle-counter", | |||
There was a problem hiding this comment.
This should probably be named something different.
| @@ -384,7 +388,7 @@ def create_detector( # noqa: PLR0913 | |||
| # Create a detector in a specific group | |||
| detector = gl.create_detector( | |||
| name="vehicle-counter", | |||
| query="How many vehicles are in the parking lot?", | |||
| query="Are there vehicles are in the parking lot?", | |||
| group_name="parking-monitoring", | |||
| patience_time=60.0 | |||
There was a problem hiding this comment.
Do we want to include patience time in the example? Probably not right?
There was a problem hiding this comment.
I don't see why not, we make it a legal parameter on the function
src/groundlight/client.py
Outdated
| @@ -361,6 +362,9 @@ def create_detector( # noqa: PLR0913 | |||
| """ | |||
| Create a new Detector with a given name and query. | |||
|
|
|||
| Counting and Multiclass detectors are in Beta, and can be created through the | |||
| ExperimentalApi via the `create_counting_detector` and `create_multiclass_detector` methods. | |||
There was a problem hiding this comment.
Is it obvious to a user how to find documentation on the experimental API? Should we include a link?
There was a problem hiding this comment.
Does Sphinx let you do that? Let me look
There was a problem hiding this comment.
Ooh, it does and it's really nice
brandon-groundlight
changed the title
Quick fix to make the other create detector methods more easily discovered