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

update docs/start/experiments.md #1511

Merged
merged 6 commits into from
Jul 3, 2020
Merged
Changes from 4 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
11 changes: 7 additions & 4 deletions content/docs/start/experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ $ dvc run -n evaluate \

### πŸ’‘ Expand to see what happens under the hood.

DVC generates a new stage in the `dvc.yaml` file:
The `-M` option here specifies a metrics file, while the `--plots-no-cache`
option specifies a plots file produced by this stage that will not be
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
<abbr>cached</abbr> by DVC. `dvc run` generates a new stage in the `dvc.yaml`
file:

```yaml
evaluate:
Expand All @@ -46,10 +49,10 @@ The biggest difference to previous stages in our pipeline is in two new
sections: `metrics` and `plots`. These are used to mark certain files containing
experiment "telemetry". Metrics files contain simple numeric values (e.g. `AUC`)
and plots files contain matrices and data series (e.g. `ROC` or model loss
plots) that meant to be visualizing and compared.
plots) that are meant to be visualized and compared.

> `cache: false` means that those file are small enough and versioned directly
> with Git.
> With `cache: false`, DVC skips caching the output as we want `scores.json` and
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
> `prc.json` to be versioned by Git.

</details>

Expand Down