Skip to content

Commit

Permalink
tutorials: std note on Git, DVC installation + Windows tips
Browse files Browse the repository at this point in the history
related to #214 (comment)
  • Loading branch information
jorgeorpinel committed Oct 31, 2019
1 parent 0fc9201 commit b7ad28f
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 19 deletions.
26 changes: 11 additions & 15 deletions static/docs/tutorials/deep/preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ data will be used — only 180Mb xml files.
Most of the code to solve this problem is ready to be downloaded. We will be
modifying some of the code during this tutorial to improve the model.

> We have tested our tutorials and examples with Python 3. We don't recommend
> using earlier versions.
You'll need [Git](https://git-scm.com) to run the commands in this tutorial.
Also, if DVC is not installed, please follow these [instructions](/doc/install)
to do so.

> If you're using Windows, please review
> [Running DVC on Windows](/doc/user-guide/running-dvc-on-windows) for important
> tips to improve your experience.
## Getting the example code

Take the following steps to initialize a new Git repository and get the example
Expand All @@ -22,10 +33,6 @@ browser to download `code.zip`. (Right-click
[this link](https://code.dvc.org/tutorial/nlp/code.zip) and select
`Save Link As...` (Chrome). Save it into the project directory.

> Please also review
> [Running DVC on Windows](/doc/user-guide/running-dvc-on-windows) for important
> tips to improve your experience using DVC on Windows.
</details>

```dvc
Expand All @@ -49,17 +56,6 @@ $ echo ".env/" >> .gitignore
$ pip install -r code/requirements.txt
```

## Install DVC

You'll need DVC on your system to continue this tutorial. Please refer to
[Installation](/doc/install) for the easiest way to install DVC on your system.
For this tutorial, installing DVC with [pip](https://pip.pypa.io/) is probably
the easiest:

```dvc
$ pip install dvc
```

## Initialize

DVC works on top of Git repositories. You run DVC initialization in a repository
Expand Down
8 changes: 6 additions & 2 deletions static/docs/tutorials/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,12 @@ and reproducible way.

## Preparation

If DVC is not installed, please follow these [instructions](/doc/install) to do
so.
> We have tested our tutorials and examples with Python 3. We don't recommend
> using earlier versions.
You'll need [Git](https://git-scm.com) to run the commands in this tutorial.
Also, if DVC is not installed, please follow these [instructions](/doc/install)
to do so.

> If you're using Windows, please review
> [Running DVC on Windows](/doc/user-guide/running-dvc-on-windows) for important
Expand Down
8 changes: 6 additions & 2 deletions static/docs/tutorials/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,12 @@ model file.

## Preparation

If DVC is not installed, please follow these [instructions](/doc/install) to do
so.
> We have tested our tutorials and examples with Python 3. We don't recommend
> using earlier versions.
You'll need [Git](https://git-scm.com) to run the commands in this tutorial.
Also, if DVC is not installed, please follow these [instructions](/doc/install)
to do so.

> If you're using Windows, please review
> [Running DVC on Windows](/doc/user-guide/running-dvc-on-windows) for important
Expand Down

0 comments on commit b7ad28f

Please sign in to comment.