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

Add documentation information #896

Merged
merged 2 commits into from
Apr 29, 2024
Merged

Add documentation information #896

merged 2 commits into from
Apr 29, 2024

Conversation

joecummings
Copy link
Contributor

Context

  • add a new feature
  • fix a bug
  • update tests and/or documentation
  • other (please add here)

Changelog

  • Update CONTRIBUTING.md with instructions on adding documentation
  • Change TorchTune -> torchtune in CONTRIBUTING

Test plan

  • run pre-commit hooks and linters (make sure you've first installed via pre-commit install)
  • add unit tests for any new functionality
  • update docstrings for any new or updated methods or classes
  • run unit tests via pytest tests
  • run recipe tests via pytest tests -m integration_test
  • manually run any new or modified recipes with sufficient proof of correctness
    • include relevant commands and any other artifacts in this summary (pastes of loss curves, eval results, etc.)

Copy link

pytorch-bot bot commented Apr 28, 2024

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/896

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

✅ No Failures

As of commit 562150d with merge base a94803f (image):
💚 Looks good so far! There are no failures yet. 💚

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 Apr 28, 2024
@joecummings joecummings marked this pull request as ready for review April 28, 2024 22:27
@joecummings joecummings requested review from ebsmothers, kartikayk and RdoubleA and removed request for ebsmothers April 28, 2024 22:30
Copy link
Contributor

@kartikayk kartikayk 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! Thanks @joecummings

@joecummings joecummings merged commit aa65012 into main Apr 29, 2024
27 checks passed
@joecummings joecummings deleted the joecummings-patch-1 branch April 29, 2024 16:53
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants