Skip to content

Commit

Permalink
ref: update exp init --type value (#3657)
Browse files Browse the repository at this point in the history
* ref: update exp init --type value
for #3656

* ref: update exp init --live and --type

* Apply suggestions from code review

* Update content/docs/command-reference/exp/init.md

* Update content/docs/command-reference/exp/init.md

Co-authored-by: dberenbaum <dave@iterative.ai>
  • Loading branch information
jorgeorpinel and dberenbaum committed Jun 16, 2022
1 parent 9112055 commit 17135f0
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions content/docs/command-reference/exp/init.md
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,7 @@ $ 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. Overrides the default values for `--metrics` and `--plots`.

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

0 comments on commit 17135f0

Please sign in to comment.