Skip to content

Commit ffe7c5b

Browse files
author
Tyler Romero
committed
More wording/flow fixes, less emphasis on API Token creation
1 parent 18f01d1 commit ffe7c5b

File tree

2 files changed

+26
-24
lines changed

2 files changed

+26
-24
lines changed

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

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Don't code? [Contact our team](mailto:support@groundlight.ai) and we'll build a
88

99
### Prerequisites
1010
Before you begin, make sure you have:
11-
1. A [Groundlight account](https://dashboard.groundlight.ai/)
12-
2. An API token from the [Groundlight dashboard](https://dashboard.groundlight.ai/reef/my-account/api-tokens)
13-
3. Python 3.9 or newer
11+
1. A [Groundlight account](https://dashboard.groundlight.ai/)!
12+
2. An API token from the [Groundlight dashboard](https://dashboard.groundlight.ai/reef/my-account/api-tokens). See our [guide to API Tokens](http://localhost:3000/python-sdk/docs/getting-started/api-tokens) for more info.
13+
3. Python 3.9 or newer installed
1414

1515
### Installing the Groundlight SDK
1616

@@ -32,22 +32,10 @@ pip install groundlight
3232
For more detailed installation instructions, see the [installation guide](/docs/installation/).
3333

3434
### Authentication
35-
36-
In order to verify your identity while connecting to your custom ML models through our SDK, you’ll need to create an API token.
37-
38-
1. Log into your previously created account at https://dashboard.groundlight.ai/
39-
40-
2. Once in, click on your username in the upper right hand corner of your dashboard:
41-
42-
![](https://cdn.prod.website-files.com/664b7cc2ac49aeb2da6ef127/66cfb5e41e8dd9e0dd597419_AD_4nXeh8kPRLV3V4_broECuW9z1ELIqEIyJUelCjbWdE7RFtakxaov5ZgUylZBo6g4DAgqgTP2DnSrcJ26J7-pdFA2pjjnFfYxZykniuEv0axiniev3cmZiyIjaGvyHdj-381PLhvRHsm_jd4KtXXmCOV9ClNQx.png)
43-
44-
3. Select API Tokens, then enter a name for your api token, such as `personal-laptop-token`.
45-
46-
![](https://cdn.prod.website-files.com/664b7cc2ac49aeb2da6ef127/66cfb5f8b844596360c5c460_AD_4nXfkHlRPPBcdkFFjjAAYC42LwgXe91qbwDfwFs3V8lGFXhSoSFpjUBXo7RX0vyZVYUurzEIp3kFL9H8pghpLD8omBqLGswHQJUMxGo8dBDh--e8wj4LQZcwywrt0hotsz9DoBZb5owokq2YeJlPI4_trG-nJ.png)
47-
48-
4. Copy the API Token for use in your code
49-
50-
Set the API token in your terminal:
35+
The Groundlight SDK uses API tokens to authenticate your requests to the Groundlight API.
36+
When you make API calls, the SDK automatically uses your token to verify your identity and permissions. It
37+
does this by checking the `GROUNDLIGHT_API_TOKEN` environment variable. In order to set this environment
38+
variable, run:
5139
```bash
5240
# MacOS / Linux
5341
export GROUNDLIGHT_API_TOKEN='your-api-token'
@@ -64,8 +52,16 @@ Keep your API token secure! Anyone who has access to it can impersonate you and
6452

6553
Call the Groundlight API by creating a `Detector` and submitting an `ImageQuery`.
6654

67-
You can start using Groundlight using just your laptop camera, but you can also use a USB camera if you have one.
55+
For example, lets say we have captured this image and saved it under `./docs/static/img/thumbs-up.jpg`:
56+
<img
57+
src={require('/img/thumbs-up.jpg').default}
58+
alt="Thumbs-Up Example Image"
59+
width={"50%"}
60+
/>
61+
<br />
62+
<br />
6863

64+
We can now use Groundlight to ask a question about the image:
6965
```python title="ask.py"
7066
from groundlight import Groundlight, Detector, ImageQuery
7167

@@ -77,7 +73,7 @@ detector: Detector = gl.get_or_create_detector(
7773
query="Is the thumb facing up?",
7874
)
7975

80-
img = "./docs/static/img/thumb.jpg" # Image can be a file or a Python object
76+
img = "./docs/static/img/thumbs-up.jpg" # Image can be a file or a Python object
8177
image_query = gl.submit_image_query(detector=det, image=img)
8278

8379
print(f"The answer is {image_query.result.label}")
@@ -113,11 +109,17 @@ Congratulations! You now have a fully functional computer vision application. Yo
113109
Monitor and enhance your detector's performance through the [Groundlight Dashboard](https://dashboard.groundlight.ai/).
114110
Groundlight's human-in-the-loop technology intelligently monitors your image feed for anomalies and unexpected changes.
115111
By reviewing and verifying results, you continuously improve the system's accuracy. Through the dashboard, you can also
116-
configure text and email notifications to alert you when important events are detected in your video stream.
112+
[configure text and email notifications](/docs/guide/alerts) to alert you when important events are detected in your video stream.
117113

118114
### Next Steps
119115

120-
Now that you've built your first application, learn how to write effective [queries](/docs/getting-started/writing-queries).
116+
Now that you've built your first application, you can:
117+
1. Learn how to [write effective queries](/docs/getting-started/writing-queries).
118+
2. Proceed to [capture images from a wide variety of sources](/docs/guide/grabbing-images) using [`framegrab`](https://github.com/groundlight/framegrab).
119+
3. Read our guide to [confidence thresholds](/docs/guide/managing-confidence).
120+
121+
121122

122123
Ready to explore more possibilities? Visit our [Guides](https://www.groundlight.ai/guides) to discover sample
123-
applications built with Groundlight AI — from bird detection systems to Raspberry Pi implementations.
124+
applications built with Groundlight AI — from [industrial inspection workflows](https://www.groundlight.ai/blog/lkq-corporation-uses-groundlight-ai-to-revolutionize-quality-control-and-inspection)
125+
to [hummingbird detection systems](https://www.groundlight.ai/guides/detecting-hummingbirds-with-groundlight-ai).

docs/static/img/thumbs-up.jpg

152 KB
Loading

0 commit comments

Comments
 (0)