You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/getting-started/getting-started.mdx
+75-47Lines changed: 75 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,41 +1,70 @@
1
1
# Getting Started with Groundlight
2
2
3
-
## Build Computer Vision Applications in Minutes with Groundlight's Python SDK
3
+
## Build Powerful Computer Vision Applications in Minutes
4
4
5
-
Welcome to Groundlight AI! This guide will help you build your first computer vision application quickly and easily using our Python SDK.
5
+
Welcome to Groundlight AI! This guide will help you create your first computer vision application
6
+
quickly and easily using our intuitive Python SDK. Whether you're monitoring wildlife,
7
+
automating quality control, or building smart security systems, Groundlight makes computer vision
8
+
accessible to everyone.
6
9
7
-
Don't code? [Contact our team](mailto:support@groundlight.ai) and we'll build a custom solution for you.
10
+
Don't code? No problem! [Contact our team](mailto:support@groundlight.ai) and we'll build a custom solution tailored to your needs.
8
11
9
12
### Prerequisites
10
-
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). 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
13
+
Before diving in, you'll need:
14
+
1. A [Groundlight account](https://dashboard.groundlight.ai/) (sign up is quick and easy!)
15
+
2. An API token from your[Groundlight dashboard](https://dashboard.groundlight.ai/reef/my-account/api-tokens). Check out our [API Tokens guide](http://localhost:3000/python-sdk/docs/getting-started/api-tokens) for details.
16
+
3. Python 3.9 or newer installed on your system.
14
17
15
-
### Installing the Groundlight SDK
18
+
### Setting Up Your Environment
16
19
17
-
You can install the Groundlight SDK via pip. When installing python packages, it is a best practice to install them
18
-
inside of virtual environments. Run the following in the command line to create a new environment:
20
+
Let's set up a clean Python environment for your Groundlight project! The Groundlight SDK is available on PyPI and can be installed with [pip](https://packaging.python.org/en/latest/tutorials/installing-packages/#use-pip-for-installing).
21
+
22
+
First, let's create a virtual environment to keep your Groundlight dependencies isolated from other Python projects:
19
23
```bash
20
24
python3 -m venv groundlight-env
21
25
```
26
+
Now, activate your virtual environment:
27
+
```bash
28
+
# MacOS / Linux
29
+
source groundlight-env/bin/activate
30
+
```
31
+
```
32
+
# Windows
33
+
.\groundlight-env\Scripts\activate
34
+
```
22
35
23
-
Activate the virtual environment using
24
-
- On macOS or Linux, `source groundlight-env/bin/activate`
25
-
- On Windows, `.\groundlight-env\Scripts\activate`
26
-
27
-
Now, you can install the Groundlight SDK using pip:
36
+
With your environment ready, install the Groundlight SDK with a simple pip command:
28
37
```bash
29
38
pip install groundlight
30
39
```
31
40
32
-
For more detailed installation instructions, see the [installation guide](/docs/installation/).
41
+
Let's also install [framegrab](https://github.com/groundlight/framegrab) with YouTube support -
42
+
this useful library will let us capture frames from YouTube livestreams, webcams, and other video
43
+
sources, making it easy to get started!
44
+
```bash
45
+
pip install framegrab[youtube]
46
+
```
47
+
:::tip Camera Support
48
+
Framegrab is versatile! It works with:
49
+
- Webcams and USB cameras
50
+
- RTSP streams (security cameras)
51
+
- Professional cameras (Basler USB/GigE)
52
+
- Depth cameras (Intel RealSense)
53
+
- Video files and streams (mp4, mov, mjpeg, avi)
54
+
- YouTube livestreams
55
+
56
+
This makes it perfect for quickly prototyping your computer vision applications!
57
+
:::
58
+
59
+
Need more options? Check out our detailed [installation guide](/docs/installation/) for advanced setup instructions.
33
60
34
61
### Authentication
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:
62
+
63
+
Now let's set up your credentials so you can start making API calls. Groundlight uses API tokens to securely authenticate your requests.
64
+
65
+
If you don't have an API token yet, refer to our [API Tokens guide](/docs/getting-started/api-tokens) to create one.
66
+
67
+
The SDK will automatically look for your token in the `GROUNDLIGHT_API_TOKEN` environment variable. Set it up with:
For more information on the Groundlight SDK, see the [API Reference](/docs/api-reference/), or check out our [guide to building applications with the Groundlight SDK](/docs/guide/).
141
+
π **Amazing job!** You've just built your first computer vision application with Groundlight. In just a few lines of code, you've created an eagle detector that can analyze live video streams!
113
142
114
-
### Using Your Computer Vision Application
143
+
### Supercharge Your Application
115
144
116
-
Congratulations! You now have a fully functional computer vision application. You can easily customize the code and configure detectors for your specific use cases.
145
+
Take your application to the next level:
117
146
118
-
Monitor and enhance your detector's performance through the [Groundlight Dashboard](https://dashboard.groundlight.ai/).
119
-
Groundlight's human-in-the-loop technology intelligently monitors your image feed for anomalies and unexpected changes.
120
-
By reviewing and verifying results, you continuously improve the system's accuracy. Through the dashboard, you can also
121
-
[configure text and email notifications](/docs/guide/alerts) to alert you when important events are detected in your video stream.
147
+
-**Monitor in real-time** through the [Groundlight Dashboard](https://dashboard.groundlight.ai/) - see your detections, review results, and track performance
148
+
-**Get instant alerts** when important events happen - [set up text and email notifications](/docs/guide/alerts) for critical detections
149
+
-**Improve continuously** with Groundlight's human-in-the-loop technology that learns from your feedback
122
150
123
151
### Next Steps
124
152
125
-
Now that you've built your first application, you can:
126
-
1. Learn how to [write effective queries](/docs/getting-started/writing-queries).
127
-
2. Proceed to [capture images from a wide variety of sources](/docs/guide/grabbing-images) using [`framegrab`](https://github.com/groundlight/framegrab).
128
-
3. Read our guide to [confidence thresholds](/docs/guide/managing-confidence).
| π Explore the full API |[SDK Reference](/docs/api-reference/)|
131
159
132
160
Ready to explore more possibilities? Visit our [Guides](https://www.groundlight.ai/guides) to discover sample
133
161
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)
0 commit comments