Convert to markdown: fsdp.rst, func.api.rst, func.batch_norm.rst, func.migrating.rst, func.rst #155104
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/155104
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 12a749d05f7f0a7c0385e8ce5324dcd6c6fd92db with merge base 0d8c029 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
zxiiro
requested changes
Jun 4, 2025
|
Double check the issue for instructions on how to correctly convert the .rst to .md (step 2 in the issue gives you the correct way to do it). |
ae12b3b to
fac0604
Compare
|
Sorry my bad. I made the changes |
zxiiro
previously approved these changes
Jun 4, 2025
|
This PR also address #155158 |
svekars
reviewed
Jun 4, 2025
docs/source/func.api.md
Outdated
|
|
||
| However, if you want to do something like compute a jacobian over the parameters | ||
| of the model, then there needs to be a way to construct a function where the | ||
| parameters are the inputs to the function. | ||
| That's what :func:`functional_call` is for: | ||
| That's what {func}`functional_call` is for: |
There was a problem hiding this comment.
below parameters should have single backticks
docs/source/func.migrating.md
Outdated
Comment on lines
26
to
27
| | functorch.vmap | `torch.vmap` or `torch.func.vmap` | | ||
| | functorch.grad | `torch.func.grad` | |
|
We typically prefer each PR to address one issue but given what a small change this is, I guess it's okay. |
b7efc97 to
0d99d93
Compare
|
To add the ciflow label This helps ensure we don't trigger CI on this PR until it is actually authorized to do so. Please ping one of the reviewers if you do not have access to approve and run workflows. |
svekars
reviewed
Jun 5, 2025
docs/source/func.migrating.md
Outdated
| return torch.func.functional_call(base_model, (params, buffers), (data,)) | ||
|
|
||
| output = torch.vmap(call_single_model, (0, 0, None))(params, buffers, data) | ||
| assert output.shape == (num_models, batch_size, out_features) |
There was a problem hiding this comment.
Need to add the closing markdown backticks.
docs/source/func.migrating.md
Outdated
|
|
||
| For example, here is an example of how to ensemble over a very simple model:: | ||
|
|
||
| import torch |
There was a problem hiding this comment.
please: indent to the left the whole block
The formatting is a bit different: https://docs-preview.pytorch.org/pytorch/pytorch/155104/func.migrating.html#functorch-combine-state-for-ensemble from the main: https://docs.pytorch.org/docs/main/func.migrating.html#functorch-combine-state-for-ensemble
|
Thanks for your help @svekars |
svekars
approved these changes
Jun 6, 2025
|
@pytorchbot rebase |
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.
Docathon:
Fixes #155021
Fixes #155158
cc @H-Huang @awgu @wanchaol @fegin @fduwjj @wz337 @wconstab @d4l3k @svekars @sekyondaMeta @AlannaBurke @jgong5 @mingfeima @XiaobingSuper @sanchitintel @ashokei @jingxu10 @jerryzh168 @gujinghui @PenghuiCheng @jianyuh @min-jean-cho @yanbing-j @Guobing-Chen @Xia-Weiwen @snadampal @voznesenskym @penguinwu @EikanWang @zhuhaozhe @blzheng @wenzhe-nrv @jiayisunx @ipiszy @chenyang78 @kadeng @muchulee8 @amjames @chauhang @aakhundov