Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dvc run tool-tip #1582

Closed
wants to merge 2 commits into from
Closed

dvc run tool-tip #1582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5d480b
dvc-run stage entry added
utkarshsingh99 Jul 16, 2020
d705403
Merge branch 'master' of https://github.com/iterative/dvc.org into pa…
utkarshsingh99 Jul 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/docs/command-reference/add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ The `targets` are the files or directories to add, which are turned into
<abbr>cache</abbr> 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 <abbr>dvc run</abbr> 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
Expand Down Expand Up @@ -203,7 +203,7 @@ outs:

This allows us to treat the entire directory structure as a single <abbr>data
artifact</abbr>. For example, you can pass the whole directory tree as a
<abbr>dependency</abbr> to a `dvc run` stage definition:
<abbr>dependency</abbr> to a <abbr>dvc run<abbr> stage definition:

```dvc
$ dvc run -n train \
Expand Down Expand Up @@ -241,7 +241,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.
<abbr>dvc run</abbr> or other commands.

## Example: Dvcignore

Expand Down
9 changes: 9 additions & 0 deletions content/docs/user-guide/basic-concepts/dvc-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: 'dvc run'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dvc run is not a basic concept nor does it need a glossary entry. All cmd names are already linked automatically to their refs.

Original ticket: glossary: create "stage" entry #1579

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).
2 changes: 1 addition & 1 deletion content/docs/user-guide/what-is-dvc/collaboration-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.**