Skip to content

Commit ce7fa89

Browse files
authored
API ref docs redirect (#119)
* Trying to set up a redirect for the API reference section. * Making the API reference page redirect without having to click a link * Updating edge docs * Comment on gitignore.
1 parent b494536 commit ce7fa89

File tree

4 files changed

+29
-7
lines changed

4 files changed

+29
-7
lines changed

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
.docusaurus
99
.cache-loader
1010
.package-lock.json
11+
# api-reference-docs are generated by sphinx and placed here.
12+
/static/api-reference-docs/
1113

1214
# Misc
1315
.DS_Store
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1-
# API Reference
1+
---
2+
id: redirect
3+
title: API Reference
4+
hide_title: true
5+
---
26

3-
Click [here](pathname:///python-sdk/api-reference-docs/) to access a detailed documentation of the SDK with all available methods.
7+
<meta http-equiv="refresh" content="0; url=/python-sdk/api-reference-docs/" />
Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
# Using Groundlight on the edge
22

3-
Starting your model evaluations at the edge reduces latency, cost, network bandwidth, and energy. Once you have downloaded and installed your Groundlight edge models, you can configure the Groundlight SDK to use your edge environment by configuring the 'endpoint' which the SDK connects to. You can do this either directly in code as such:
3+
If your account has access to edge models, you can download and install them to your edge devices.
4+
This allows you to run your model evaluations on the edge, reducing latency, cost, network bandwidth, and energy.
5+
6+
## How the Edge Endpoint works
7+
8+
The Edge Endpoint runs as a set of docker containers on an "edge device". This edge device can be an NVIDIA Jetson device, rack-mounted server, or even a Raspberry Pi. The Edge Endpoint is responsible for downloading and running the models,
9+
and for communicating with the Groundlight cloud service.
10+
11+
To use the edge endpoint, simply configure the Groundlight SDK to use the edge endpoint's URL instead of the cloud endpoint.
12+
All application logic will work seamlessly and unchanged with the Groundlight Edge Endpoint, except some ML answers will
13+
return much faster locally. The only visible difference is that image queries answered at the edge endpoint will have the prefix `iqe_` instead of `iq_` for image queries answered in the cloud. `iqe_` stands for "image query edge". Edge-originated
14+
image queries will not appear in the cloud dashboard.
15+
16+
## Configuring the Edge Endpoint
17+
18+
To configure the Groundlight SDK to use the edge endpoint, you can either pass the endpoint URL to the Groundlight constructor like:
419

520
```python
621
from groundlight import Groundlight
@@ -12,7 +27,4 @@ or by setting the `GROUNDLIGHT_ENDPOINT` environment variable like:
1227
```bash
1328
export GROUNDLIGHT_ENDPOINT=http://localhost:6717
1429
python your_app.py
15-
```
16-
17-
(Edge model download is not yet generally available. Work with your Solutions Engineer to set up edge inference.)
18-
30+
```

docs/src/css/custom.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,7 @@ See: https://docusaurus.io/docs/styling-layout#styling-your-site-with-infima
3434
--ifm-color-primary-lightest: #c8dbf5;
3535
--docusaurus-highlighted-code-line-bg: rgba(68, 105, 165, 0.3);
3636
}
37+
38+
.page-content[data-id='redirect'] {
39+
display: none;
40+
}

0 commit comments

Comments
 (0)