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

exp: Drop checkpoints. #4442

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
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
132 changes: 0 additions & 132 deletions content/docs/api-reference/make_checkpoint.md

This file was deleted.

4 changes: 0 additions & 4 deletions content/docs/command-reference/exp/apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@ contents of `experiment`, plus any files from the workspace prior to
This is typically used after choosing a target `experiment` with `dvc exp show`
or `dvc exp diff`, and before committing it to Git (making it [persistent]).

> Note that any [checkpoints] found in the `experiment` will **not** be
> preserved when applying and committing it. Use `dvc exp branch` instead.

<admon type="warn">

Conflicting changes in the workspace are overwritten, but the result of
Expand Down Expand Up @@ -60,7 +57,6 @@ Note that `git stash apply` my fail if you run Git commands which affect `HEAD`
</details>

[persistent]: /doc/user-guide/experiment-management/persisting-experiments
[checkpoints]: /doc/user-guide/experiment-management/checkpoints

## Options

Expand Down
4 changes: 0 additions & 4 deletions content/docs/command-reference/exp/branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ positional arguments:
Creates a new [Git branch] containing the target `experiment` from the
experiment's baseline (`HEAD` at the time the experiment was run).

This turns the experiment into one or more [regular commits] (one per checkpoint
in the case of [checkpoint experiments]).

If you don't provide a `branch` name, the default one will be based on the name
of the `experiment`.

Expand All @@ -41,7 +38,6 @@ version.
[git branch]:
https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging
[regular commits]: /doc/user-guide/experiment-management/persisting-experiments
[checkpoint experiments]: /doc/command-reference/exp/run#checkpoints
[stored and shared]:
/doc/start/data-management/data-versioning#storing-and-sharing

Expand Down
3 changes: 0 additions & 3 deletions content/docs/command-reference/exp/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@ experiments in that <abbr>repository</abbr> instead (if any).
Only experiments derived from the `HEAD` commit are listed by default (see the
options below).

> Note that [checkpoints](/doc/command-reference/exp/run#checkpoints) are not
> listed, only the parent experiment.

## Options

- `--rev <commit>` - list experiments derived from the specified `<commit>` as
Expand Down
2 changes: 0 additions & 2 deletions content/docs/command-reference/exp/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ Deletes one or more experiments, indicated by name (see `dvc exp run`) or ID

With `--queue`, the list of experiments awaiting execution is cleared instead.

> Note that all the checkpoints in an experiment are removed by this command.

## Options

- `--queue` - remove all experiments that haven't been run yet (defined via
Expand Down
14 changes: 0 additions & 14 deletions content/docs/command-reference/exp/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,6 @@ It's possible to [queue experiments] for later execution with the `--queue`
flag. Queued experiments can be run with `dvc queue start` and managed with
other `dvc queue` commands.

It's also possible to run special [checkpoint experiments] that log the
execution progress (useful for deep learning ML). The `--rev` and `--reset`
options have special uses for these.

<admon icon="book">

See the [Running Experiments] guide for more details on these features and more.
Expand All @@ -73,7 +69,6 @@ committing them to the Git repo. Unnecessary ones can be [cleared] with
[on-the-fly]: #example-modify-parameters-on-the-fly
[queue experiments]:
/doc/user-guide/experiment-management/running-experiments#the-experiments-queue
[checkpoint experiments]: /doc/user-guide/experiment-management/checkpoints
[running experiments]: /doc/user-guide/experiment-management/running-experiments
[review]: /doc/user-guide/experiment-management/comparing-experiments
[made persistent]: /doc/user-guide/experiment-management/persisting-experiments
Expand Down Expand Up @@ -112,9 +107,6 @@ committing them to the Git repo. Unnecessary ones can be [cleared] with
- `--queue` - place this experiment at the end of a line for future execution,
but don't run it yet. Use `dvc queue start` to process the queue.

> For checkpoint experiments, this implies `--reset` unless a `--rev` is
> provided.

- `--run-all` - run all queued experiments (see `--queue`) and outside your
workspace (in `.dvc/tmp/exps`). Use `-j` to execute them
[in parallel](#queueing-and-parallel-execution).
Expand All @@ -131,12 +123,6 @@ committing them to the Git repo. Unnecessary ones can be [cleared] with
parallel. Only has an effect along with `--run-all`. Defaults to 1 (the queue
is processed serially).

- `-r <commit>`, `--rev <commit>` - resume an experiment from a specific
checkpoint name or hash (`commit`) in `--queue` or `--temp` runs.

- `--reset` - deletes `checkpoint: true` outputs before running this experiment
(regardless of `dvc.lock`). Useful for ML model re-training.

- `-f`, `--force` - reproduce pipelines even if no changes were found (same as
`dvc repro -f`).

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ project we want to clear.

- `--all-experiments` keep cached objects referenced in all [DVC experiments],
as well as in the workspace (implying `-w`). This preserves the project's
[experimental] data (including checkpoints). See also `dvc exp gc`.
[experimental] data. See also `dvc exp gc`.

- `-p <paths>`, `--projects <paths>` - if a single remote or a single [cache is
shared] among different projects, this option can be used to specify a list of
Expand Down
4 changes: 0 additions & 4 deletions content/docs/command-reference/stage/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,6 @@ data science experiments.
- `--outs-persist-no-cache <path>` - the same as `-outs-persist` except that
outputs are not tracked by DVC (same as with `-O` above).

- `-c <path>`, `--checkpoints <path>` - the same as `-o` but also marks the
output as a [checkpoint](/doc/command-reference/exp/run#checkpoints). This
makes the stage incompatible with `dvc repro`.

- `-p [<path>:]<params_list>`, `--params [<path>:]<params_list>` - specify one
or more [parameter dependencies][param-deps] from a structured file `path`
(`./params.yaml` by default). This is done by sending a comma separated list
Expand Down
7 changes: 1 addition & 6 deletions content/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,7 @@
"visualizing-plots",
"sharing-experiments",
"persisting-experiments",
"cleaning-experiments",
"checkpoints"
"cleaning-experiments"
]
},
{
Expand Down Expand Up @@ -541,10 +540,6 @@
"slug": "get_url",
"label": "get_url()"
},
{
"slug": "make_checkpoint",
"label": "make_checkpoint()"
},
{
"slug": "metrics_show",
"label": "metrics_show()"
Expand Down
4 changes: 1 addition & 3 deletions content/docs/use-cases/experiment-tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,14 @@ Major benefits of tracking experiment with DVC:
<abbr>metrics</abbr>.
- Use a controlled [execution mechanism]; Run one or queue many experiments (and
run them in parallel if needed).
- Create deep learning [checkpoints] from your code, and track
[live metrics](/doc/dvclive).
- Track [live metrics](/doc/dvclive).
- [Review and compare] results based on params or metrics; Restore them from
<abbr>cache</abbr> or reproduce them from scratch.
- Adopt or stay on a Git workflow ([distributed collaboration][shared]) and
services such as GitHub.
- Enable [Experiment Versioning] practices.

[execution mechanism]: /doc/user-guide/experiment-management/running-experiments
[checkpoints]: /doc/user-guide/experiment-management/checkpoints
[review and compare]:
/doc/user-guide/experiment-management/comparing-experiments
[experiment versioning]: /blog/ml-experiment-versioning
Expand Down
Loading