From 9a4505df8bc048d7c10a77858354849c6a76b50d Mon Sep 17 00:00:00 2001 From: dberenbaum Date: Mon, 4 Dec 2023 15:40:27 -0500 Subject: [PATCH 1/2] document env vars --- content/docs/dvclive/env.md | 8 +++++--- content/docs/sidebar.json | 4 ++++ content/docs/user-guide/env.md | 23 +++++++++++++++++++++++ 3 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 content/docs/user-guide/env.md diff --git a/content/docs/dvclive/env.md b/content/docs/dvclive/env.md index f4a49e0bc5..e1b8f63e22 100644 --- a/content/docs/dvclive/env.md +++ b/content/docs/dvclive/env.md @@ -1,4 +1,4 @@ -# dvclive.env +# Environment Variables List of environment variables to configure DVCLive behavior. @@ -13,5 +13,7 @@ os.environ[env.DVCLIVE_OPEN] = "True" - `DVCLIVE_LOGLEVEL`: Configure the [logging level](https://docs.python.org/3/library/logging.html#logging-levels) of DVCLive. Defaults to `WARNING`. -- `DVCLIVE_OPEN`: If True, DVCLive will try to automatically open the HTML - generated by `Live.make_report()` in the default browser. Defaults to `False`. +- `DVCLIVE_OPEN`: If `true`, DVCLive will try to automatically open the HTML + generated by `Live.make_report()` in the default browser. Defaults to `false`. + +See also [DVC environment variables](/doc/user-guide/env). diff --git a/content/docs/sidebar.json b/content/docs/sidebar.json index 71761951ea..ceda59b3dc 100644 --- a/content/docs/sidebar.json +++ b/content/docs/sidebar.json @@ -243,6 +243,10 @@ } ] }, + { + "label": "Environment Variables", + "slug": "env" + }, "troubleshooting", { "label": "Anonymized Usage Analytics", diff --git a/content/docs/user-guide/env.md b/content/docs/user-guide/env.md new file mode 100644 index 0000000000..7553cfa7ee --- /dev/null +++ b/content/docs/user-guide/env.md @@ -0,0 +1,23 @@ +# Environment Variables + +List of environment variables to configure DVC behavior. + +- `DVC_EXP_AUTO_PUSH`: If `true`, run `dvc exp push` at the end of a successful + experiment. +- `DVC_EXP_GIT_REMOTE`: The name of the Git remote to use in `DVC_EXP_AUTO_PUSH` + (for example, `origin`). +- `DVC_NO_ANALYTICS`: If `true`, disables + [analytics](/doc/user-guide/analytics). Overrides `dvc config core.analytics`. +- `DVC_PAGER`: Set what program DVC uses for paging output (for example, + `more`). +- `DVC_STUDIO_OFFLINE`: If `true`, disables sharing + [live experiments](/doc/studio/user-guide/experiments/live-metrics-and-plots) + even if the DVC Studio token is set. Overrides `dvc config studio.offline`. +- `DVC_STUDIO_REPO_URL`: Set URL of Git remote associated with the DVC Studio + project. Overrides `dvc config studio.repo_url`. +- `DVC_STUDIO_TOKEN`: Set DVC Studio access token to use. Overrides + `dvc config studio.token`. +- `DVC_STUDIO_URL`: Set URL of Studio to use (in case of self-hosted DVC Studio + instance). Overrides `dvc config studio.url`. + +See also [DVCLive environment variables](/doc/dvclive/env). From 2ca0a765e19f69384a0f825ec86348d82286ed46 Mon Sep 17 00:00:00 2001 From: dberenbaum Date: Tue, 12 Dec 2023 10:51:50 -0500 Subject: [PATCH 2/2] drop DVC_EXP_AUTO_PUSH from env vars --- content/docs/user-guide/env.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/content/docs/user-guide/env.md b/content/docs/user-guide/env.md index 7553cfa7ee..5232973408 100644 --- a/content/docs/user-guide/env.md +++ b/content/docs/user-guide/env.md @@ -2,10 +2,6 @@ List of environment variables to configure DVC behavior. -- `DVC_EXP_AUTO_PUSH`: If `true`, run `dvc exp push` at the end of a successful - experiment. -- `DVC_EXP_GIT_REMOTE`: The name of the Git remote to use in `DVC_EXP_AUTO_PUSH` - (for example, `origin`). - `DVC_NO_ANALYTICS`: If `true`, disables [analytics](/doc/user-guide/analytics). Overrides `dvc config core.analytics`. - `DVC_PAGER`: Set what program DVC uses for paging output (for example,