From 9c822cce1bc9b915208f17a0126a8297e88fd2b8 Mon Sep 17 00:00:00 2001 From: Leo Dirac Date: Sun, 15 Oct 2023 08:49:58 -0700 Subject: [PATCH 1/4] Trying to set up a redirect for the API reference section. --- docs/docs/api-reference/api-reference.md | 3 --- docs/docs/api-reference/redirect.md | 7 +++++++ docs/src/css/custom.css | 4 ++++ 3 files changed, 11 insertions(+), 3 deletions(-) delete mode 100644 docs/docs/api-reference/api-reference.md create mode 100644 docs/docs/api-reference/redirect.md diff --git a/docs/docs/api-reference/api-reference.md b/docs/docs/api-reference/api-reference.md deleted file mode 100644 index 8ccd363a..00000000 --- a/docs/docs/api-reference/api-reference.md +++ /dev/null @@ -1,3 +0,0 @@ -# API Reference - -Click [here](pathname:///python-sdk/api-reference-docs/) to access a detailed documentation of the SDK with all available methods. \ No newline at end of file diff --git a/docs/docs/api-reference/redirect.md b/docs/docs/api-reference/redirect.md new file mode 100644 index 00000000..170b80f9 --- /dev/null +++ b/docs/docs/api-reference/redirect.md @@ -0,0 +1,7 @@ +--- +id: redirect +title: API Reference +hide_title: true +--- + + \ No newline at end of file diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index e8aa2512..5555a2f0 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -34,3 +34,7 @@ See: https://docusaurus.io/docs/styling-layout#styling-your-site-with-infima --ifm-color-primary-lightest: #c8dbf5; --docusaurus-highlighted-code-line-bg: rgba(68, 105, 165, 0.3); } + +.page-content[data-id='redirect'] { + display: none; +} \ No newline at end of file From 5837ffd9d547874b7fe9c5b1cf5ea22b65c68f92 Mon Sep 17 00:00:00 2001 From: Leo Dirac Date: Sun, 15 Oct 2023 08:54:07 -0700 Subject: [PATCH 2/4] Making the API reference page redirect without having to click a link --- docs/.gitignore | 1 + docs/docs/api-reference/{redirect.md => api-reference.md} | 0 2 files changed, 1 insertion(+) rename docs/docs/api-reference/{redirect.md => api-reference.md} (100%) diff --git a/docs/.gitignore b/docs/.gitignore index e0b97416..a48721f8 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -8,6 +8,7 @@ .docusaurus .cache-loader .package-lock.json +/static/api-reference-docs/ # Misc .DS_Store diff --git a/docs/docs/api-reference/redirect.md b/docs/docs/api-reference/api-reference.md similarity index 100% rename from docs/docs/api-reference/redirect.md rename to docs/docs/api-reference/api-reference.md From 52bb3db30c6eb48f3d0ab1981f088c35e00f42b6 Mon Sep 17 00:00:00 2001 From: Leo Dirac Date: Sun, 15 Oct 2023 09:02:10 -0700 Subject: [PATCH 3/4] Updating edge docs --- docs/docs/building-applications/edge.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/docs/building-applications/edge.md b/docs/docs/building-applications/edge.md index b35f05f3..3098d0e0 100644 --- a/docs/docs/building-applications/edge.md +++ b/docs/docs/building-applications/edge.md @@ -1,6 +1,21 @@ # Using Groundlight on the edge -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: +If your account has access to edge models, you can download and install them to your edge devices. +This allows you to run your model evaluations on the edge, reducing latency, cost, network bandwidth, and energy. + +## How the Edge Endpoint works + +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, +and for communicating with the Groundlight cloud service. + +To use the edge endpoint, simply configure the Groundlight SDK to use the edge endpoint's URL instead of the cloud endpoint. +All application logic will work seamlessly and unchanged with the Groundlight Edge Endpoint, except some ML answers will +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 +image queries will not appear in the cloud dashboard. + +## Configuring the Edge Endpoint + +To configure the Groundlight SDK to use the edge endpoint, you can either pass the endpoint URL to the Groundlight constructor like: ```python from groundlight import Groundlight @@ -12,7 +27,4 @@ or by setting the `GROUNDLIGHT_ENDPOINT` environment variable like: ```bash export GROUNDLIGHT_ENDPOINT=http://localhost:6717 python your_app.py -``` - -(Edge model download is not yet generally available. Work with your Solutions Engineer to set up edge inference.) - +``` \ No newline at end of file From dd7afa29eb99a0eea6d5904f16a5a36a13b02568 Mon Sep 17 00:00:00 2001 From: Leo Dirac Date: Sun, 15 Oct 2023 17:01:51 -0700 Subject: [PATCH 4/4] Comment on gitignore. --- docs/.gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/.gitignore b/docs/.gitignore index a48721f8..b58c623c 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -8,6 +8,7 @@ .docusaurus .cache-loader .package-lock.json +# api-reference-docs are generated by sphinx and placed here. /static/api-reference-docs/ # Misc