Update PR template #1614
Merged
Update PR template #1614
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/1614
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 1499f00 with merge base 48eb35d ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
joecummings
commented
Sep 17, 2024
| @@ -9,9 +9,10 @@ Please link to any issues this PR addresses. | |||
|
|
|||
| #### Changelog | |||
| What are the changes made in this PR? | |||
| * | |||
There was a problem hiding this comment.
Starts them off doing bullet points
joecummings
commented
Sep 17, 2024
| @@ -23,8 +24,8 @@ Please make sure to do each of the following if applicable to your PR. (If you'r | |||
|
|
|||
| #### UX | |||
| If your function changed a public API, please add a dummy example of what the user experience will look like when calling it. | |||
| Example of docstring: https://github.com/pytorch/torchtune/blob/6a7951f1cdd0b56a9746ef5935106989415f50e3/torchtune/modules/vision_transformer.py#L285 | |||
| Example in our docs: https://pytorch.org/torchtune/main/tutorials/qat_finetune.html#applying-qat-to-llama3-models | |||
| Here is a [docstring example](https://github.com/pytorch/torchtune/blob/6a7951f1cdd0b56a9746ef5935106989415f50e3/torchtune/modules/vision_transformer.py#L285) | |||
There was a problem hiding this comment.
Hides the annoying auto render
| @@ -9,9 +9,10 @@ Please link to any issues this PR addresses. | |||
|
|
|||
| #### Changelog | |||
| What are the changes made in this PR? | |||
| * | |||
There was a problem hiding this comment.
Suggested change
| * | |
| * |
don render too good
SalmanMohammadi
approved these changes
Sep 17, 2024
ebsmothers
approved these changes
Sep 17, 2024
ebsmothers
pushed a commit
that referenced
this pull request
Sep 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
What is the purpose of this PR? Is it to
Please link to any issues this PR addresses.
Changelog
What are the changes made in this PR?
Test plan
Please make sure to do each of the following if applicable to your PR. (If you're not sure about any one of these just ask and we will happily help. We also have a contributing page for some guidance on contributing.)
pre-commit install)pytest testspytest tests -m integration_testUX
If your function changed a public API, please add a dummy example of what the user experience will look like when calling it.
Example of docstring:
torchtune/torchtune/modules/vision_transformer.py
Line 285 in 6a7951f
Example in our docs: https://pytorch.org/torchtune/main/tutorials/qat_finetune.html#applying-qat-to-llama3-models