From 8b89b8f9f765df2770c155f9d64a34eb89dd25ca Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Tue, 14 Dec 2021 14:37:59 -0700 Subject: [PATCH] ref: re-describe `exp init` + reorder in nav and `exp` help per https://github.com/iterative/dvc.org/pull/3071#pullrequestreview-825977103 --- content/docs/command-reference/exp/index.md | 15 +++++++-------- content/docs/command-reference/exp/init.md | 4 +--- content/docs/sidebar.json | 8 ++++---- 3 files changed, 12 insertions(+), 15 deletions(-) diff --git a/content/docs/command-reference/exp/index.md b/content/docs/command-reference/exp/index.md index 94041977ed..ca88ccbc93 100644 --- a/content/docs/command-reference/exp/index.md +++ b/content/docs/command-reference/exp/index.md @@ -26,20 +26,19 @@ usage: dvc exp [-h] [-q | -v] positional arguments: COMMAND + init Quickly setup any project to use DVC Experiments. + run Reproduce complete or partial experiment pipelines. show Print experiments. - apply Apply the changes from an experiment to your - workspace. diff Show changes between experiments in the DVC repository. - run Reproduce complete or partial experiment pipelines. - gc Garbage collect unneeded experiments. - branch Promote an experiment to a Git branch. list List local and remote experiments. + apply Apply the changes from an experiment to your + workspace. + branch Promote an experiment to a Git branch. + remove Remove local experiments. + gc Garbage collect unneeded experiments. push Push a local experiment to a Git remote. pull Pull an experiment from a Git remote. - remove Remove local experiments. - init Codify a project using DVC metafiles to run - experiments. ``` ## Description diff --git a/content/docs/command-reference/exp/init.md b/content/docs/command-reference/exp/init.md index 9ce2c39ad5..e89e3124d0 100644 --- a/content/docs/command-reference/exp/init.md +++ b/content/docs/command-reference/exp/init.md @@ -1,8 +1,6 @@ # exp init -Codify an existing project using -[DVC metafiles](/doc/user-guide/project-structure) to run -[experiments](/doc/user-guide/experiment-management). +Quickly setup any project to use [DVC Experiments]. > Requires a DVC repository, created with `git init` and > `dvc init`. diff --git a/content/docs/sidebar.json b/content/docs/sidebar.json index 9e90878181..995ed6f3bd 100644 --- a/content/docs/sidebar.json +++ b/content/docs/sidebar.json @@ -270,6 +270,10 @@ "label": "exp diff", "slug": "diff" }, + { + "label": "exp list", + "slug": "list" + }, { "label": "exp apply", "slug": "apply" @@ -293,10 +297,6 @@ { "label": "exp pull", "slug": "pull" - }, - { - "label": "exp list", - "slug": "list" } ] },