From f5d480b35e7833ae8678a1ceb9669ecfa97ea46a Mon Sep 17 00:00:00 2001 From: utkarshsingh99 Date: Thu, 16 Jul 2020 19:25:53 +0530 Subject: [PATCH] dvc-run stage entry added --- content/docs/command-reference/add.md | 8 ++++---- content/docs/user-guide/basic-concepts/dvc-run.md | 9 +++++++++ .../docs/user-guide/what-is-dvc/collaboration-issues.md | 2 +- 3 files changed, 14 insertions(+), 5 deletions(-) create mode 100644 content/docs/user-guide/basic-concepts/dvc-run.md diff --git a/content/docs/command-reference/add.md b/content/docs/command-reference/add.md index 7b923887b8..6c7bc1bb3d 100644 --- a/content/docs/command-reference/add.md +++ b/content/docs/command-reference/add.md @@ -29,8 +29,8 @@ The `targets` are the files or directories to add, which are turned into cache by default (use the `--no-commit` option to avoid this, and `dvc commit` to finish the process when needed). -> See also `dvc run` for more advanced ways to version intermediate and final -> results (like ML models). +> See also dvc run for more advanced ways to version intermediate +> and final results (like ML models). After checking that each `target` file (or directory) hasn't been added before (or tracked with other DVC commands), a few actions are taken under the hood for @@ -209,7 +209,7 @@ outs: This allows us to treat the entire directory structure as a single data artifact. For example, you can pass the whole directory tree as a -dependency to a `dvc run` stage definition: +dependency to a dvc run stage definition: ```dvc $ dvc run -n train \ @@ -247,7 +247,7 @@ pics Note that no top-level `.dvc` file is generated, which is typically less convenient. For example, we cannot use the directory structure as one unit with -`dvc run` or other commands. +dvc run or other commands. ## Example: Dvcignore diff --git a/content/docs/user-guide/basic-concepts/dvc-run.md b/content/docs/user-guide/basic-concepts/dvc-run.md new file mode 100644 index 0000000000..7a25ca925f --- /dev/null +++ b/content/docs/user-guide/basic-concepts/dvc-run.md @@ -0,0 +1,9 @@ +--- +name: 'dvc run' +match: ['dvc run'] +--- + +`dvc run` is a helper for creating or updating +[pipeline](/doc/command-reference/pipeline) stages in a +[`dvc.yaml` file](/doc/user-guide/dvc-files-and-directories#dvcyaml-files) +(located in the current working directory). diff --git a/content/docs/user-guide/what-is-dvc/collaboration-issues.md b/content/docs/user-guide/what-is-dvc/collaboration-issues.md index bac66a65dc..2aff19e0f2 100644 --- a/content/docs/user-guide/what-is-dvc/collaboration-issues.md +++ b/content/docs/user-guide/what-is-dvc/collaboration-issues.md @@ -48,6 +48,6 @@ formalized. Common questions need to be answered in an unified, principled way. sources, intermediate data files, and models? Some of these questions are easy to answer individually. Data scientists, -engineers, or managers may already knows or can easily find answers to some of +engineers, or managers may already know or can easily find answers to some of them. However, the variety of answers and approaches makes data science collaboration a nightmare. **A systematic approach is required.**