Skip to content

Commit f004ace

Browse files
author
Tyler Romero
authored
Merge branch 'main' into dependabot/npm_and_yarn/docs/babel/runtime-corejs3-7.27.0
2 parents 0377f95 + f2a41bf commit f004ace

45 files changed

Lines changed: 496 additions & 639 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Detector Answer Modes
22

33
Groundlight offers several detector modalities to suit different computer vision tasks. While previous examples have focused on binary classification, this guide will walk you through using counting and multi-class detectors. Let's explore how these different modes can be used via the Groundlight SDK.
4+
![Examples of Computer Vision Answer Modes](https://cdn.prod.website-files.com/664b7cc2ac49aeb2da6ef0f4/67f99ecc0c0e8843cb706dd0_Examples_of_Computer_Vision_Answer_Modes.png)
45

56
- **[Binary Detectors](1-binary-detectors.md)**: Learn how to create detectors that answer yes/no questions about images.
67
- **[Multiple Choice (Choose One) Detectors](2-multi-choice-detectors.md)**: Create detectors that select one answer from a predefined list of options.
78
- **[Count Detectors](3-counting-detectors.md)**: Use detectors to count the number of objects present in an image - and return bounding boxes around the counted objects.
89
<!-- 4. [Text Recognition Detectors](4-text-recognition-detectors.md) -->
910

10-
<!-- TODO: object detection modes -->
11+
<!-- TODO: object detection modes -->

docs/docs/getting-started/getting-started.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ sophisticated computer vision accessible to everyone.
1212

1313
Don't code? No problem! [Contact our team](mailto:support@groundlight.ai) and we'll build a custom solution tailored to your needs.
1414

15+
In this example, we'll build a simple eagle detector that can analyze live video streams and tell us if there are baby eagles being fed.
16+
![Eagle Detector](/img/eagle_detector.png)
17+
1518
### Prerequisites
1619
Before diving in, you'll need:
1720
1. A [Groundlight account](https://dashboard.groundlight.ai/) (sign up is quick and easy!)
@@ -97,7 +100,7 @@ from groundlight import Groundlight, Detector, ImageQuery
97100
gl = Groundlight()
98101
detector: Detector = gl.get_or_create_detector(
99102
name="eagle-detector",
100-
query="Is there an eagle visible?",
103+
query="Are the baby eagles being fed??",
101104
)
102105

103106
# Big Bear Bald Eagle Nest livestream

docs/package-lock.json

Lines changed: 27 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/static/img/eagle_detector.png

1.72 MB
Loading

generated/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ rule_request = RuleRequest(
8484
snooze_time_unit=None,
8585
human_review_required=False,
8686
condition=ConditionRequest(
87-
verb=VerbEnum("ANSWERED_CONSECUTIVELY"),
87+
verb="verb_example",
8888
parameters={
8989
"key": None,
9090
},

generated/docs/ActionsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ with groundlight_openapi_client.ApiClient(configuration) as api_client:
5959
snooze_time_unit=None,
6060
human_review_required=False,
6161
condition=ConditionRequest(
62-
verb=VerbEnum("ANSWERED_CONSECUTIVELY"),
62+
verb="verb_example",
6363
parameters={
6464
"key": None,
6565
},

generated/docs/AnnotationsRequestedEnum.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
# AnnotationsRequestedEnum
22

3-
* `BINARY_CLASSIFICATION` - Binary Classification * `BOUNDING_BOXES` - Bounding Boxes
43

54
## Properties
65
Name | Type | Description | Notes
76
------------ | ------------- | ------------- | -------------
8-
**value** | **str** | * &#x60;BINARY_CLASSIFICATION&#x60; - Binary Classification * &#x60;BOUNDING_BOXES&#x60; - Bounding Boxes | must be one of ["BINARY_CLASSIFICATION", "BOUNDING_BOXES", ]
7+
**value** | **str** | | must be one of ["BINARY_CLASSIFICATION", "BOUNDING_BOXES", ]
98

109
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1110

generated/docs/BinaryClassificationResult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**label** | **str** | |
88
**confidence** | **float, none_type** | | [optional]
99
**source** | **str** | | [optional]
10-
**result_type** | **str** | | [optional] if omitted the server will use the default value of "binary_classification"
10+
**result_type** | **str** | | [optional]
1111
**from_edge** | **bool** | | [optional]
1212
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
1313

generated/docs/BoundingBoxResult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**label** | **str** | |
88
**confidence** | **float, none_type** | | [optional]
99
**source** | **str** | | [optional]
10-
**result_type** | **str** | | [optional] if omitted the server will use the default value of "bounding_box"
10+
**result_type** | **str** | | [optional]
1111
**from_edge** | **bool** | | [optional]
1212
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
1313

generated/docs/Condition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**verb** | [**VerbEnum**](VerbEnum.md) | |
7+
**verb** | **str** | |
88
**parameters** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | |
99
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
1010

0 commit comments

Comments
 (0)