From cd02cd31c3b1b8cf5c646dee6403ec52d4aaed26 Mon Sep 17 00:00:00 2001 From: Panos Vagenas <35837085+vagenas@users.noreply.github.com> Date: Thu, 27 Jul 2023 14:39:38 +0200 Subject: [PATCH] Update configuration.md Signed-off-by: Panos Vagenas <35837085+vagenas@users.noreply.github.com> --- docs/guide/configuration.md | 25 +++---------------------- 1 file changed, 3 insertions(+), 22 deletions(-) diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index fcd9bf61..3318f397 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -1,4 +1,4 @@ -# Configuration +e# Configuration The Toolkit can be configured via the CLI and via environment variables. @@ -111,26 +111,7 @@ Besides allowing the Toolkit to easily persist and manage config options (e.g. a above for profiles), this also means that configuration can be easily overriden via environment variables. -To see which environment variables are supported, check the Pydantic Settings files below, -taking into account the defined prefixes: - -| File | Description | -| --- | --- | -| [Core settings][settings_file] | Global and profile-level settings | -| [Model App settings][model_api_settings] | Settings for Model API App | - -For example: - -- `DEEPSEARCH_PROFILE`: controls profile for scope of single operation, e.g. - `DEEPSEARCH_PROFILE=bar deepsearch cps projects list` -- `DEEPSEARCH_SHOW_STACKTRACE`: controls if stacktraces are printed, e.g. - `DEEPSEARCH_SHOW_STACKTRACE=1 deepsearch profile show inexistent` - - -!!! note - - When extending the settings (e.g. like in [Model API][model_api_settings]), developers - must properly set `env_prefix` to prevent conflicts. +To see which environment variables are supported, check the relevant [Pydantic Settings +classes][settings_file], also taking into account any defined prefixes. [settings_file]: https://github.com/DS4SD/deepsearch-toolkit/blob/main/deepsearch/core/client/settings.py -[model_api_settings]: https://github.com/DS4SD/deepsearch-toolkit/blob/main/deepsearch/model/server/config.py