From e90a4cb73ae95e2157d9201738448d16ca0c82df Mon Sep 17 00:00:00 2001 From: dberenbaum Date: Tue, 23 May 2023 21:06:28 -0400 Subject: [PATCH] update output format of dvc exp list --- content/docs/command-reference/exp/list.md | 14 +++---- content/docs/command-reference/exp/pull.md | 8 ++-- content/docs/command-reference/exp/push.md | 8 ++-- .../cleaning-experiments.md | 37 ++++++++++--------- .../comparing-experiments.md | 26 ++++++------- 5 files changed, 47 insertions(+), 46 deletions(-) diff --git a/content/docs/command-reference/exp/list.md b/content/docs/command-reference/exp/list.md index 2cf4a1c320..49335cd0ab 100644 --- a/content/docs/command-reference/exp/list.md +++ b/content/docs/command-reference/exp/list.md @@ -75,9 +75,9 @@ available experiments with this command: ```cli $ dvc exp list --all-commits 10-bigrams-experiment: - bally-gude - gluey-leak - lurid-lair + 60b225a [bally-gude] + b485671 [gluey-leak] + 5f30433 [lurid-lair] ``` > Contrast this with the full table @@ -88,8 +88,8 @@ You can also list experiments in any DVC repo with `dvc exp list`: ```cli $ dvc exp list --all-commits git@github.com:iterative/example-get-started.git 10-bigrams-experiment: - bally-gude - conic-ease + bally-gude + conic-ease ``` We can see that two experiments are available in @@ -104,8 +104,8 @@ $ git remote -v origin git@github.com:iterative/example-get-started.git $ dvc exp list --all-commits origin 10-bigrams-experiment: - bally-gude - conic-ease + bally-gude + conic-ease ``` And in this context, `dvc exp pull` can download the experiments if needed, as diff --git a/content/docs/command-reference/exp/pull.md b/content/docs/command-reference/exp/pull.md index 0bb1e53102..b9fa116598 100644 --- a/content/docs/command-reference/exp/pull.md +++ b/content/docs/command-reference/exp/pull.md @@ -104,8 +104,8 @@ that someone else shared (see also `dvc exp list`). ```cli $ dvc exp list --all-commits origin -master: - lurid-lair +main: + lurid-air $ dvc exp pull origin lurid-lair Pulled experiment 'lurid-lair' from Git remote 'origin'. ``` @@ -114,6 +114,6 @@ We can now see that the experiment exists in the local repo: ```cli $ dvc exp list --all-commits -master: - lurid-lair +main: + 5cdc6a9 [lurid-air] ``` diff --git a/content/docs/command-reference/exp/push.md b/content/docs/command-reference/exp/push.md index 92c981b95a..6d12401307 100644 --- a/content/docs/command-reference/exp/push.md +++ b/content/docs/command-reference/exp/push.md @@ -109,9 +109,9 @@ Let's say we have run 3 experiments in our project: ```cli $ dvc exp list --all-commits 11-bigrams-experiment: - conic-ease - lucid-lair - major-mela + 1d4c01d [conic-ease] + a80bca5 [lucid-lair] + 9380a12 [major-mela] ``` We would now like to share one of them with others via the Git remote: @@ -126,5 +126,5 @@ We can now see that the experiment exists in the remote repo: ```cli $ dvc exp list --all origin master: - conic-ease + conic-ease ``` diff --git a/content/docs/user-guide/experiment-management/cleaning-experiments.md b/content/docs/user-guide/experiment-management/cleaning-experiments.md index 5ec4dd2cc6..79bc33cdb0 100644 --- a/content/docs/user-guide/experiment-management/cleaning-experiments.md +++ b/content/docs/user-guide/experiment-management/cleaning-experiments.md @@ -14,9 +14,9 @@ and supply the experiment name. ```cli $ dvc exp list main: - cnn-32 - cnn-64 - cnn-128 + 2399f24 [cnn-128] + 4e8a178 [cnn-32] + f1edf21 [cnn-64] $ dvc exp remove cnn-32 cnn-64 Removed experiments: cnn-32,cnn-64 ``` @@ -30,10 +30,11 @@ experiments derived from it, use `dvc exp remove --rev` with `HEAD`. ```cli $ dvc exp list refs/tags/baseline-experiment: - cnn-128 - cnn-32 - cnn-64 - cnn-96 + 2399f24 [cnn-128] + 4e8a178 [cnn-32] + f1edf21 [cnn-64] + bdf6fa2 [cnn-96] + $ dvc exp remove --rev HEAD Removed experiments: cnn-128,cnn-32,cnn-64,cnn-96 ``` @@ -61,16 +62,16 @@ removed **except** those in the current workspace. ```cli $ dvc exp list --all-commits main: - exp-aaa000 - exp-aaa111 - exp-aaa222 + 1f7e42f [toric-chiv] + 48b0af9 [cadgy-site] + 935d6e9 [melic-plum] other: - exp-bbb333 - exp-bbb444 + 97501f9 [algal-toms] + 0f1523d [heady-sera] another: - exp-ccc555 - exp-ccc666 - exp-ccc777 + bc0e834 [riled-song] + b3447f3 [forky-aits] + dacb364 [hooly-firm] ``` Issuing `dvc exp gc --workspace` removes experiments in `other` and `another` @@ -80,9 +81,9 @@ branches in this example. $ dvc exp gc --workspace $ dvc exp list --all-commits main: - exp-abc000 - exp-abc111 - exp-abc222 + 1f7e42f [toric-chiv] + 48b0af9 [cadgy-site] + 935d6e9 [melic-plum] ``` ### Keeping experiments in all branches diff --git a/content/docs/user-guide/experiment-management/comparing-experiments.md b/content/docs/user-guide/experiment-management/comparing-experiments.md index 1bfb2ac3ab..ac459c1b75 100644 --- a/content/docs/user-guide/experiment-management/comparing-experiments.md +++ b/content/docs/user-guide/experiment-management/comparing-experiments.md @@ -24,8 +24,8 @@ the latest commit of the current branch (Git `HEAD`). ```cli $ dvc exp list refs/tags/baseline-experiment: - cnn-64 - cnn-128 + 2399f24 [cnn-128] + f1edf21 [cnn-64] ``` If you want to list all the experiments in the repo regardless of their parent @@ -34,10 +34,10 @@ commit, use the `--all-commits` (`-A`) flag. ```cli $ dvc exp list -A refs/tags/baseline-experiment: - cnn-64 - cnn-128 + 2399f24 [cnn-128] + f1edf21 [cnn-64] main: - unwet-jinn + 1f7e42f [toric-chiv] ``` ## List experiments saved remotely @@ -49,8 +49,8 @@ not have locally), provide a Git remote name to `dvc exp list`. ```cli $ dvc exp list origin refs/tags/baseline-experiment: - cnn-32 - cnn-64 + cnn-32 + cnn-64 ``` This command lists remote experiments based on that repo's `HEAD`. You can use @@ -83,20 +83,20 @@ the experiments that are based on it. For example: # from a commit: $ dvc exp list origin --rev 23ceb4a 23ceb4a: - cnn-32 - cnn-96 + cnn-32 + cnn-96 # from a tag: $ dvc exp list origin --rev baseline-experiment refs/tags/baseline-experiment: - cnn-64 - cnn-128 + cnn-64 + cnn-128 # from a fully specified Git reference: $ dvc exp list origin --rev refs/tags/baseline-experiment refs/tags/baseline-experiment: - cnn-64 - cnn-128 + cnn-64 + cnn-128 ``` ## Show a table of experiments