Get started tutorial for experiments (with readable diff) (#2195)

* update existing get started sections for 2.0 example repo * add new experiments section * updated references in other sections Co-authored-by: Jorge Orpinel <[email protected]> Co-authored-by: Ivan Shcheklein <[email protected]>
iterative · Feb 27, 2021 · 031b06b · 031b06b
1 parent 877c035
commit 031b06b
Show file tree

Hide file tree

Showing 12 changed files with 468 additions and 186 deletions.
diff --git 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/start/experiments#collecting-metrics), where you can find
-> the actual source code.
+> [Get Started](/doc/start/metrics-parameters-plots#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
@@ -63,8 +63,8 @@ compares them with a previous version.
 ## Examples
 
 > 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.
+> [Get Started](/doc/start/metrics-parameters-plots#collecting-metrics), where
+> you can find the actual source code.
 
 The basic use case shows the values in the current workspace:
 

diff --git a/content/docs/sidebar.json b/content/docs/sidebar.json
@@ -53,10 +53,14 @@
         }
       },
       {
-        "slug": "experiments",
+        "label": "Metrics, Parameters, and Plots",
+        "slug": "metrics-parameters-plots",
         "tutorials": {
           "katacoda": "https://katacoda.com/dvc/courses/get-started"
         }
+      },
+      {
+        "slug": "experiments"
       }
     ]
   },

diff --git a/content/docs/start/data-pipelines.md b/content/docs/start/data-pipelines.md
@@ -84,11 +84,11 @@ The command options used above mean the following:
 - `-n prepare` specifies a name for the stage. If you open the `dvc.yaml` file
   you will see a section named `prepare`.
 
-- `-p prepare.seed,prepare.split` is a special type of dependencies -
+- `-p prepare.seed,prepare.split` defines special types of dependencies -
   [parameters](/doc/command-reference/params). We'll get to them later in the
-  [Experiments](/doc/tutorials/get-started/experiments) section, but the idea is
-  that stage can depend on field values from a parameters file (`params.yaml` by
-  default):
+  [Metrics, parameters, and plots](/doc/start/metrics-parameters-plots) section,
+  but the idea is that the stage can depend on field values from a parameters
+  file (`params.yaml` by default):
 
 ```yaml
 prepare:
@@ -207,7 +207,7 @@ with the same set of options:
 
 ```dvc
 $ dvc run -n train \
-          -p train.seed,train.n_estimators \
+          -p train.seed,train.n_est,train.min_split \
           -d src/train.py -d data/features \
           -o model.pkl \
           python src/train.py data/features model.pkl
@@ -240,7 +240,7 @@ parameters for the training stage:
 $ vim params.yaml
 ```
 
-Change `n_estimators` to `100` and run `dvc repro`, you should see:
+Change `n_est` to `100` and run `dvc repro`, you should see:
 
 ```dvc
 $ dvc repro