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.

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

Restyle guide: Add Comparing Experiments #2863

Merged
merged 1 commit into from
Sep 28, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -21,28 +26,34 @@ $ 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
```

## 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
Expand All @@ -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

Expand All @@ -61,4 +72,4 @@ $ dvc exp list --names-only --all

### Get a Markdown table for the differences

### Ignore the path
### Ignore the path