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

start: Add a parameters hidden section to experiments to merge params/metrics into experiments #3163

Merged
merged 8 commits into from
Jan 12, 2022
Merged
Changes from 2 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
27 changes: 27 additions & 0 deletions content/docs/start/experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,33 @@ Experiment results have been applied to your workspace.

<details>

### ℹ️ More information about (Hyper)parameters

It's pretty common for data science projects to include configuration files that
define adjustable parameters to train a model, adjust model architecture, do
pre-processing, etc. DVC provides a mechanism for stages to depend on the
specific variables from a file.
iesahin marked this conversation as resolved.
Show resolved Hide resolved

By default, DVC assumes a parameters file named `params.yaml` is available in
iesahin marked this conversation as resolved.
Show resolved Hide resolved
your project. DVC parses this file and creates dependencies to the variables
(`model.conv_units` and `train.epochs`) found in the file.
iesahin marked this conversation as resolved.
Show resolved Hide resolved

Here is the contents of `params.yaml` file:
iesahin marked this conversation as resolved.
Show resolved Hide resolved

```yaml
train:
epochs: 10
model:
conv_units: 16
```

When you use `--set-param` option for `dvc exp run`, DVC updates these values
iesahin marked this conversation as resolved.
Show resolved Hide resolved
iesahin marked this conversation as resolved.
Show resolved Hide resolved
with the values you set in the command line before running the experiment.

</details>

<details>

### ⚙️ Run multiple experiments in parallel

Instead of running the experiments one-by-one, we can define them to run in a
Expand Down