Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review docs updates #11560

Merged
merged 1 commit into from
May 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/docs/configuration/review.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,20 @@ review:
- dog
```

## Excluding a camera from alerts or detections

To exclude a specific camera from alerts or detections, simply provide an empty list to the alerts or detections field _at the camera level_.

For example, to exclude objects on the camera _gatecamera_ from any detections, include this in your config:

```yaml
cameras:
gatecamera:
review:
detections:
labels: []
```

## Restricting review items to specific zones

By default a review item will be created if any `review -> alerts -> labels` and `review -> detections -> labels` are detected anywhere in the camera frame. You will likely want to configure review items to only be created when the object enters an area of interest, [see the zone docs for more information](./zones.md#restricting-alerts-and-detections-to-specific-zones)
Expand Down