From 838296a1fe7c7d30d258db5e8f53e8ef7f33468f Mon Sep 17 00:00:00 2001 From: Hardik Jaroli Date: Tue, 3 Nov 2020 19:48:54 +0530 Subject: [PATCH 1/3] Example updates --- content/docs/command-reference/metrics/show.md | 2 +- content/docs/command-reference/params/diff.md | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/content/docs/command-reference/metrics/show.md b/content/docs/command-reference/metrics/show.md index d20fe32bf0..66754935b4 100644 --- a/content/docs/command-reference/metrics/show.md +++ b/content/docs/command-reference/metrics/show.md @@ -60,7 +60,7 @@ compares them with a previous version. ## Examples -> This example is based on the `evaluate.dvc` stage file of our +> This example is based on the `evaluate` stage of our > [Get Started](/doc/tutorials/get-started/experiments#project-metrics), where > you can find the actual source code. diff --git a/content/docs/command-reference/params/diff.md b/content/docs/command-reference/params/diff.md index 63a8bf433b..d01ea2553a 100644 --- a/content/docs/command-reference/params/diff.md +++ b/content/docs/command-reference/params/diff.md @@ -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 \ + python train.py ``` Let's now print parameter values that we are tracking in this From 9ff123a2e46dad0ead14d07aaad611c4413770dc Mon Sep 17 00:00:00 2001 From: Hardik Jaroli Date: Wed, 4 Nov 2020 23:41:50 +0530 Subject: [PATCH 2/3] Metrics update --- content/docs/command-reference/metrics/index.md | 4 ++-- content/docs/command-reference/metrics/show.md | 9 ++------- 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/content/docs/command-reference/metrics/index.md b/content/docs/command-reference/metrics/index.md index 7f3a1ed522..d34cfead1d 100644 --- a/content/docs/command-reference/metrics/index.md +++ b/content/docs/command-reference/metrics/index.md @@ -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. First, let's imagine we have a simple [stage](/doc/command-reference/run) that produces a `eval.json` metrics file: diff --git a/content/docs/command-reference/metrics/show.md b/content/docs/command-reference/metrics/show.md index 66754935b4..70e4e020e6 100644 --- a/content/docs/command-reference/metrics/show.md +++ b/content/docs/command-reference/metrics/show.md @@ -61,8 +61,8 @@ compares them with a previous version. ## Examples > This example is based on the `evaluate` stage of 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. The basic use case shows the values in the current workspace: @@ -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. From bbe435b32f18f65791c665a8f16efbd0c44ff110 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 12 Nov 2020 01:11:00 -0600 Subject: [PATCH 3/3] Update content/docs/command-reference/params/diff.md --- content/docs/command-reference/params/diff.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/command-reference/params/diff.md b/content/docs/command-reference/params/diff.md index d01ea2553a..02a51fa522 100644 --- a/content/docs/command-reference/params/diff.md +++ b/content/docs/command-reference/params/diff.md @@ -71,8 +71,8 @@ dependencies: ```dvc $ dvc run -n train \ - -d train.py -d users.csv \ - -o model.pkl -p lr,train \ + -d train.py -d users.csv -o model.pkl \ + -p lr,train \ python train.py ```