Skip to content

Commit

Permalink
ref: add Dvclive options to stage add
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed Mar 28, 2021
1 parent eda7a86 commit 4042082
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
11 changes: 11 additions & 0 deletions content/docs/command-reference/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,17 @@ $ dvc run -n second_stage './another_script.sh $MYENVVAR'
- `--desc <text>` - user description of the stage (optional). This doesn't
affect any DVC operations.

- `--live <path>` - 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 <path>` - specify a Dvclive log file <abbr>output</abbr> (not
<abbr>cached</abbr>). Turns any `-o <path>` 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
Expand Down
11 changes: 11 additions & 0 deletions content/docs/command-reference/stage/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,17 @@ data science experiments.
- `--desc <text>` - user description of the stage (optional). This doesn't
affect any DVC operations.

- `--live <path>` - 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 <path>` - specify a Dvclive log file <abbr>output</abbr> (not
<abbr>cached</abbr>). Turns any `-o <path>` 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
Expand Down
2 changes: 2 additions & 0 deletions content/docs/dvclive/dvclive-with-dvc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <path>` - specify a Dvclive log file <abbr>output</abbr> (not
<abbr>cached</abbr>).
- `--live-no-summary` - passes `summary=False` to Dvclive.
- `--live-no-html` - passes `html=False` to Dvclive.

Expand Down

0 comments on commit 4042082

Please sign in to comment.