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.

Sign up for GitHub

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

Updates metrics show and Plots diff example as per 1.0 #1908

Merged
merged 3 commits into from
Nov 12, 2020
Merged

Updates metrics show and Plots diff example as per 1.0 #1908

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
838296a
Example updates
imhardikj Nov 3, 2020
9ff123a
Metrics update
imhardikj Nov 4, 2020
bbe435b
Update content/docs/command-reference/params/diff.md
jorgeorpinel Nov 12, 2020
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
4 changes: 2 additions & 2 deletions content/docs/command-reference/metrics/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ to compare and pick the best performing experiment.
## Examples

> This example is based on our
> [Get Started](/doc/tutorials/get-started/experiments#project-metrics), where
> you can find the actual source code.
> [Get Started](/doc/start/experiments#collecting-metrics), where you can find
> the actual source code.
Comment on lines -106 to +107
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see this addresses "Several cmd examples/links need updating" which is good although... Not related to 1.0 at all. Also, there's another 23 instances of old tutorials/get-started links that aren't updated here...


First, let's imagine we have a simple [stage](/doc/command-reference/run) that
produces a `eval.json` metrics file:
Expand Down
11 changes: 3 additions & 8 deletions content/docs/command-reference/metrics/show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ compares them with a previous version.

## Examples

> This example is based on the `evaluate.dvc` stage file of our
> [Get Started](/doc/tutorials/get-started/experiments#project-metrics), where
> you can find the actual source code.
> This example is based on the `evaluate` stage of our
> [Get Started](/doc/start/experiments#collecting-metrics), where you can find
> the actual source code.

The basic use case shows the values in the current workspace:

Expand Down Expand Up @@ -116,8 +116,3 @@ increase_bow:
error: 0.17074
TP: 521
```

The
[Compare Experiments](/doc/tutorials/get-started/experiments#compare-experiments)
chapter of our _Get Started_ covers the `-a` option to collect and print a
metrics file value across all Git branches.
7 changes: 4 additions & 3 deletions content/docs/command-reference/params/diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,10 @@ Define a pipeline [stage](/doc/command-reference/run) with parameter
dependencies:

```dvc
$ dvc run -d users.csv -o model.pkl \
-p lr,train \
python train.py
$ dvc run -n train \
-d train.py -d users.csv \
-o model.pkl -p lr,train \
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
python train.py
```

Let's now print parameter values that we are tracking in this
Expand Down