Skip to content

Commit

Permalink
3 by 3
Browse files Browse the repository at this point in the history
  • Loading branch information
omesser committed Apr 10, 2023
1 parent f9dd1ad commit 67ecd14
Show file tree
Hide file tree
Showing 29 changed files with 173 additions and 166 deletions.
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Note that `git stash apply` my fail if you run Git commands which affect `HEAD`
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiments
[our get started]: /doc/start/experiments/

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ version.
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiments
[our get started]: /doc/start/experiments/

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ all the current experiments (without comparisons).
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiments
[our get started]: /doc/start/experiments/

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ separately to delete it.
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiments
[our get started]: /doc/start/experiments/

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ options below).
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiments
[our get started]: /doc/start/experiments/

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ pushed experiment.
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiments
[our get started]: /doc/start/experiments/

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ with the experiments to [remote storage], unless `--no-cache` is used.
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiments
[our get started]: /doc/start/experiments/

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ committing them to the Git repo. Unnecessary ones can be [cleared] with
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiments
[our get started]: /doc/start/experiments/

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/save.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ committing them to the Git repo. Unnecessary ones can be [cleared] with
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiments
[our get started]: /doc/start/experiments/

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ $ dvc exp show ...
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiments
[our get started]: /doc/start/experiments/

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/contributing/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ that is installed when `yarn` runs (see [dev env](#development-environment)).
- `dvc` can be used to show examples of commands and their output in a
terminal session.
- `dvctable` is used for creating colored, bold, or italic table cells. (You
can see an [example](/doc/start/experiments) of `dvctable` in our "Get
can see an [example](/doc/start/experiments/) of `dvctable` in our "Get
Started" section.)
- `yaml` is used to show samples of <abbr>DVC files</abbr>, or other YAML
contents.
Expand Down
12 changes: 6 additions & 6 deletions content/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
"source": false,
"children": [
"data-versioning",
"discovering-and-accessing-data",
"data-pipelines",
{
"label": "Metrics, Parameters, and Plots",
Expand All @@ -53,13 +52,13 @@
]
},
{
"slug": "experiment-management",
"label": "Experiment Management",
"slug": "experiments",
"source": false,
"children": [
"experiment-versioning",
"experiment-management",
"building-pipelines",
"experiment-iterations"
"experiment-live-tracking",
"experiment-pipelines",
"experiment-collaboration"
]
}
]
Expand Down Expand Up @@ -190,6 +189,7 @@
"source": false,
"children": [
"run-dvc-on-windows",
"discovering-and-accessing-data",
"stop-tracking-data",
"update-tracked-data",
"add-deps-or-outs-to-a-stage",
Expand Down
12 changes: 12 additions & 0 deletions content/docs/start/data-management/data-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,18 @@ layer. DVC in turn manipulates `.dvc` files, whose contents define the data file
versions. DVC also synchronizes DVC-tracked data in the <abbr>workspace</abbr>
efficiently to match them.

## Discovering and accessing data

DVC helps you with accessing and using your data artifacts from outside of the
project where they are versioned, and your tracked data can be imported and
fetched from anywhere. For example, you may want to download a specific version
of an ML model to a deployment server or import a dataset into another project.
To learn about how DVC allows you to do this, see the [discovering and accessing
data] how-to guide.

[discovering and accessing data]:
/doc/user-guide/how-to/discovering-and-accessing-data

## Large datasets versioning

In cases where you process very large datasets, you need an efficient mechanism
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ DVC makes it easy to track [metrics](/doc/command-reference/metrics), update
All of the above can be combined into [experiments] to run and compare many
iterations of your ML project.

[experiments]: /doc/start/experiments
[experiments]: /doc/start/experiments/

</admon>

Expand Down Expand Up @@ -84,7 +84,7 @@ files to be versioned by Git.
</details>

[`evaluate.py`] writes the model's [ROC-AUC] and [average precision] to
`eval/live/metrics.json` (previously marked as a [metrics file] with `-M`):
`eval/live/metrics.json` (designated a [metrics file] with `-M` above):

```json
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
---
title: 'Get Started: Experiment Management'
title: 'Get Started: Experiment Collaboration'
description:
'Manage your experiments and share them with others using software engineering
best practices.'
'Share your experiments with others, persist and apply your changes using Git
branches and software engineering best practices.'
---

# Get Started: Experiment Management
# Get Started: Experiment Collaboration

After having compared all the experiments, you still need to agree on which one
is the best and manage the remaining candidates. <abbr>DVC Experiments</abbr>
are fully compatible with Git workflows, so you can manage the experiments using
software engineering best practices.
After having compared some experiments' results and parameters, you still need
to agree on which one is the best, share it, persist it into Gi, and do some
house keeping on the rejected experiments.

<abbr>DVC Experiments</abbr> are fully compatible with Git workflows. You can
share, manage and collaborate on experiments and related code changes using
software engineering best practices. There is no need for a different system or
paradigm to track and version experiments.

## Sharing

Expand All @@ -19,7 +23,7 @@ Unless you have enabled
the <abbr>DVC experiments</abbr> only exist in your repo and people can't manage
or view them from other machines.

You can share an experiment with others from your machine:
To share an experiment with others from your machine:

<toggle>

Expand Down
89 changes: 0 additions & 89 deletions content/docs/start/experiments/experiment-iterations.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: 'Get Started: Experiment Versioning'
title: 'Get Started: Experiment Live Tracking'
description:
'Track the changes to the code, data, metrics, parameters and plots associated
with each experiment, without bloating your Git repo.'
---

# Get Started: Experiment Versioning
# Get Started: Experiment Live Tracking

Tools like [Jupyter Notebooks](https://jupyter.org/) are useful for rapid
prototyping, but it's hard to keep track of changes and reproduce experiments.
Expand Down
Loading

0 comments on commit 67ecd14

Please sign in to comment.