From 99669746bddae9c825eee20c8fdc129e875799bf Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 8 Jan 2021 22:02:00 -0600 Subject: [PATCH] Misc. updates (#2086) * cml: copy edit rel #2065 * dag: copy edit rel #2063 * install: update autocomplete sample per iterative/dvc/issues/5149 * guide: rec WSL2 for Win * giude: mention that desc can go in metrics and plots (outs) per https://github.com/iterative/dvc/issues/5025#issuecomment-752301692 --- content/docs/cml/index.md | 4 ++- content/docs/command-reference/dag.md | 4 ++- content/docs/install/completion.md | 6 ++-- content/docs/user-guide/dvc-files.md | 4 +-- .../docs/user-guide/running-dvc-on-windows.md | 29 +++++++++---------- 5 files changed, 25 insertions(+), 22 deletions(-) diff --git a/content/docs/cml/index.md b/content/docs/cml/index.md index 7d57a4ab62..cab771a6c9 100644 --- a/content/docs/cml/index.md +++ b/content/docs/cml/index.md @@ -4,7 +4,9 @@ for implementing continuous integration & delivery (CI/CD) in machine learning projects. Use it to automate parts of your development workflow, including model training and evaluation, comparing ML experiments across your project history, -and monitoring changing datasets. Website of the project https://cml.dev +and monitoring changing datasets. + +Project website: https://cml.dev ![](/img/cml_neural_transfer.png) _On every pull request, CML helps you automatically train and evaluate models, then generates a visual report with diff --git a/content/docs/command-reference/dag.md b/content/docs/command-reference/dag.md index 035dbd6bc3..f4e1af6829 100644 --- a/content/docs/command-reference/dag.md +++ b/content/docs/command-reference/dag.md @@ -111,7 +111,9 @@ $ dvc dag +----------+ ``` -Otherwise, it's also possible to visualize the outputs produced by the stages: +The pipeline can also be seen from the point of view of how stage +outputs/dependencies are connected (using the `--outs` option). Notice that the +resulting graph may be different: ```dvc $ dvc dag --outs diff --git a/content/docs/install/completion.md b/content/docs/install/completion.md index 61d00be6eb..0d68d27440 100644 --- a/content/docs/install/completion.md +++ b/content/docs/install/completion.md @@ -19,10 +19,10 @@ For example: $ dvc r # Press [tab] key Completing dvc commands remote -- Set up and manage data remotes. -remove -- Remove stage entry and unprotect outputs -repro -- Reproduce complete or partial pipelines by executing their stages +remove -- Remove stages or .dvc files, unprotect their outputs, ... +repro -- Reproduce complete or partial pipelines by executing ... root -- Return the relative path to the root of the DVC project. -run -- Generate a stage file from a command and execute the command. +run -- Generate a stage file from a command and execute the command ``` Depending on what you typed on the command line so far, it completes: diff --git a/content/docs/user-guide/dvc-files.md b/content/docs/user-guide/dvc-files.md index 305255f07c..df354caf4c 100644 --- a/content/docs/user-guide/dvc-files.md +++ b/content/docs/user-guide/dvc-files.md @@ -88,8 +88,8 @@ and `dvc commit` commands, but not when a `.dvc` file is overwritten by - `persist`: Whether the output file/dir should remain in place while `dvc repro` runs (`false` by default: outputs are deleted when `dvc repro` starts -- `desc` (optional): User description for this output. This doesn't affect any - DVC operations. +- `desc` (optional): User description for this output (supported in metrics and + plots too). This doesn't affect any DVC operations. ### Dependency entries diff --git a/content/docs/user-guide/running-dvc-on-windows.md b/content/docs/user-guide/running-dvc-on-windows.md index 621cd7ba56..de31c17947 100644 --- a/content/docs/user-guide/running-dvc-on-windows.md +++ b/content/docs/user-guide/running-dvc-on-windows.md @@ -11,22 +11,21 @@ The regular Command Prompt (`cmd`) in Windows will most likely not help you use DVC effectively, or follow the examples in our docs. Please avoid it. There's no perfect solution, but here are some ideas: -- The full [Cmder](https://cmder.net/) console emulator combines several useful - tools like [ConEmu](https://conemu.github.io/), and - [Git for Windows](https://gitforwindows.org/) (Git Bash) among other - [shell options](https://github.com/cmderdev/cmder/blob/master/README.md#access-to-multiple-shells-in-one-window-using-tabs). +- [WSL 2](https://docs.microsoft.com/en-us/windows/wsl/install-win10) with + [Windows Terminal](https://devblogs.microsoft.com/commandline/) supports the + most CLI features (e.g. `\` line continuation). It has + [good performance](https://itigic.com/wsl-vs-wsl2-performance-in-windows-10-update/) + (and can even + [access GPUs](https://channel9.msdn.com/Shows/Tabs-vs-Spaces/GPU-Accelerated-Machine-Learning-with-WSL-2)). +- The full [Cmder](https://cmder.net/) console emulator is another good option. + It combines several useful tools like [ConEmu](https://conemu.github.io/) + terminal and [Git for Windows](https://gitforwindows.org/) (Git Bash), among + [other shells](https://github.com/cmderdev/cmder/blob/master/README.md#features). - [Anaconda Prompt](https://docs.anaconda.com/anaconda/user-guide/getting-started/#open-prompt-win) - is another recommendation. -- Consider enabling and using - [WSL](https://blogs.windows.com/windowsdeveloper/2016/03/30/run-bash-on-ubuntu-on-windows/) - ([Windows Terminal](https://devblogs.microsoft.com/commandline/) also - recommended) which supports the most CLI features (e.g. `\` line - continuation). But it has major - [I/O performance issues](https://www.phoronix.com/scan.php?page=article&item=windows10-okt-wsl&num=2) - and is [unable to access GPUs](https://github.com/Microsoft/WSL/issues/829), - among other limitations. -- Install an actual Linux distro (e.g. Ubuntu) on a virtual machine, or in a HD - partition (dual boot). + is also popular. +- Install an actual Linux distro (e.g. Ubuntu) on a + [virtual machine](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/), + or in an HD partition (dual boot). ## Enable symbolic links