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

[Doc] Fix mistakes in docs for Trainer checkpointing backends #2285

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

kurtamohler
Copy link
Collaborator

Description

Fix documentation for Trainer checkpointing, which mistakenly said that torchsnapshot is the default backend, when torch is actually the default, as seen here.

Also fix incorrect syntax for the hyperlink to the torchsnapshot repo.

Motivation and Context

close #2075

  • Someone has raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Remove all that do not apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of examples)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.

Copy link

pytorch-bot bot commented Jul 9, 2024

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/rl/2285

Note: Links to docs will display an error until the docs builds have been completed.

❌ 1 New Failure, 8 Pending, 16 Unrelated Failures

As of commit 6cf8ee0 with merge base 3566388 (image):

NEW FAILURE - The following job has failed:

FLAKY - The following jobs failed but were likely due to flakiness present on trunk:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jul 9, 2024
@vmoens vmoens changed the title Fix mistakes in docs for Trainer checkpointing backends [Doc] Fix mistakes in docs for Trainer checkpointing backends Jul 10, 2024
Copy link
Contributor

@vmoens vmoens left a comment

Choose a reason for hiding this comment

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

LGTM thanks!

@vmoens vmoens merged commit 824f6d1 into pytorch:main Jul 10, 2024
3 of 7 checks passed
@vmoens vmoens added the documentation Improvements or additions to documentation label Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] default snapshot backend doesn't match docs
3 participants