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

Jump to bottom

ref: update exp init --type value #3657

Merged
merged 5 commits into from
Jun 16, 2022
Merged

ref: update exp init --type value #3657

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
60217e2
ref: update exp init --type value
jorgeorpinel Jun 14, 2022
df64a47
ref: update exp init --live and --type
dberenbaum Jun 15, 2022
9c2b54f
Apply suggestions from code review
jorgeorpinel Jun 16, 2022
51e0d43
Update content/docs/command-reference/exp/init.md
jorgeorpinel Jun 16, 2022
56f1115
Update content/docs/command-reference/exp/init.md
jorgeorpinel Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 6 additions & 8 deletions content/docs/command-reference/exp/init.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ usage: dvc exp init [-h] [-q | -v] [--run] [--interactive] [-f]
[--explicit] [--name NAME] [--code CODE]
[--data DATA] [--models MODELS] [--params PARAMS]
[--metrics METRICS] [--plots PLOTS] [--live LIVE]
[--type {default,dl}]
[--type {default,checkpoint}]
[command]
```

Expand Down Expand Up @@ -100,12 +100,9 @@ $ dvc exp init './another_script.sh $MYENVVAR'
`dvc exp run`).

- `--type` - selects the type of the stage to create. Currently it provides two
alternatives: `dl` and `default` (no need to specify this one).

`dl` stages are intended for use in deep-learning scenarios, where metrics and
plots are tracked with [DVCLive](/doc/dvclive). This also supports logging
[checkpoints](/doc/command-reference/exp/run#checkpoints) during the training
of DL models.
alternatives: `checkpoint` (supports logging
[checkpoints](/doc/command-reference/exp/run#checkpoints) during model
training) and `default` (no need to specify this).

- `--code` - set the path to the file or directory where the source code that
your experiment depends on can be found (if any). Overrides other
Expand Down Expand Up @@ -135,7 +132,8 @@ $ dvc exp init './another_script.sh $MYENVVAR'

- `--live` - set the path to the directory where the metrics and plots
[produced by DVCLive](https://dvc.org/doc/dvclive/dvclive-with-dvc#outputs)
will be found.
will be found. If `--live` is provided, it will override the default values
for `--metrics` and `--plots`.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

- `--explicit` - do not assume default locations of project dependencies and
outputs. You'll have to provide specific locations via other options or
Expand Down