readme

groundlight · May 6, 2022 · afe6e9a · afe6e9a
1 parent c850397
commit afe6e9a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,8 @@ Now you can use the python SDK!
 ```Python
 from groundlight import Groundlight
 
-# Load the API client
+# Load the API client. This defaults to the prod endpoint, but you can specify a different
+# endpoint like so: gl = Groundlight(endpoint="https://device.integ.positronix.ai/device-api")
 gl = Groundlight()
 
 # Call an API method (e.g., retrieve a list of detectors)

diff --git a/src/groundlight/client.py b/src/groundlight/client.py
@@ -24,15 +24,15 @@ class Groundlight(DetectorsApi, ImageQueriesApi):
     ```
     """
 
-    def __init__(self, host: str = "https://device.positronix.ai/device-api"):
+    def __init__(self, endpoint: str = "https://device.positronix.ai/device-api"):
         """
-        :param host: optionally specify a different endpoint. E.g.
+        :param endpoint: optionally specify a different endpoint. E.g.
             - Prod (default): https://device.positronix.ai/device-api
             - Integ: https://device.integ.positronix.ai/device-api
             - Localhost tunnel to a GPU instance: http://localhost:8000/device-api
         """
         # Specify the endpoint
-        configuration = Configuration(host=host)
+        configuration = Configuration(host=endpoint)
 
         # Retrieve the API token from environment variable
         try: