Skip to content

Commit

Permalink
docs: merge get-started and tutorials into /learn
Browse files Browse the repository at this point in the history
per #1035
  • Loading branch information
jorgeorpinel committed Mar 16, 2020
1 parent d07fb8a commit b1f6a2b
Show file tree
Hide file tree
Showing 57 changed files with 162 additions and 161 deletions.
7 changes: 4 additions & 3 deletions public/static/docs/changelog/0.18.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,10 @@ really excited to share the progress with you:

- Commands startup latency reduced 3x

- 📙 **Documentation got better** - a whole new [Get Started](/doc/get-started)
section, new [Use Cases](/doc/use-cases), [User Guide](/doc/user-guide), and
lot of other great stuff you can find here.
- 📙 **Documentation got better** - a whole ne
[Get Started](/doc/learn/get-started) section, new
[Use Cases](/doc/use-cases), [User Guide](/doc/user-guide), and lot of other
great stuff you can find here.

- 🙂 **Usability improvements** - DVC interface got more informative and easier
to use:
Expand Down
5 changes: 3 additions & 2 deletions public/static/docs/changelog/0.35.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ improvements) we have done in the last few months:
all DVC commands that also have `-a` or `--all-branches` (use all Git
branches).

- 📖 The [Get Started](/doc/get-started/agenda) section has been simplified
(e.g. to use tags instead of branches) and extended. We have also prepared a
- 📖 The [Get Started](/doc/learn/get-started/agenda) section has been
simplified (e.g. to use tags instead of branches) and extended. We have also
prepared a
[DVC project on GitHub](https://github.com/iterative/example-get-started) that
reflects the sequence of chapters in the “get started” section. You can now
download the whole project and reproduce all the models.
Expand Down
4 changes: 2 additions & 2 deletions public/static/docs/command-reference/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,8 @@ $ dvc run -f train.dvc \
python train.py
```

> To follow the full example, see
> [Tutorial: Versioning](/doc/tutorials/versioning).
> To follow the full example, see the [Versioning](/doc/learn/versioning)
> tutorial.
If instead we use the `--recursive` (`-R`) option, the output looks like this:

Expand Down
2 changes: 1 addition & 1 deletion public/static/docs/command-reference/checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ be pulled from remote storage using `dvc pull`.

Let's employ a simple <abbr>workspace</abbr> with some data, code, ML models,
pipeline stages, such as the <abbr>DVC project</abbr> created in our
[Get Started](/doc/get-started) section. Then we can see what happens with
[Get Started](/learn/get-started) section. Then we can see what happens with
`git checkout` and `dvc checkout` as we switch from tag to tag.

<details>
Expand Down
2 changes: 1 addition & 1 deletion public/static/docs/command-reference/commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ reproducibility in those cases.

Let's employ a simple <abbr>workspace</abbr> with some data, code, ML models,
pipeline stages, such as the <abbr>DVC project</abbr> created in our
[Get Started](/doc/get-started) section. Then we can see what happens with
[Get Started](/learn/get-started) section. Then we can see what happens with
`git commit` and `dvc commit` in different situations.

<details>
Expand Down
6 changes: 3 additions & 3 deletions public/static/docs/command-reference/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ for example when `dvc init` was used with the `--no-scm` option.

## Examples

For these examples we can use the [Get Started](/doc/get-started) project.
For these examples we can use the [Get Started](/learn/get-started) project.

<details>

Expand Down Expand Up @@ -103,8 +103,8 @@ $ dvc diff

Let's checkout the
[3-add-file](https://github.com/iterative/example-get-started/releases/tag/3-add-file)
tag, corresponding to the [Add Files](/doc/get-started/add-files) _Get Started_
chapter, right after we added `data.xml` file with DVC:
tag, corresponding to the [Add Files](/learn/get-started/add-files) _Get
Started_ chapter, right after we added `data.xml` file with DVC:

```dvc
$ git checkout 3-add-file
Expand Down
15 changes: 7 additions & 8 deletions public/static/docs/command-reference/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ since files tracked by DVC should already exist in remote storage, but won't be
in the project's <abbr>cache</abbr>. (Refer to `dvc remote` for more information
on DVC remotes.) These necessary data or model files are listed as dependencies
or outputs in a DVC-file (target [stage](/doc/command-reference/run)) so they
are required to [reproduce](/doc/get-started/reproduce) the corresponding
are required to [reproduce](/learn/get-started/reproduce) the corresponding
[pipeline](/doc/command-reference/pipeline). (See
[DVC-File Format](/doc/user-guide/dvc-file-format) for more information on
dependencies and outputs.)

`dvc fetch` ensures that the files needed for a DVC-file to be
[reproduced](/doc/get-started/reproduce) exist in cache. If no `targets` are
[reproduced](/learn/get-started/reproduce) exist in cache. If no `targets` are
specified, the set of data files to fetch is determined by analyzing all
DVC-files in the current branch, unless `--all-branches` or `--all-tags` is
specified.
Expand All @@ -63,7 +63,7 @@ option is used.
`dvc fetch`, `dvc pull`, and `dvc push` are related in that these 3 commands
perform data synchronization among local and remote storage. The specific way in
which the set of files to push/fetch/pull is determined begins with calculating
file hashes when these are [added](/doc/get-started/add-files) with DVC. File
file hashes when these are [added](/learn/get-started/add-files) with DVC. File
hashes are stored in the corresponding DVC-files (typically versioned with Git).
Only the hashes specified in DVC-files currently in the workspace are considered
by `dvc fetch` (unless the `-a` or `-T` options are used).
Expand Down Expand Up @@ -93,8 +93,8 @@ by `dvc fetch` (unless the `-a` or `-T` options are used).
- `-a`, `--all-branches` - fetch cache for all Git branches instead of just the
current workspace. This means DVC may download files needed to reproduce
different versions of a DVC-file
([experiments](/doc/get-started/experiments)), not just the ones currently in
the workspace.
([experiments](/learn/get-started/experiments)), not just the ones currently
in the workspace.

- `-T`, `--all-tags` - fetch cache for all Git tags. Similar to `-a` above. Note
that both options can be combined, for example using the `-aT` flag.
Expand All @@ -110,7 +110,7 @@ by `dvc fetch` (unless the `-a` or `-T` options are used).

Let's employ a simple <abbr>workspace</abbr> with some data, code, ML models,
pipeline stages, such as the <abbr>DVC project</abbr> created in our
[Get Started](/doc/get-started) section. Then we can see what happens with
[Get Started](/learn/get-started) section. Then we can see what happens with
`dvc fetch` as we switch from tag to tag.

<details>
Expand All @@ -126,8 +126,7 @@ $ cd example-get-started

</details>

The workspace looks almost like in this
[pipeline setup](/doc/tutorials/pipelines):
The workspace looks almost like in this [pipeline setup](/doc/learn/pipelines):

```dvc
.
Expand Down
4 changes: 2 additions & 2 deletions public/static/docs/command-reference/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ https://remote.dvc.org/get-started/66/2eb7f64216d9c2c1088d0a5e2c6951
location to place the artifact within the workspace. Combining these two options
allows us to do something we can't achieve with the regular `git checkout` +
`dvc checkout` process – see for example the
[Get Older Data Version](/doc/get-started/older-versions) chapter of our _Get
[Get Older Data Version](/learn/get-started/older-versions) chapter of our _Get
Started_.

Let's use the
Expand All @@ -161,7 +161,7 @@ $ git clone https://github.com/iterative/example-get-started
$ cd example-get-started
```

If you are familiar with our [Get Started](/doc/get-started) project (used in
If you are familiar with our [Get Started](/learn/get-started) project (used in
these examples), you may remember that the chapter where we train a first
version of the model corresponds to the the `baseline-experiment` tag in the
repo. Similarly `bigrams-experiment` points to an improved model (trained using
Expand Down
16 changes: 8 additions & 8 deletions public/static/docs/command-reference/import-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ up to date from the external data source.
## Examples

To illustrate these examples we will be using the <abbr>project</abbr> explained
in the [Get Started](/doc/get-started) section.
in the [Get Started](/doc/learn/get-started) section.

<details>

Expand All @@ -132,8 +132,8 @@ in the [Get Started](/doc/get-started) section.
Start by cloning our example repo if you don't already have it. Then move into
the repo and checkout the
[2-remote](https://github.com/iterative/example-get-started/releases/tag/2-remote)
tag, corresponding to the [Configure](/doc/get-started/configure) _Get Started_
chapter:
tag, corresponding to the [Configure](/doc/learn/get-started/configure) _Get
Started_ chapter:

```dvc
$ git clone https://github.com/iterative/example-get-started
Expand All @@ -143,14 +143,14 @@ $ mkdir data
```

You should now have a blank workspace, just before the
[Add Files](/doc/get-started/add-files) chapter.
[Add Files](/doc/learn/get-started/add-files) chapter.

</details>

## Example: Tracking a remote file

An advanced alternate to [Add Files](/doc/get-started/add-files) chapter of the
_Get Started_ section is to use `dvc import-url`:
An advanced alternate to [Add Files](/doc/learn/get-started/add-files) chapter
of the _Get Started_ section is to use `dvc import-url`:

```dvc
$ dvc import-url https://data.dvc.org/get-started/data.xml \
Expand Down Expand Up @@ -196,7 +196,7 @@ regenerating a <abbr>data artifact</abbr> based on the updated data source.
[Pipeline](/doc/command-reference/pipeline) reproduction can be triggered based
on a changed external dependency.

Let's use the [Get Started](/doc/get-started) project again, simulating an
Let's use the [Get Started](/doc/learn/get-started) project again, simulating an
updated external data source. (Remember to prepare the <abbr>workspace</abbr>,
as explained in [Examples](#examples))

Expand Down Expand Up @@ -243,7 +243,7 @@ And instead of an `etag` we have an `md5` hash value. We did this so its easy to
edit the data file.

Let's now manually reproduce a
[processing chapter](/doc/get-started/connect-code-and-data) from the _Get
[processing chapter](/doc/learn/get-started/connect-code-and-data) from the _Get
Started_ project. Download the example source code archive and unzip it:

```dvc
Expand Down
4 changes: 2 additions & 2 deletions public/static/docs/command-reference/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ and data `path` fields, and the `outs` section contains the corresponding local
workspace `path` field. This is enough data about the imported data, to enable
DVC efficiently determining whether the local copy is out of date.

To actually [track the data](https://dvc.org/doc/get-started/add-files),
To actually [track the data](https://dvc.org/doc/learn/get-started/add-files),
`git add` (and `git commit`) the import stage.

Note that import stages are considered always locked, meaning that if you run
Expand Down Expand Up @@ -187,7 +187,7 @@ $ dvc get https://github.com/iterative/dataset-registry \
tutorial/ver/data.zip
```

> Used in our [versioning tutorial](/doc/tutorials/versioning)
> Used in our [versioning tutorial](/doc/learn/versioning)
Or

Expand Down
2 changes: 1 addition & 1 deletion public/static/docs/command-reference/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ To disable them, you need to **remove** or **edit** those files (i.e.

Let's employ a simple <abbr>workspace</abbr> with some data, code, ML models,
pipeline stages, such as the <abbr>DVC project</abbr> created in our
[Get Started](/doc/get-started) section. Then we can see what happens with
[Get Started](/doc/learn/get-started) section. Then we can see what happens with
`dvc install` in different situations.

<details>
Expand Down
2 changes: 1 addition & 1 deletion public/static/docs/command-reference/metrics/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ They're calculated between two commits (hash, branch, tag, or any

Let's employ a simple <abbr>workspace</abbr> with some data, code, ML models,
pipeline stages, such as the <abbr>DVC project</abbr> created in our
[Get Started](/doc/get-started) section. Then we can see what happens with
[Get Started](/doc/learn/get-started) section. Then we can see what happens with
`dvc install` in different situations.

<details>
Expand Down
6 changes: 3 additions & 3 deletions public/static/docs/command-reference/metrics/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,6 @@ Examples in [add](/doc/command-reference/metrics/add),
[remove](/doc/command-reference/metrics/remove) cover most of the basic cases
for the `dvc metrics show`.

The [Compare Experiments](/doc/get-started/compare-experiments) chapter of our
_Get Started_ section covers the `-a` option to collect and print a metric file
value across all Git branches.
The [Compare Experiments](/doc/learn/get-started/compare-experiments) chapter of
our _Get Started_ section covers the `-a` option to collect and print a metric
file value across all Git branches.
2 changes: 1 addition & 1 deletion public/static/docs/command-reference/pipeline/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pipeline

A set of commands to manage [pipelines](/doc/get-started/pipeline):
A set of commands to manage [pipelines](/doc/learn/get-started/pipeline):
[show](/doc/command-reference/pipeline/show) and
[list](/doc/command-reference/pipeline/list).

Expand Down
2 changes: 1 addition & 1 deletion public/static/docs/command-reference/repro.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ and only execute the final stage.

For simplicity, let's build a pipeline defined below. (If you want get your
hands-on something more real, see this shot
[pipeline tutorial](/doc/tutorials/pipelines)). It takes this `text.txt` file:
[pipeline tutorial](/doc/learn/pipelines)). It takes this `text.txt` file:

```
dvc
Expand Down
2 changes: 1 addition & 1 deletion public/static/docs/command-reference/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Note that `dvc repro` provides an interface to check state and reproduce this
graph (pipeline) later. This concept is similar to the one of the
[Make](https://www.gnu.org/software/make/) in software build automation, but DVC
captures data and <abbr>caches</abbr> relevant <abbr>data artifacts</abbr> along
the way. See [this tutorial](/doc/tutorials/pipelines) to learn more and try
the way. See [this tutorial](/doc/learn/pipelines) to learn more and try
creating a pipeline.

### Avoiding unexpected behavior
Expand Down
13 changes: 0 additions & 13 deletions public/static/docs/get-started/index.md

This file was deleted.

File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ can be done using the CLI as shown below.
> have write access to it, so in order to follow the tutorial you will need to
> either create your own S3 bucket or use other types of
> [remote storage](/doc/command-reference/remote). E.g. you can set up a local
> remote as we did in the [Configure](/doc/get-started/configure) chapter of
> _Get Started_.
> remote as we did in the [Configure](/doc/learn/get-started/configure) chapter
> of _Get Started_.
```dvc
$ dvc remote add -d upstream s3://dvc-public/remote/tutorial/nlp
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Agenda

You'll need [Git](https://git-scm.com) to run the commands in this guide. Also,
if DVC is not installed, please follow these [instructions](/doc/install) to do
so.

In the next few sections we'll build a simple natural language processing (NLP)
project from scratch. If you'd like to get the final result or have any issues
along the way, you can download the fully reproducible
Expand All @@ -13,10 +17,9 @@ Otherwise, bear with us and we'll introduce some basic DVC concepts to get the
same results together!

The idea for this project is a simplified version of our
[Deep Dive Tutorial](/doc/tutorials/deep). It explores the NLP problem of
predicting tags for a given StackOverflow question. For example, we might want a
classifier that can classify (or predict) posts about Python by tagging them
with `python`.
[Deep Dive Tutorial](/doc/learn/deep). It explores the NLP problem of predicting
tags for a given StackOverflow question. For example, we might want a classifier
that can classify (or predict) posts about Python by tagging them with `python`.

![](/static/img/example-flow-2x.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ $ dvc repro evaluate.dvc

`git checkout master` and `dvc checkout` commands ensure that we have the latest
experiment code and data respectively. And `dvc repro`, as we discussed in the
[Reproduce](/doc/get-started/reproduce) chapter, is a way to run all the
[Reproduce](/doc/learn/get-started/reproduce) chapter, is a way to run all the
necessary commands to build the model and measure its performance.

```dvc
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ $ git commit -m "Add source code files to repo"

Having installed the `src/prepare.py` script in your repo, the following command
transforms it into a reproducible [stage](/doc/command-reference/run) for the ML
pipeline we're building (described in the
[next chapter](/doc/tutorials/pipelines)).
pipeline we're building (described in the [next chapter](/doc/learn/pipelines)).

```dvc
$ dvc run -f prepare.dvc \
Expand All @@ -74,8 +73,8 @@ $ dvc run -f prepare.dvc \

`dvc run` generates the `prepare.dvc` DVC-file. It has the same
[format](/doc/user-guide/dvc-file-format) as the file we created in the
[previous section](/doc/get-started/add-files) to track `data.xml`, except in
this case it has additional information about the `data/prepared` output (a
[previous section](/doc/learn/get-started/add-files) to track `data.xml`, except
in this case it has additional information about the `data/prepared` output (a
directory where two files, `train.tsv` and `test.tsv`, will be written to), and
about the Python command that is required to build it.

Expand Down Expand Up @@ -121,8 +120,9 @@ wdir: .
```

> `dvc run` is just the first of a set of DVC command required to generate a
> [pipeline](/doc/get-started/pipeline), or in other words, instructions on how
> to build a ML model (data file) from previous data files (or directories).
> [pipeline](/doc/learn/get-started/pipeline), or in other words, instructions
> on how to build a ML model (data file) from previous data files (or
> directories).
Let's briefly mention what the command options used above mean for this
particular example:
Expand Down
Loading

0 comments on commit b1f6a2b

Please sign in to comment.