Skip to content

Commit

Permalink
Fix dead links in callback configs (#557)
Browse files Browse the repository at this point in the history
  • Loading branch information
tbazin authored Mar 30, 2023
1 parent 1ff28ce commit 8919406
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 12 deletions.
4 changes: 1 addition & 3 deletions configs/callbacks/early_stopping.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# https://pytorch-lightning.readthedocs.io/en/latest/api/lightning.callbacks.EarlyStopping.html
# https://lightning.ai/docs/pytorch/stable/api/lightning.pytorch.callbacks.EarlyStopping.html

# Monitor a metric and stop training when it stops improving.
# Look at the above link for more detailed information.
early_stopping:
_target_: lightning.pytorch.callbacks.EarlyStopping
monitor: ??? # quantity to be monitored, must be specified !!!
Expand Down
4 changes: 1 addition & 3 deletions configs/callbacks/model_checkpoint.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# https://pytorch-lightning.readthedocs.io/en/latest/api/lightning.callbacks.ModelCheckpoint.html
# https://lightning.ai/docs/pytorch/stable/api/lightning.pytorch.callbacks.ModelCheckpoint.html

# Save the model periodically by monitoring a quantity.
# Look at the above link for more detailed information.
model_checkpoint:
_target_: lightning.pytorch.callbacks.ModelCheckpoint
dirpath: null # directory to save the model file
Expand Down
4 changes: 1 addition & 3 deletions configs/callbacks/model_summary.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# https://pytorch-lightning.readthedocs.io/en/latest/api/lightning.callbacks.RichModelSummary.html
# https://lightning.ai/docs/pytorch/stable/api/lightning.pytorch.callbacks.RichModelSummary.html

# Generates a summary of all layers in a LightningModule with rich text formatting.
# Look at the above link for more detailed information.
model_summary:
_target_: lightning.pytorch.callbacks.RichModelSummary
max_depth: 1 # the maximum depth of layer nesting that the summary will include
4 changes: 1 addition & 3 deletions configs/callbacks/rich_progress_bar.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# https://pytorch-lightning.readthedocs.io/en/latest/api/lightning.callbacks.RichProgressBar.html
# https://lightning.ai/docs/pytorch/latest/api/lightning.pytorch.callbacks.RichProgressBar.html

# Create a progress bar with rich text formatting.
# Look at the above link for more detailed information.
rich_progress_bar:
_target_: lightning.pytorch.callbacks.RichProgressBar

0 comments on commit 8919406

Please sign in to comment.