Skip to content

Commit d3b880e

Browse files
committed
More cleanup
1 parent f6d207d commit d3b880e

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

docs/docs/guide/3-working-with-detectors.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Working with Detectors
22

3-
### Explicitly create a new detector
3+
This guide will walk you through creating, retrieving, and managing detectors in Groundlight. Groundlight supports several detector modalities to suit different computer vision tasks - for more information on these modes, see the [Detector Answer Modes](../answer-modes/answer-modes.md) guide.
4+
5+
6+
## Explicitly create a new detector
47

58
Typically you'll use the `get_or_create_detector(name: str, query: str)` method to find an existing detector you've already created with the same name, or create a new one if it doesn't exists. But if you'd like to force creating a new detector you can also use the `create_detector(name: str, query: str)` method
69

@@ -16,7 +19,7 @@ detector = gl.create_detector(name="your_detector_name", query="is there a hummi
1619
# highlight-end
1720
```
1821

19-
### Retrieve an existing detector
22+
## Retrieve an existing detector
2023
To work with a detector that you've previously created, you need to retrieve it using its unique identifier. This is typical in Groundlight applications where you want to continue to use a detector you've already created.
2124

2225
<!-- Don't test because the ID can't be faked -->
@@ -43,7 +46,7 @@ detector = gl.get_detector_by_name(name="your_detector_name")
4346
# highlight-end
4447
```
4548

46-
### List your detectors
49+
## List your detectors
4750
To manage and interact with your detectors, you might need to list them. Groundlight provides a straightforward way to retrieve a list of detectors you've created. By default, the list is paginated to show 10 results per page, but you can customize this to suit your needs.
4851

4952
```python

docs/docs/other-ways-to-use/1-stream-processor.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ It supports a variety of input sources, including:
1111
- Image directories
1212
- Image URLs
1313

14-
The Stream Processor can be combined with [Groundlight Alerts](../guide/10-alerts.md) to create a simple video analytics system. For example, you could use the Stream Processor to process a video stream from a security camera and send an alert when a person is detected.
14+
The Stream Processor can be combined with [Groundlight Alerts](../guide/9-alerts.md) to create a simple video analytics system. For example, you could use the Stream Processor to process a video stream from a security camera and send an alert when a person is detected.
1515

1616
## Prerequisites:
1717
You will need:
@@ -79,4 +79,4 @@ The Groundlight Stream Processor is lightweight and can be run on a Raspberry Pi
7979
## Combining with Groundlight Alerts
8080
The Stream Processor submits frames to Groundlight, but it does not do anything with the results.
8181

82-
In order to build a useful alerting system, you can combine the Stream Processor with [Groundlight Alerts](../guide/10-alerts.md).
82+
In order to build a useful alerting system, you can combine the Stream Processor with [Groundlight Alerts](../guide/9-alerts.md).

0 commit comments

Comments
 (0)