tells users about GROUNDLIGHT_ENDPOINT in client docstring (#303)

groundlight · Jan 21, 2025 · 661aa5c · 661aa5c
1 parent c4abf70
commit 661aa5c
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/groundlight/client.py b/src/groundlight/client.py
@@ -62,7 +62,10 @@ class Groundlight:  # pylint: disable=too-many-instance-attributes
     Client for accessing the Groundlight cloud service. Provides methods to create visual detectors,
     submit images for analysis, and retrieve predictions.
 
-    The API token (auth) is specified through the **GROUNDLIGHT_API_TOKEN** environment variable by default.
+    The API token (auth) is specified through the **GROUNDLIGHT_API_TOKEN** environment variable by
+    default.
+    If you are using a Groundlight Edge device, you can specify the endpoint through the
+    **GROUNDLIGHT_ENDPOINT** environment variable.
 
     **Example usage**::