Skip to content

Commit

Permalink
Misc. updates (#2086)
Browse files Browse the repository at this point in the history
* 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 iterative/dvc#5025 (comment)
  • Loading branch information
jorgeorpinel authored Jan 9, 2021
1 parent 275a3ec commit 9966974
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 22 deletions.
4 changes: 3 additions & 1 deletion content/docs/cml/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion content/docs/command-reference/dag.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions content/docs/install/completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions content/docs/user-guide/dvc-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
29 changes: 14 additions & 15 deletions content/docs/user-guide/running-dvc-on-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 9966974

Please sign in to comment.