Skip to content

Convert rst files to md #155369

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 3 commits into from
Closed

Convert rst files to md #155369

wants to merge 3 commits into from

Conversation

jafraustro
Copy link
Contributor

@jafraustro jafraustro commented Jun 6, 2025 •
edited by pytorch-bot bot
Loading

@pytorch-bot PyTorch Bot
Copy link

pytorch-bot bot commented Jun 6, 2025 •
edited
Loading

🔗 Helpful Links

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

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

✅ You can merge normally! (1 Unrelated Failure)

As of commit f12438f with merge base 0d8c029 (image):

BROKEN TRUNK - The following job failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

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

@pytorch-bot pytorch-bot bot added oncall: distributed Add this issue/PR to distributed oncall triage queue release notes: distributed (sharded) release notes category labels Jun 6, 2025
@github-actions github-actions bot added docathon-h1-2025 medium Label for medium docathon tasks module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels Jun 6, 2025
@jafraustro jafraustro marked this pull request as ready for review June 6, 2025 21:22
@jafraustro jafraustro mentioned this pull request Jun 6, 2025
Closed
@jafraustro
Copy link
Contributor Author

Preview links to the pages:

fsdp.rst: https://docs-preview.pytorch.org/pytorch/pytorch/155369/fsdp.html#module-torch.distributed.fsdp
func.api.rst: https://docs-preview.pytorch.org/pytorch/pytorch/155369/func.api.html
func.batch_norm.rst: https://docs-preview.pytorch.org/pytorch/pytorch/155369/func.batch_norm.html
func.migrating.rst: https://docs-preview.pytorch.org/pytorch/pytorch/155369/func.migrating.html
func.rst: https://docs-preview.pytorch.org/pytorch/pytorch/155369/func.html

@jafraustro
Copy link
Contributor Author

@pytorchbot label "topic: docs"

@pytorch-bot pytorch-bot bot added the topic: docs topic category label Jun 9, 2025
@jafraustro
Copy link
Contributor Author

@pytorchbot label "topic: not user facing"

@pytorch-bot pytorch-bot bot added the topic: not user facing topic category label Jun 9, 2025
svekars
svekars reviewed Jun 9, 2025
View reviewed changes
docs/source/func.api.md
@@ -0,0 +1,88 @@
# torch.func API Reference
Copy link
Contributor

Choose a reason for hiding this comment

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

Created on date for this file has changed: func.api.html (compared to main - this needs to be fixed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I split the one commit into three commits, so the use of git mv is clearly specified.

svekars
svekars reviewed Jun 9, 2025
View reviewed changes
docs/source/func.migrating.md
@@ -0,0 +1,201 @@
# Migrating from functorch to torch.func
Copy link
Contributor

Choose a reason for hiding this comment

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

Created On date for this file has changed https://docs-preview.pytorch.org/pytorch/pytorch/155369/func.migrating.html compared to main - this has to be fixed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I split the one commit into three commits, so the use of git mv is clearly specified.

@jafraustro
git mv rst to md files
ca3875e 
Signed-off-by: jafraustro <[email protected]>
@jafraustro jafraustro force-pushed the jafraust/issue_155021 branch from df96ee9 to ca3875e Compare June 10, 2025 03:47
@svekars
Copy link
Contributor

svekars commented Jun 11, 2025

@pytorchbot merge -f "Docs only change, doc signal is green."

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged immediately since you used the force (-f) flag, bypassing any CI checks (ETA: 1-5 minutes). Please use -f as last resort and instead consider -i/--ignore-current to continue the merge ignoring current failures. This will allow currently pending tests to finish and report signal before the merge.

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

@pytorchmergebot
Copy link
Collaborator

Merge failed

Reason: Approvers from one of the following sets are needed:

  • superuser (pytorch/metamates)
  • Core Reviewers (mruberry, lezcano, Skylion007, ngimel, peterbell10, ...)
  • Core Maintainers (soumith, gchanan, ezyang, dzhulgakov, malfet, ...)
Details for Dev Infra team Raised by workflow job

Failing merge rule: Core Maintainers

@svekars svekars requested review from Skylion007 and malfet June 11, 2025 22:41
@svekars
Copy link
Contributor

svekars commented Jun 11, 2025

@pytorchbot merge -f "Docs only change. Doc signal is green. "

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged immediately since you used the force (-f) flag, bypassing any CI checks (ETA: 1-5 minutes). Please use -f as last resort and instead consider -i/--ignore-current to continue the merge ignoring current failures. This will allow currently pending tests to finish and report signal before the merge.

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@malfet malfet malfet approved these changes

@svekars svekars svekars approved these changes

@Skylion007 Skylion007 Awaiting requested review from Skylion007

Assignees
No one assigned
Labels
docathon-h1-2025 medium Label for medium docathon tasks Merged module: docs Related to our documentation, both in docs/ and docblocks oncall: distributed Add this issue/PR to distributed oncall triage queue open source release notes: distributed (sharded) release notes category topic: docs topic category topic: not user facing topic category triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ERROR: Unknown target name: "deepspeed" Convert to markdown: fsdp.rst, func.api.rst, func.batch_norm.rst, func.migrating.rst, func.rst
5 participants
@jafraustro @svekars @pytorchmergebot @malfet @pytorchbot