diff --git a/content/authors/dmitry_petrov.md b/content/authors/dmitry_petrov.md index 9eaaf341e1..96b3c100db 100644 --- a/content/authors/dmitry_petrov.md +++ b/content/authors/dmitry_petrov.md @@ -5,5 +5,5 @@ link: https://twitter.com/fullstackml --- Creator of [http://dvc.org](http://dvc.org) — Git for ML. Ex-Data Scientist -[http://twitter.com/Microsoft](@Microsoft). PhD in CS. Making jokes with a +[@Microsoft](http://twitter.com/Microsoft). PhD in CS. Making jokes with a serious face. diff --git a/content/authors/jorge_orpinel.md b/content/authors/jorge_orpinel.md index 11d223a1fd..bbe25f494a 100644 --- a/content/authors/jorge_orpinel.md +++ b/content/authors/jorge_orpinel.md @@ -4,4 +4,4 @@ avatar: jorge.jpg link: https://www.linkedin.com/in/jorgeorpinel --- -Technical writer and developer at [http://dvc.org](http://dvc.org) +Technical writer and developer at [dvc.org](http://dvc.org/) diff --git a/content/docs/command-reference/run.md b/content/docs/command-reference/run.md index 01802fadb5..24b93d71d7 100644 --- a/content/docs/command-reference/run.md +++ b/content/docs/command-reference/run.md @@ -150,12 +150,13 @@ data pipeline (e.g. random numbers, time functions, hardware dependency, etc.) executing the `command`. - `--no-exec` - create a stage file, but do not execute the `command` defined in - it, nor track dependencies or outputs with DVC. In the DVC-file contents, the - file hash values will be empty; They will be populated the next time this - stage is actually executed. DVC will also add your outputs to `.gitignore`, - same as it would do without `--no-exec`. This is useful if, for example, you - need to build a pipeline (dependency graph) first, and then run it all at - once. + it, nor cache dependencies or outputs (like with `--no-commit`, explained + below). DVC will also add your outputs to `.gitignore`, same as it would do + without `--no-exec`. Use `dvc commit` to force committing existing output file + versions to cache. + + This is useful if, for example, you need to build a pipeline quickly first, + and run it all at once later. - `--overwrite-dvcfile` - overwrite an existing DVC-file (with file name determined by the logic described in the `-f` option) without asking for @@ -167,10 +168,13 @@ data pipeline (e.g. random numbers, time functions, hardware dependency, etc.) from the same list of inputs). - `--no-commit` - do not save outputs to cache. A DVC-file is created and an - entry is added to `.dvc/state`, while nothing is added to the cache. - (`dvc status` will report that the file is `not in cache`.) Use `dvc commit` - when ready to commit outputs with DVC. Useful to avoid caching unnecessary - data repeatedly when running multiple experiments. + entry is added to `.dvc/state`, while nothing is added to the cache. In the + stage file, the file hash values will be empty; They will be populated the + next time this stage is actually executed, or `dvc commit` can be used to + force committing existing output file versions to cache. + + This is useful to avoid caching unnecessary data repeatedly when running + multiple experiments. - `--always-changed` - always consider this DVC-file as changed. As a result `dvc status` will report it as `always changed` and `dvc repro` will always diff --git a/content/docs/user-guide/basic-concepts/dvc-project.md b/content/docs/user-guide/basic-concepts/dvc-project.md new file mode 100644 index 0000000000..486e994379 --- /dev/null +++ b/content/docs/user-guide/basic-concepts/dvc-project.md @@ -0,0 +1,20 @@ +--- +name: 'DVC Project' +match: + [ + 'DVC project', + 'DVC projects', + project, + projects, + 'DVC repository', + 'DVC repositories', + repository, + repositories, + ] +--- + +Initialized by running `dvc init` in the **workspace** (typically in a Git +repository). It will contain the +[`.dvc/` directory](/doc/user-guide/dvc-files-and-directories) and +[DVC-files](/doc/user-guide/dvc-file-format) created with commands such as +`dvc add` or `dvc run`.