From 65ef3a3112a7828b14fef00b17a24fd7152f2d59 Mon Sep 17 00:00:00 2001 From: utkarshsingh99 Date: Tue, 30 Jun 2020 01:17:51 +0530 Subject: [PATCH 1/6] update docs/start/experiments.md --- content/docs/start/experiments.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/content/docs/start/experiments.md b/content/docs/start/experiments.md index b869f9ddb0..c5ce557aaa 100644 --- a/content/docs/start/experiments.md +++ b/content/docs/start/experiments.md @@ -46,10 +46,12 @@ 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 visualizing and compared. -> `cache: false` means that those file are small enough and versioned directly -> with Git. +The `-M` flag specifies a metrics file produced by this stage that is not tracked by DVC. In this case, we can version the file using Git and so we choose to ignore it in DVC. +The `--plots-no-cache` flag specifies a plot metrics file produced by this stage, which is not cached by DVC. If you want DVC to track the metrics and the plot metrics file produced, simply use `-m` and `--plots` respectively. + +> With cache: false, DVC skips caching the output as we want "scores.json" to be versioned by Git. From 753a3ca92a99e7454978efca11f7cdc7c16e9468 Mon Sep 17 00:00:00 2001 From: utkarshsingh99 Date: Tue, 30 Jun 2020 01:21:15 +0530 Subject: [PATCH 2/6] removed condescending language: update experiments.md --- content/docs/start/experiments.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/content/docs/start/experiments.md b/content/docs/start/experiments.md index c5ce557aaa..cda149015c 100644 --- a/content/docs/start/experiments.md +++ b/content/docs/start/experiments.md @@ -48,10 +48,15 @@ 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 are meant to be visualizing and compared. -The `-M` flag specifies a metrics file produced by this stage that is not tracked by DVC. In this case, we can version the file using Git and so we choose to ignore it in DVC. -The `--plots-no-cache` flag specifies a plot metrics file produced by this stage, which is not cached by DVC. If you want DVC to track the metrics and the plot metrics file produced, simply use `-m` and `--plots` respectively. - -> With cache: false, DVC skips caching the output as we want "scores.json" to be versioned by Git. +The `-M` flag specifies a metrics file produced by this stage that is not +tracked by DVC. In this case, we can version the file using Git and so we choose +to ignore it in DVC. +The `--plots-no-cache` flag specifies a plot metrics file produced by this +stage, which is not cached by DVC. If you want DVC to track the metrics and the +plot metrics file produced, use `-m` and `--plots` instead respectively. + +> With cache: false, DVC skips caching the output as we want "scores.json" to be +> versioned by Git. From 7382a5d09d118190bd60a9a94805c1dfc3000cfa Mon Sep 17 00:00:00 2001 From: utkarshsingh99 Date: Tue, 30 Jun 2020 15:45:25 +0530 Subject: [PATCH 3/6] restructured, tried to be less repetitive: update experiments.md --- content/docs/start/experiments.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/content/docs/start/experiments.md b/content/docs/start/experiments.md index cda149015c..42433dc793 100644 --- a/content/docs/start/experiments.md +++ b/content/docs/start/experiments.md @@ -25,6 +25,11 @@ $ dvc run -n evaluate \ ### 💡 Expand to see what happens under the hood. +The `-M` flag here specifies a metrics file, while the `--plots-no-cache` flag +specifies a plot metrics file produced by this stage that will not tracked by +DVC. You can choose whether to ignore the files in DVC or cache them. See +[`dvc run`](/doc/command-reference/run#options) for use cases. + DVC generates a new stage in the `dvc.yaml` file: ```yaml @@ -46,17 +51,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 are meant to be visualizing and compared. - -The `-M` flag specifies a metrics file produced by this stage that is not -tracked by DVC. In this case, we can version the file using Git and so we choose -to ignore it in DVC. -The `--plots-no-cache` flag specifies a plot metrics file produced by this -stage, which is not cached by DVC. If you want DVC to track the metrics and the -plot metrics file produced, use `-m` and `--plots` instead respectively. +plots) that are meant to be visualized and compared. -> With cache: false, DVC skips caching the output as we want "scores.json" to be -> versioned by Git. +> With `cache: false`, DVC skips caching the output as we want `scores.json` and +> `prc.json` to be versioned by Git. From 333addf911dcdcf2ae816d031502402f5117a5df Mon Sep 17 00:00:00 2001 From: utkarshsingh99 Date: Thu, 2 Jul 2020 11:20:08 +0530 Subject: [PATCH 4/6] update docs/start/experiments.md --- content/docs/start/experiments.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/content/docs/start/experiments.md b/content/docs/start/experiments.md index 42433dc793..6d298693ee 100644 --- a/content/docs/start/experiments.md +++ b/content/docs/start/experiments.md @@ -25,12 +25,10 @@ $ dvc run -n evaluate \ ### 💡 Expand to see what happens under the hood. -The `-M` flag here specifies a metrics file, while the `--plots-no-cache` flag -specifies a plot metrics file produced by this stage that will not tracked by -DVC. You can choose whether to ignore the files in DVC or cache them. See -[`dvc run`](/doc/command-reference/run#options) for use cases. - -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 +cached by DVC. `dvc run` generates a new stage in the `dvc.yaml` +file: ```yaml evaluate: From 024a158ad6ba013751be186978e7c17fb94610f3 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 3 Jul 2020 13:50:35 -0500 Subject: [PATCH 5/6] Update content/docs/start/experiments.md --- content/docs/start/experiments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/start/experiments.md b/content/docs/start/experiments.md index 6d298693ee..ddc03cd164 100644 --- a/content/docs/start/experiments.md +++ b/content/docs/start/experiments.md @@ -51,7 +51,7 @@ 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 are meant to be visualized and compared. -> With `cache: false`, DVC skips caching the output as we want `scores.json` and +> With `cache: false`, DVC skips caching the output, as we want `scores.json` and > `prc.json` to be versioned by Git. From e0c4316a59000c1bdf8df0af5807930e53f3a6c5 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 3 Jul 2020 13:51:51 -0500 Subject: [PATCH 6/6] Update content/docs/start/experiments.md --- content/docs/start/experiments.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/start/experiments.md b/content/docs/start/experiments.md index ddc03cd164..3e3fec380b 100644 --- a/content/docs/start/experiments.md +++ b/content/docs/start/experiments.md @@ -25,8 +25,8 @@ $ dvc run -n evaluate \ ### 💡 Expand to see what happens under the hood. -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 +The `-M` option here specifies a metrics file, while `--plots-no-cache` +specifies a plots file produced by this stage that will not be cached by DVC. `dvc run` generates a new stage in the `dvc.yaml` file: