Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

start: reader instructions (in index pages) #4000

Merged
merged 14 commits into from
Dec 21, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 55 additions & 16 deletions content/docs/start/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,24 @@ running `dvc init` inside a Git project:

<details>

### ⚙️ Expand to prepare the project.
### ⚙️ Expand to prepare a project.

We'll be building an NLP project from scratch together. The end result is
published on [GitHub](https://github.com/iterative/example-get-started) -- feel
free to clone the repo.

Let's start with `git init`:
Imagine we want to building an ML project from scratch. Let's start by creating
a Git repository:

```cli
$ mkdir example-get-started
$ cd example-get-started
$ git init
```

<admon type="info">

This directory name is actually used in our
[example-get-started](https://github.com/iterative/example-get-started) repo.

</admon>

</details>

```cli
Expand All @@ -46,8 +50,8 @@ $ git commit -m "Initialize DVC"

Now you're ready to DVC!

DVC's multiple feature sets are best understood from different angles. Pick a
trail below to see an overview of all features from that perspective:
The value of DVC's many feature sets is best understood from different angles.
Pick a trail below to see an overview of all features from that perspective:

### Data Management

Expand All @@ -56,10 +60,10 @@ trail below to see an overview of all features from that perspective:
without storing large files in the repo. Data is cached by DVC, allowing for
efficient sharing. Think "Git for data".

- **[Data and model access]** shows how to bring, explore, and access data
artifacts from outside the project. This can help download a specific version
of an ML model to a deployment server or import a dataset into another
project, for example.
- **[Data and model access]** goes over using data artifacts from outside of the
project and importing them from another DVC project. This can help to download
a specific version of an ML model to a deployment server or import a dataset
into another project.

- **[Data pipelines]** describe how models and other data artifacts are built,
and provide an efficient way to reproduce them. Think "Makefiles for data and
Expand All @@ -74,15 +78,50 @@ trail below to see an overview of all features from that perspective:
[metrics, parameters, and plots]:
/doc/start/data-management/metrics-parameters-plots

<admon type="tip">

The steps and results of some of these chapters are captured in our
[example-get-started] repo. Feel free to `git clone/checkout` any of its [tags].

[example-get-started]: https://github.com/iterative/example-get-started
[tags]: https://github.com/iterative/example-get-started/tags

</admon>

### Experiment Management

- **[Experiments]** enable exploration, iteration, and comparison across many ML
experiments. Track your experiments with automatic versioning and checkpoint
logging. Compare differences in parameters, metrics, code, and data. Apply,
drop, roll back, resume, or share any experiment.
- **[Experiments]** enable exploration, iteration, and comparison across many
trials in ML projects. Track your experiments with automatic versioning and
checkpoint logging. Compare differences in parameters, metrics, code, and
data. Apply, drop, roll back, resume, or share any experiment.

- **[Visualization]** helps you compare experiment results visually, track your
plots, and generate them with library integrations.

[experiments]: /doc/start/experiment-management/experiments
[visualization]: /doc/start/experiment-management/visualization

<admon type="tip">

These are captured in our [example-dvc-experiments] repo (see its [tags]).

[example-dvc-experiments]: https://github.com/iterative/example-dvc-experiments
[tags]: https://github.com/iterative/example-dvc-experiments/tags

</admon>

## Following the Get Started

Each page in the trails above is more or less independent, especially if you're
only reading them to get a general idea of the features in question. For better
learning, try each step yourself from the beginning of any trail. Some of the
preparation steps may be inside collapsed sections you can click on to expand:

<details>

### Click for an example!

Click the header again to collapse this message. Or move on by picking a page
from the list above, left-side navigation, or just click `NEXT` below!

</details>