Skip to content

Commit

Permalink
dvclive: copy best lightning checkpoint (#4768)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dave Berenbaum authored Aug 16, 2023
1 parent 9d4ab72 commit 607c534
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions content/docs/dvclive/ml-frameworks/pytorch-lightning.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,12 @@ checkpointing at all as described in the
created by [`ModelCheckpoint`]. See
[Log model checkpoints](#log-model-checkpoints).

- if `log_model == 'all'`, checkpoints are logged during training.
- if `log_model == False` (default), no checkpoint is logged.

- if `log_model == True`, checkpoints are logged at the end of training,
except when `save_top_k == -1` which also logs every checkpoint during
training.
except when `save_top_k == -1` which logs every checkpoint during training.

- if `log_model == False` (default), no checkpoint is logged.
- if `log_model == 'all'`, checkpoints are logged during training.

- `experiment` - (`None` by default) - [`Live`](/doc/dvclive/live) object to be
used instead of initializing a new one.
Expand All @@ -85,9 +84,10 @@ checkpointing at all as described in the
### Log model checkpoints

Use `log_model` to save the checkpoints (it will use `Live.log_artifact()`
internally to save those). At the end of training, DVCLive will annotate the
[`best_model_path`][`ModelCheckpoint`] with name `best` (for example, to be
consumed in [Studio model registry] or automation scenarios).
internally to save those). At the end of training, DVCLive will copy the
[`best_model_path`][`ModelCheckpoint`] to the `dvclive/artifacts` directory and
annotate it with name `best` (for example, to be consumed in [Studio model
registry] or automation scenarios).

- Save updates to the checkpoints directory at the end of training:

Expand Down

0 comments on commit 607c534

Please sign in to comment.