diff --git a/content/docs/user-guide/experiment-management/comparing-experiments.md b/content/docs/user-guide/experiment-management/comparing-experiments.md index 4c496571c5..274cf868c9 100644 --- a/content/docs/user-guide/experiment-management/comparing-experiments.md +++ b/content/docs/user-guide/experiment-management/comparing-experiments.md @@ -1,17 +1,22 @@ # Comparing Experiments -After running the experiments, it's important to compare them by their parameters and the metrics they produced. DVC provides three commands to list, tabulate and compare the experiments. In this section we discuss various use cases and options to streamline the work in experimentation. - +After running the experiments, it's important to compare them by their +parameters and the metrics they produced. DVC provides three commands to list, +tabulate and compare the experiments. In this section we discuss various use +cases and options to streamline the work in experimentation. ## List experiments in the workspace -After running the experiments, you can get a list of them by `dvc exp list`. Without any options this command lists the experiments after the most recent commit. +After running the experiments, you can get a list of them by `dvc exp list`. +Without any options this command lists the experiments after the most recent +commit. ```dvc $ dvc exp list ``` -If you want to list all the experiments in the repository independent of the commits. you can use `--all` flag. +If you want to list all the experiments in the repository independent of the +commits. you can use `--all` flag. ```dvc $ dvc exp list --all @@ -21,13 +26,17 @@ $ dvc exp list --all ## List experiments in another Git remote -As we discussed in [Sharing Experiments] section, `dvc exp push` enables to upload experiments to Git remotes. When you want to review these experiments, you can do so by supplying the Git remote name to `dvc exp list`. +As we discussed in [Sharing Experiments] section, `dvc exp push` enables to +upload experiments to Git remotes. When you want to review these experiments, +you can do so by supplying the Git remote name to `dvc exp list`. ```dvc -$ dvc exp list origin +$ dvc exp list origin ``` -This command lists the experiments originated from `HEAD`. If you want to see all the experiments in the repository, you need to add `--all` argument to this command as well. +This command lists the experiments originated from `HEAD`. If you want to see +all the experiments in the repository, you need to add `--all` argument to this +command as well. ```dvc $ dvc exp list origin --all @@ -35,14 +44,16 @@ $ dvc exp list origin --all ## List experiment names to use in scripts -When you want to get a _machine-oriented_ list of experiments to use in scripts, `dvc exp list` may be printing more than the necessary information. You can use get only the names of the experiments via `--names-only` flag. The following command provides a flat list of experiment names that you can use in scripts rather easily. +When you want to get a _machine-oriented_ list of experiments to use in scripts, +`dvc exp list` may be printing more than the necessary information. You can use +get only the names of the experiments via `--names-only` flag. The following +command provides a flat list of experiment names that you can use in scripts +rather easily. ```dvc $ dvc exp list --names-only --all ``` - - ## List experiments of a particular commit, tag or branch ## Show a table of experiments @@ -51,7 +62,7 @@ $ dvc exp list --names-only --all ## Get a JSON list of experiments to use scripts -## Compare two experiments +## Compare two experiments ## Compare an experiment with the workspace @@ -61,4 +72,4 @@ $ dvc exp list --names-only --all ### Get a Markdown table for the differences -### Ignore the path +### Ignore the path