-
Notifications
You must be signed in to change notification settings - Fork 394
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
guide: begin Managing Experiments guide
per #2690 (review)
- Loading branch information
1 parent
ec57601
commit 47b6c44
Showing
2 changed files
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
content/docs/user-guide/experiment-management/managing-experiments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# Managing Experiments | ||
|
||
Once you have defined and/or [run experiments] in your project, you can use | ||
several features of DVC to see, compare, reproduce, share, or remove them. | ||
|
||
[run experiments]: /doc/user-guide/experiment-management/running-experiments | ||
|
||
## Experiment names | ||
|
||
Experiments created with `dvc exp run` will have an auto-generated name like | ||
`exp-bfe64` by default. It can be customized using the `--name` (`-n`) option: | ||
|
||
```dvc | ||
$ dvc exp run --name cnn-512 --set-param model.conv_units=512 | ||
``` | ||
|
||
When you create an experiment, DVC generates a Git-like SHA-1 hash from its | ||
contents. This is shown when you [queue experiments] with `--queue`: | ||
|
||
[queue experiments]: | ||
/doc/user-guide/experiment-management/running-experiments#the-experiments-queue | ||
|
||
```dvc | ||
$ dvc exp run --queue -S model.conv_units=32 | ||
Queued experiment '6518f17' for future execution. | ||
``` | ||
|
||
After running queued experiment, DVC uses the regular name mentioned earlier. | ||
|
||
> Note that you can set a queued experiment's name in advance: | ||
> | ||
> ```dvc | ||
> $ dvc exp run --queue --name cnn-512 -S model.conv_units=512 | ||
> Queued experiment '86bd8f9' for future execution. | ||
> ``` | ||
You can refer to experiments in `dvc exp apply` or `dvc exp branch` either with | ||
regular experiment names or by their SHA hashes. | ||
## Listing experiments | ||
Use `dvc exp show` to see both run and queued experiments: | ||
```dvc | ||
$ dvc exp show --no-pager --no-timestamp \ | ||
--include-metrics loss --include-params model.conv_units | ||
``` | ||
```dvctable | ||
βββββββββββββββββββββββββββ³ββββββββββ³βββββββββββββββββββ | ||
β neutral:**Experiment** β metric:**loss** β param:**model.conv_units** β | ||
β‘βββββββββββββββββββββββββββββββββββββββββββββββββββββββ© | ||
β workspace β 0.23534 β 64 β | ||
β 3973b6b β - β 16 β | ||
β βββ aeaabb0 [exp-cb13f] β 0.23534 β 64 β | ||
β βββ d0ee7ce [exp-5dccf] β 0.23818 β 32 β | ||
β βββ 1533e4d [exp-88874] β 0.24039 β 128 β | ||
β βββ b1f41d3 [cnn-256] β 0.23296 β 256 β | ||
β βββ 07e927f [exp-6c06d] β 0.23279 β 24 β | ||
β βββ b2b8586 [exp-2a1d5] β 0.25036 β 16 β | ||
β βββ *86bd8f9 β - β 512 β | ||
βββββββββββββββββββββββββββ΄ββββββββββ΄βββββββββββββββββββ | ||
``` | ||
|
||
When an experiment is not run yet, only the former hash is shown (marked with | ||
`*`). | ||
|
||
<!-- WIP --> |