Skip to content

Commit

Permalink
my nits while reviewing (#280)
Browse files Browse the repository at this point in the history
Couple nits I noticed while reviewing from parts of the doc that weren't
touched by the original set of changes in tyler/more-code-samples
  • Loading branch information
brandon-groundlight authored Dec 2, 2024
1 parent a09e1fd commit d7a58b1
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/docs/getting-started/4-writing-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Introduction

Groundlight allows you to ask a variety of questions about images. The most common type of question is a binary question that can be answered with a simple "YES" or "NO". For example, "Is there a car in the leftmost parking space?" or "Is the door open?". Ambiguity in the question can lead to "UNSURE" responses.
Groundlight allows you to ask a variety of questions about images. The most common type of question is a binary question that can be answered with a simple "YES" or "NO". For example, "Is there a car in the leftmost parking space?" or "Is the door open?". Ambiguity in the question can lead to "UNCLEAR" responses.

```python notest
detector = gl.get_or_create_detector(
Expand All @@ -11,7 +11,7 @@ detector = gl.get_or_create_detector(
)
image_query = gl.submit_image_query(detector=detector, image=some_image)

# The SDK can return "YES" or "NO" (or "UNSURE")
# The SDK can return "YES" or "NO" (or "UNCLEAR")
print(f"The answer is {image_query.result.label}")
```

Expand Down
6 changes: 6 additions & 0 deletions docs/docs/installation/1-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ To check if the Groundlight SDK is installed and to display its version, you can
python -c "import groundlight; print(groundlight.__version__)"
```

or the groundlight command line tool that comes with the SDK:

```bash
groundlight --help
```

### Upgrading Groundlight SDK

If you need to upgrade the Groundlight SDK to the latest version, use the following pip command:
Expand Down
5 changes: 5 additions & 0 deletions docs/docs/installation/2-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ To check if the Groundlight SDK is installed and to display its version, you can
python -c "import groundlight; print(groundlight.__version__)"
```

or the groundlight command line tool that comes with the SDK:

```bash
groundlight --help
```
### Upgrading Groundlight SDK

If you need to upgrade the Groundlight SDK to the latest version, use the following pip command:
Expand Down

0 comments on commit d7a58b1

Please sign in to comment.