From 4042082dfb2eef14df83a4af5f9944cfb12565ff Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Sat, 27 Mar 2021 19:10:00 -0600 Subject: [PATCH] ref: add Dvclive options to stage add per https://github.com/iterative/dvc.org/pull/2227#pullrequestreview-607185381 --- content/docs/command-reference/run.md | 11 +++++++++++ content/docs/command-reference/stage/add.md | 11 +++++++++++ content/docs/dvclive/dvclive-with-dvc.md | 2 ++ 3 files changed, 24 insertions(+) diff --git a/content/docs/command-reference/run.md b/content/docs/command-reference/run.md index b78d37e76c..6beb7712cc 100644 --- a/content/docs/command-reference/run.md +++ b/content/docs/command-reference/run.md @@ -268,6 +268,17 @@ $ dvc run -n second_stage './another_script.sh $MYENVVAR' - `--desc ` - user description of the stage (optional). This doesn't affect any DVC operations. +- `--live ` - specify the directory `path` for + [Dvclive](/doc/dvclive/dvclive-with-dvc) to write logs in. Saved in the `live` + field of `dvc.yaml`. + +- `--live-no-cache ` - specify a Dvclive log file output (not + cached). Turns any `-o ` into a `-O`. + +- `--live-no-summary` - passes `summary=False` to Dvclive config. + +- `--live-no-html` - passes `html=False` to Dvclive config. + - `-h`, `--help` - prints the usage/help message, and exit. - `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no diff --git a/content/docs/command-reference/stage/add.md b/content/docs/command-reference/stage/add.md index 15a1b00636..3724060e9b 100644 --- a/content/docs/command-reference/stage/add.md +++ b/content/docs/command-reference/stage/add.md @@ -246,6 +246,17 @@ data science experiments. - `--desc ` - user description of the stage (optional). This doesn't affect any DVC operations. +- `--live ` - specify the directory `path` for + [Dvclive](/doc/dvclive/dvclive-with-dvc) to write logs in. Saved in the `live` + field of `dvc.yaml`. + +- `--live-no-cache ` - specify a Dvclive log file output (not + cached). Turns any `-o ` into a `-O`. + +- `--live-no-summary` - passes `summary=False` to Dvclive config. + +- `--live-no-html` - passes `html=False` to Dvclive config. + - `-h`, `--help` - prints the usage/help message, and exit. - `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no diff --git a/content/docs/dvclive/dvclive-with-dvc.md b/content/docs/dvclive/dvclive-with-dvc.md index 2895cce328..3774bd8a02 100644 --- a/content/docs/dvclive/dvclive-with-dvc.md +++ b/content/docs/dvclive/dvclive-with-dvc.md @@ -97,6 +97,8 @@ The value passed to `--live` (`training_metrics`) became the directory `path` for Dvclive to write logs in. Other supported command options for DVC integration: +- `--live-no-cache ` - specify a Dvclive log file output (not + cached). - `--live-no-summary` - passes `summary=False` to Dvclive. - `--live-no-html` - passes `html=False` to Dvclive.