Skip to content

Commit 0657e68

Browse files
authored
Adds summary table to submit_image_query method overview (#350)
Adds a table summary to the docs on the different usage of the submit image query methods
1 parent fe82255 commit 0657e68

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

docs/docs/guide/4-submitting-image-queries.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
# Submitting Image Queries
22
Once you have [created a `Detector`](./3-working-with-detectors.md) and [captured an image](./2-grabbing-images.md), you can submit your image to Groundlight for analysis.
33

4+
The Groundlight SDK provides the `submit_image_query` method which gives you full control over how you'd like your image to be processed. For convenience while getting started, there are a few aliases that capture common use cases.
5+
6+
| Method | Usage | Examples |
7+
| --- | --- | --- |
8+
| `ask_confident` | [For users who want correct answers, waiting for humans to review if necessary](#get-the-first-confident-answer) | Visual verification in safety applications |
9+
| `ask_ml` | [For users who need fast ML answers and cannot wait for human review](#get-the-first-available-answer-regardless-of-confidence) | Live facilities monitoring, machine tending |
10+
| `ask_async` | [For users who want to bulk process images with no time constraint](#submit-an-imagequery-asynchronously) | Warming up a detector with data from another ML platform, Collecting data in the field with the intent to analyze it tomorrow |
11+
| `submit_image_query` | [For advanced users who want more control than any of the aliased functions provide](#submit-an-image-query) | Submitting image queries with security requirements or using image query tags (available in our enterprise tier)|
12+
413
## Submit an Image Query
514
The primary method for submitting an image query is `submit_image_query(detector: Detector, image: Any)`. This method takes a `Detector` object and an image as input and returns an `ImageQuery` object.
615
```python notest
@@ -75,7 +84,7 @@ image_query = gl.get_image_query(id=image_query.id)
7584

7685
See this [guide](./7-async-queries.md) for more information on ImageQueries submitted asynchronously.
7786

78-
### (Advanced) Get the first available answer, regardless of confidence
87+
### Get the first available answer, regardless of confidence
7988
`ask_ml` evaluates an image with Groundlight and returns the first answer Groundlight can provide, agnostic of confidence. There is no wait period when using this method. It is called `ask_ml` because our machine learning models are earliest on our escalation ladder and thus always the fastest to respond.
8089

8190
:::note

0 commit comments

Comments
 (0)