Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] logs: initial #1966

Closed
wants to merge 1 commit into from
Closed

[WIP] logs: initial #1966

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions content/docs/command-reference/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ command.

## Synopsis

# TODO logs

jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
```usage
usage: dvc run [-h] [-q | -v] -n <name> [-d <path>] [-o <path>]
[-O <path>] [-p [<path>:]<params_list>] [-m <path>]
Expand Down Expand Up @@ -221,6 +223,22 @@ $ dvc run -n my_stage './my_script.sh $MYENVVAR'
up to the user to manage them separately. See also the difference between `-o`
and `-O`.

- `--logs <path>` - specify a directory that will contain `dvclive` logs (#TODO
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
link) compatible structure:

```<path>
├── history
│ ├── m1.tsv
│ └── m2.tsv
└── latest.json
```

It is a convinience option that tells dvc that under `<path>/history` are
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
plots, and under `<path>/latest.json` are metrics logged by `dvclive`.

- `logs-no-cache <path>` - the same as `--logs` except that DVC does not track
the files.

- `-w <path>`, `--wdir <path>` - specifies a working directory for the `command`
to run in (uses the `wdir` field in `dvc.yaml`). Dependency and output files
(including metrics and plots) should be specified relative to this directory.
Expand Down