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.

Sign up for GitHub

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

my nits while reviewing #280

Merged
merged 1 commit into from
Dec 2, 2024
Merged

my nits while reviewing #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/docs/getting-started/4-writing-queries.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading