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

Fix documentation for every_n_epochs parameter of ModelCheckpoint #10421

Merged
merged 2 commits into from
Nov 19, 2021

Conversation

adamreeve
Copy link
Contributor

What does this PR do?

Fixes documentation on the every_n_epochs parameter in ModelCheckpoint. This incorrectly states that leaving the value as the default of None means that checkpoints are not saved.

Does your PR introduce any breaking changes? If yes, please list them.

No

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@carmocca carmocca added this to the 1.6 milestone Nov 9, 2021
@carmocca carmocca added checkpointing Related to checkpointing docs Documentation related labels Nov 9, 2021
@justusschock justusschock enabled auto-merge (squash) November 9, 2021 08:56
@mergify mergify bot added the ready PRs ready to be merged label Nov 9, 2021
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great !

@adamreeve
Copy link
Contributor Author

Do I need to do anything to get this merged? Looks like it's blocked on some test failures that look unrelated to this change, plus not having a linked issue, although from the PR template this shouldn't be required for a docs change.

@justusschock justusschock merged commit 5fe0dac into Lightning-AI:master Nov 19, 2021
Raalsky pushed a commit to neptune-ai/pytorch-lightning that referenced this pull request Nov 23, 2021
@rohitgr7 rohitgr7 mentioned this pull request Feb 7, 2022
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
checkpointing Related to checkpointing docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants