Skip to content

Commit d449aeb

Browse files
committed
Wordsmithing the UserGuide a bit.
1 parent 31918e0 commit d449aeb

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

UserGuide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Groundlight makes it simple to understand images. You can easily create computer vision detectors just by describing what you want to know using natural language.
44

5-
How does it work? Your images are first analyzed by machine learning (ML) models which are automatically trained on your data. If those models have high enough confidence, that's your answer. But if the models are unsure, then the images are progressively escalated to more resource-intensive analysis methods up to real-time human review. So what you get is a computer vision system that starts working right away without even needing to first gather and label a dataset. At first it will operate with high latency, because people need to review the image queries. But over time, the ML systems will learn and improve so queries come back faster with higher confidence.
5+
**How does it work?** Your images are first analyzed by machine learning (ML) models which are automatically trained on your data. If those models have high enough confidence, that's your answer. But if the models are unsure, then the images are progressively escalated to more resource-intensive analysis methods up to real-time human review. So what you get is a computer vision system that starts working right away without even needing to first gather and label a dataset. At first it will operate with high latency, because people need to review the image queries. But over time, the ML systems will learn and improve so queries come back faster with higher confidence.
66

77
*Note: The SDK is currently in "beta" phase. Interfaces are subject to change in future versions.*
88

@@ -14,8 +14,8 @@ How to build a computer vision system in 5 lines of python code:
1414
```Python
1515
from groundlight import Groundlight
1616
gl = Groundlight()
17-
detector = gl.create_detector(name="door", query="Is the door open?") # Define your detector using natural language
18-
image_query = gl.submit_image_query(detector=detector, image="path/to/filename.jpeg") # send an image
17+
d = gl.create_detector("door", query="Is the door open?") # define with natural language
18+
image_query = gl.submit_image_query(detector=d, image="path/filename.jpeg") # send an image
1919
print(f"The answer is {image_query.result}") # get the result
2020
```
2121

@@ -40,7 +40,7 @@ gl = Groundlight(api_token="<YOUR_API_TOKEN>")
4040
which is an easy way to get started, but is NOT a best practice. Please do not commit your API Token to version control! Instead we recommend setting the `GROUNDLIGHT_API_TOKEN` environment variable outside your code so that the SDK can find it automatically.
4141

4242
```bash
43-
$ export GROUNDLIGHT_API_TOKEN=api_2asdfkjEXAMPLE
43+
$ export GROUNDLIGHT_API_TOKEN=api_2GdXMflhJi6L_example
4444
$ python3 glapp.py
4545
```
4646

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "groundlight"
3-
version = "0.5.1"
3+
version = "0.5.2"
44
license = "MIT"
55
readme = "UserGuide.md"
66
homepage = "https://groundlight.ai"

0 commit comments

Comments
 (0)