Skip to content

Commit 6c1ee21

Browse files
committed
Add env variable documentation
Describes the environment variables needed to access the remote models
1 parent 68f1ddd commit 6c1ee21

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/environment.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,9 @@ and configurations.
3434
A verbosity flag that can be set to turn on debug logging. Defaults to "not set", which translates
3535
to no debug logging. Setting this value to anything will turn on debug logging
3636
(e.g., ``VERBOSE=1``).
37+
- ``SCOUTBOT_MODEL_URL`` (default: https://wildbookiarepository.azureedge.net/models)
38+
The base URL for downloading ONNX model files. This allows organizations to host models on their
39+
own infrastructure instead of using the default CDN.
40+
- ``SCOUTBOT_DATA_URL`` (default: https://wildbookiarepository.azureedge.net/data)
41+
The base URL for downloading test data files. This allows organizations to host test data on their
42+
own infrastructure instead of using the default CDN.

docs/onnx.rst

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,7 @@ hosted on a separate CDN for convenient access and can be fetched by running the
1010
.. note::
1111

1212
The model download URL can be configured via the ``SCOUTBOT_MODEL_URL`` environment variable.
13-
This allows organizations to host models on their own infrastructure. For example:
14-
15-
.. code-block:: bash
16-
17-
export SCOUTBOT_MODEL_URL="https://your-cdn.example.com/models"
18-
19-
Similarly, test data URLs can be configured via ``SCOUTBOT_DATA_URL``.
13+
See :doc:`environment` for details.
2014

2115
- :meth:`scoutbot.wic.fetch`
2216
- :meth:`scoutbot.loc.fetch`

0 commit comments

Comments
 (0)