Skip to content

Commit

Permalink
ref: clarify that exp branch makes 1+ commits in the exp branch
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed Dec 21, 2021
1 parent 220a9b0 commit 117a61d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions content/docs/command-reference/exp/branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ positional arguments:

## Description

Makes a named Git [`branch`] containing the target `experiment` (making it
[persistent]. For [checkpoint experiments], the new branch will contain multiple
commits (the checkpoints).
Makes a given Git [`branch`] containing the target `experiment`. This makes the
experiment into a regular commit, or several in the case of [checkpoint
experiments] (one per checkpoint).

The new `branch` will be based on the experiment's parent commit (`HEAD` at the
time that the experiment was run). Note that DVC **does not** switch into the
Expand All @@ -33,7 +33,7 @@ version.

[`branch`]:
https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging
[persistent]: /doc/user-guide/experiment-management/persisting-experiments
[regular commit]: /doc/user-guide/experiment-management/persisting-experiments
[checkpoint experiments]: /doc/command-reference/exp/run#checkpoints
[stored and shared]: /doc/use-cases/sharing-data-and-model-files

Expand Down

0 comments on commit 117a61d

Please sign in to comment.