windsonsea
9944cd0949
Convert to markdown: quantization-accuracy-debugging.rst, quantization-backend-configuration.rst, quantization-support.rst, random.rst ( #155520 )
...
Related to #155032
- ✅ quantization-accuracy-debugging.rst: [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155520/quantization-accuracy-debugging.html ) vs [main](https://docs.pytorch.org/docs/main/quantization-accuracy-debugging.html )
- ✅ quantization-backend-configuration.rst: [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155520/quantization-backend-configuration.html ) vs [main](https://docs.pytorch.org/docs/main/quantization-backend-configuration.html )
- ✅ quantization-support.rst: [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155520/quantization-support.html ) vs [main](https://docs.pytorch.org/docs/main/quantization-support.html )
- ✅ random.rst: [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155520/random.html ) vs [main](https://docs.pytorch.org/docs/main/random.html )
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155520
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-18 18:46:04 +00:00
nirajkamalk
202d2ae53a
Convert rst to md: rpc.rst, signal.rst, size.rst, special.rst ( #155430 )
...
Fixes #155033
- [x] [rpc.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/rpc.rst )
- [x] [signal.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/signal.rst )
- [x] [size.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/size.rst )
- [sparse.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/sparse.rst ) fixed in #155438 due to large size.
- [x] [special.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/special.rst )
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155430
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-18 01:27:04 +00:00
Jane Xu
e8bfce9a43
Document how to use stack-based APIs with StableIValue ( #155984 )
...
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155984
Approved by: https://github.com/albanD , https://github.com/zou3519
2025-06-18 01:10:23 +00:00
PyTorch MergeBot
fa4f07b5b8
Revert "[Docs] Convert to markdown to fix 155032 ( #155520 )"
...
This reverts commit cd66ff8030 .
Reverted https://github.com/pytorch/pytorch/pull/155520 on behalf of https://github.com/atalman due to breaks multiple test_quantization.py::TestQuantizationDocs::test_quantization_ ([comment](https://github.com/pytorch/pytorch/pull/155520#issuecomment-2981996091 ))
2025-06-17 22:22:50 +00:00
windsonsea
cd66ff8030
[Docs] Convert to markdown to fix 155032 ( #155520 )
...
Fix #155032
- ✅ quantization-accuracy-debugging.rst: [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155520/quantization-accuracy-debugging.html ) vs [main](https://docs.pytorch.org/docs/main/quantization-accuracy-debugging.html )
- ✅ quantization-backend-configuration.rst: [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155520/quantization-backend-configuration.html ) vs [main](https://docs.pytorch.org/docs/main/quantization-backend-configuration.html )
- ✅ quantization-support.rst: [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155520/quantization-support.html ) vs [main](https://docs.pytorch.org/docs/main/quantization-support.html )
- ✅ quantization.rst: [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155520/quantization.html ) vs [main](https://docs.pytorch.org/docs/main/quantization.html )
- ✅ random.rst: [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155520/random.html ) vs [main](https://docs.pytorch.org/docs/main/random.html )
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155520
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-17 20:29:45 +00:00
Svetlana Karslioglu
fc5ae12293
Fix issue with right-nav ( #156119 )
...
Enable on page right nav. For autosummary, we need to set `"show_toc_level": 2` so that navigation is enabled. Example:
* Main: https://docs.pytorch.org/docs/main/special.html - right nav (under On this page) is empty.
* Preview: https://docs-preview.pytorch.org/pytorch/pytorch/156119/special.html - right nav (under On this page) has a all the object listed
<img width="1125" alt="Screenshot 2025-06-16 at 2 48 16 PM" src="https://github.com/user-attachments/assets/0790bb72-5997-4542-9847-0a89be4598c0 " />
vs
<img width="1030" alt="Screenshot 2025-06-16 at 2 48 55 PM" src="https://github.com/user-attachments/assets/4897c49c-044d-4bea-a8cd-490c90cca2b0 " />
Pull Request resolved: https://github.com/pytorch/pytorch/pull/156119
Approved by: https://github.com/albanD
2025-06-17 18:09:51 +00:00
windsonsea
7fcad0231c
[Docs] Convert to markdown to fix 155025 ( #155789 )
...
Related to #155025
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155789
Approved by: https://github.com/svekars
2025-06-17 15:08:14 +00:00
Wei (Will) Feng
4a8f5e752b
[FSDP2] explain user contract for fully_shard ( #156070 )
...
<img width="896" alt="Screenshot 2025-06-16 at 1 36 00 AM" src="https://github.com/user-attachments/assets/7cdea256-2454-49c7-8b32-24549a13134d " />
Pull Request resolved: https://github.com/pytorch/pytorch/pull/156070
Approved by: https://github.com/mori360
2025-06-17 10:03:19 +00:00
Justin Silver
008345be9d
Fix #155018 (convert distributed rst to markdown) ( #155528 )
...
Used [rst2myst tool](https://rst-to-myst.readthedocs.io/en/latest/ )
Fixes #155018
Docs comparison (check out the 'new' whenever docs build)
1. distributed.checkpoint ([old](https://docs.pytorch.org/docs/main/distributed.checkpoint.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155528/distributed.checkpoint.html ))
2. distributed.elastic ([old](https://docs.pytorch.org/docs/main/distributed.elastic.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155528/distributed.elastic.html ))
3. distributed.fsdp.fully_shard ([old](https://docs.pytorch.org/docs/main/distributed.fsdp.fully_shard.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155528/distributed.fsdp.fully_shard.html ))
4. distributed.optim ([old](https://docs.pytorch.org/docs/main/distributed.optim.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155528/distributed.optim.html ))
5. distributed.pipelining ([old](https://docs.pytorch.org/docs/main/distributed.pipelining.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155528/distributed.pipelining.html ))
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155528
Approved by: https://github.com/wz337 , https://github.com/svekars
2025-06-16 20:46:09 +00:00
Julian De la Barrera Brandner
2dc1627451
[doc] Add documentation for division by zero behavior in autograd ( #155987 )
...
Fixes #128796
This PR adds documentation about the behavior of division by zero operations in PyTorch's autograd system. The documentation explains:
1. How division by zero produces `inf` values following IEEE-754 floating point arithmetic
2. How autograd handles these cases and why masking after division can lead to `nan` gradients
3. Provides concrete examples showing the issue
4. Recommends two solutions:
- Masking before division
- Using MaskedTensor (experimental API)
The documentation is added to the autograd notes section, making it easily discoverable for users who encounter this common issue.
This addresses the original issue #128796 which requested better documentation of this behavior to help users avoid common pitfalls when dealing with division by zero in their models.
dditional changes:
- Fixed formatting consistency by replacing curly apostrophes with straight apostrophes in the existing documentation
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155987
Approved by: https://github.com/soulitzer
Co-authored-by: sekyondaMeta <127536312+sekyondaMeta@users.noreply.github.com>
2025-06-16 19:02:12 +00:00
windsonsea
fbd88ae2b5
Convert to markdown: checkpoint.rst ( #156009 )
...
Related to #155014
Use two commits to have a try.
```bash
1800 git mv docs/source/checkpoint.rst docs/source/checkpoint.md
1802 git commit -m "[Docs] Rename checkpoint.rst"
1803 git push origin ckpoint
# update the markdown file
1805 git add .
1806 git commit -m "modify checkpoint.md"
1807 git push origin ckpoint
```
Pull Request resolved: https://github.com/pytorch/pytorch/pull/156009
Approved by: https://github.com/svekars
2025-06-16 17:48:23 +00:00
windsonsea
a10024d7de
Convert complex_numbers.rst to markdown ( #156039 )
...
Related to #155014
Have a try by following https://github.com/pytorch/pytorch/pull/155899#issuecomment-2974715750
Pull Request resolved: https://github.com/pytorch/pytorch/pull/156039
Approved by: https://github.com/svekars
2025-06-16 17:24:37 +00:00
Dhia naouali
c620d0b5c7
convert: rst to myst pr2/2 ( #155911 )
...
Fixes #155038
parent [PR](https://github.com/pytorch/pytorch/pull/155375 ) (made two PRs to pass sanity check)
this PR converts the following three .rst files with the mentioned referenced in each file
- [torch.compiler_faq](https://github.com/pytorch/pytorch/blob/main/docs/source/torch.compiler_faq.rst )
- torch.compiler_troubleshooting
- nonsupported_numpy_feats
- torchdynamo_fine_grain_tracing
- [torch.compiler_fine_grain_apis](https://github.com/pytorch/pytorch/blob/main/docs/source/torch.compiler_fine_grain_apis.rst )
- None
- [torch.compiler_get_started](https://github.com/pytorch/pytorch/blob/main/docs/source/torch.compiler_get_started.rst )
- torch.compiler_overview
- torch.compiler_api
- torchdynamo_fine_grain_tracing
I made the suggested edits by the maintainers as commented in the parent PR
(used git mv on all files, yet it still appeared as delete-create action)
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155911
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-16 00:44:44 +00:00
Animesh Jain
54976bca10
[dynamo] Provide helper functions for guard filter hook ( #155083 )
...
Collection of ready-made guard filters. One issue is that they are not composable - `filter1(filter2(guard))`. On the other hand, they are easy to use.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155083
Approved by: https://github.com/zhxchen17 , https://github.com/jansel
2025-06-15 17:49:36 +00:00
Edgar Romo Montiel
ca3cabd24a
Convert to markdown: named_tensor.rst, nested.rst, nn.attention.bias.rst, nn.attention.experimental.rst, nn.attention.flex_attention.rst #155028 ( #155696 )
...
Fixes #155028
This pull request updates the documentation by transitioning from .rst to .md format. It introduces new Markdown files for the documentation of named_tensor, nested, nn.attention.bias, nn.attention.experimental, and nn.attention.flex_attention
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155696
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-14 03:32:00 +00:00
dggaytan
3003c681ef
Converting .rst files to .md files ( #155377 )
...
Fixes #155036
This pull request updates the documentation for several modules by transitioning from .rst to .md format, improving readability and usability. It introduces new Markdown files for the documentation of torch.ao.ns._numeric_suite, torch.ao.ns._numeric_suite_fx, AOTInductor, AOTInductor Minifier, and the torch.compiler API
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155377
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-13 22:54:27 +00:00
ggsmith842
799443605b
Convert to markdown: distributed.tensor.parallel.rst, distributed.tensor.rst, distributions.rst, dlpack.rst ( #155297 )
...
Fixes #155019
## Description
Convert to markdown: distributed.tensor.parallel.rst, distributed.tensor.rst, distributions.rst, dlpack.rst
## Checklist
- [X] dlpack.rst converted to dlpack.md --> [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155297/dlpack.html )
- [X] distributions.rst converted to distributions.md --> [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155297/distributions.html )
- [X] distributed.tensor.rst converted to distributed.tensor.md --> [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155297/distributed.tensor.html )
- [X] distributed.tensor.parallel.rst converted to distributed.tensor.parallel.md --> [Preview](https://docs-preview.pytorch.org/pytorch/pytorch/155297/distributed.tensor.parallel.html )
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155297
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-13 22:08:37 +00:00
Runtian (Rachel) Li
049dc48d1e
fix code chunk indentation for jit_language_reference_v2.md ( #155937 )
...
Fixes https://github.com/pytorch/pytorch/issues/155023
Related PR: #155781
Description:
As discussed, this PR is a follow-up update for `jit_language_reference_v2.md` by deleting the code chunk indentation.
Checklist:
- [x] The issue being fixed is referenced above (Fixes https://github.com/pytorch/pytorch/issues/155023 )
- [x] Only one issue is addressed in this pull request
- [x] Labels from the issue that this PR is fixing are added to this pull request
- [x] No unnecessary issues are included into this pull request.
@pytorchbot label "topic: docs"
@pytorchbot label "topic: not user facing"
@pytorchbot label docathon-h1-2025
@pytorchbot label "module: docs"
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155937
Approved by: https://github.com/jingsh , https://github.com/svekars
2025-06-13 21:05:23 +00:00
GdoongMathew
731351bb4a
Convert rst to markdown - optim.rst #155031 ( #155813 )
...
Fixes #155031

@pytorchbot label "docathon-h1-2025" "module: docs" "topic: not user facing" "topic: docs"
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155813
Approved by: https://github.com/AlannaBurke
2025-06-13 21:03:39 +00:00
windsonsea
7d1b3f599d
[Docs] Convert to markdown cond.rst, config_mod.rst ( #155653 )
...
Related to #155014
Only included 2 files in this PR:
- cond.rst
- config_mod.rst
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155653
Approved by: https://github.com/svekars
2025-06-13 20:58:57 +00:00
Justin Silver
f3e6c8e834
Fix #155016 for Docathon - convert rst to markdown ( #155198 )
...
Used [rst2myst tool](https://rst-to-myst.readthedocs.io/en/latest/ )
One note is that "Created On" and "Last Updated On" banner doesn't show in the markdown files... I'm not sure if that's just an artifact of my local build though.
Fixes #155016
Docs comparison (check out the 'new' whenever docs build)
1. cuda ([old](https://docs.pytorch.org/docs/main/cuda.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155198/cuda.html ))
2. cuda.tunable ([old](https://docs.pytorch.org/docs/main/cuda.tunable.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155198/cuda.tunable.html ))
3. leave cudnn_persistent_rnn.rst as is because it's reused in docstrings
4. cudnn_rnn_determinism.rst as is because it's reused in docstrings.
5. data ([old](https://docs.pytorch.org/docs/main/data.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155198/data.html ))
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155198
Approved by: https://github.com/albanD , https://github.com/svekars
2025-06-13 20:24:34 +00:00
Ankita George
bf798a2f01
Change _hfstorage to hfstorage ( #155837 )
...
Summary: Change HF classes to not have an underscore, there-by making them public, we will add documentation to them following this
Test Plan:
ensure existing tests pass
Rollback Plan:
Differential Revision: D76364024
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155837
Approved by: https://github.com/saumishr
2025-06-13 20:19:51 +00:00
Dhia-naouali
c5d00e150a
convert: rst to myst pr 1/2 ( #155840 )
...
Fixes #155038
parent [PR](https://github.com/pytorch/pytorch/pull/155375 ) (made two PRs to pass sanity check)
this PR converts the following two .rst files
- [torch.compiler_dynamo_overview](https://github.com/pytorch/pytorch/blob/main/docs/source/torch.compiler_dynamo_overview.rst )
- [torch.compiler_fake_tensor](https://github.com/pytorch/pytorch/blob/main/docs/source/torch.compiler_fake_tensor.rst )
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155840
Approved by: https://github.com/sekyondaMeta
2025-06-13 18:02:28 +00:00
Runtian (Rachel) Li
093aaccae2
convert jit_language_reference_v2.rst to jit_language_reference_v2.md ( #155781 )
...
Fixes https://github.com/pytorch/pytorch/issues/155023
Description:
converted `jit_language_reference_v2.rst` to `jit_language_reference_v2.md`
**I indented the code blocks to minimize the file difference to pass the sanity check for no more than 2000 lines of change. I will submit another PR to fix the indentation after this PR is merged.**
Checklist:
- [x] The issue being fixed is referenced above (Fixes https://github.com/pytorch/pytorch/issues/155023 )
- [x] Only one issue is addressed in this pull request
- [x] Labels from the issue that this PR is fixing are added to this pull request
- [x] No unnecessary issues are included into this pull request.
@pytorchbot label "topic: docs"
@pytorchbot label "topic: not user facing"
@pytorchbot label docathon-h1-2025
@pytorchbot label module: docs
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155781
Approved by: https://github.com/svekars
2025-06-13 17:33:10 +00:00
ZhaoqiongZ
3d595fd559
update get start xpu ( #151886 )
...
update link and product name
add print to print ```torch.xpu.is_available()``` result in code snippet for user not using command python
Pull Request resolved: https://github.com/pytorch/pytorch/pull/151886
Approved by: https://github.com/guangyey , https://github.com/AlannaBurke
Co-authored-by: Yu, Guangye <106960996+guangyey@users.noreply.github.com>
2025-06-13 07:46:13 +00:00
Justin Silver
70bb34929a
Convert to .md: draft_export.rst, export.ir_spec.rst, fft.rst ( #155567 )
...
Used [rst2myst tool](https://rst-to-myst.readthedocs.io/en/latest/ )
Fixes #155020 . This PR is split into 3 to pass sanity check.
Docs comparison (check out the 'new' whenever docs build)
1. draft_export ([old](https://docs.pytorch.org/docs/main/draft_export.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155567/draft_export.html ))
2. export.ir_spec ([old](https://docs.pytorch.org/docs/main/export.ir_spec.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155567/export.ir_spec.html ))
3. fft ([old](https://docs.pytorch.org/docs/main/fft.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155567/fft.html ))
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155567
Approved by: https://github.com/svekars
2025-06-13 05:19:43 +00:00
GdoongMathew
2ba930d4ce
Convert rst to markdown - profiler.rst #155031 ( #155559 )
...
Fixes https://github.com/pytorch/pytorch/issues/155031
* [profiler.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/profiler.rst )
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155559
Approved by: https://github.com/svekars
2025-06-13 05:02:54 +00:00
Runtian (Rachel) Li
e8b3dfa7c0
convert jit_language_reference.rst to jit_language_reference.md ( #155633 )
...
Part of changes https://github.com/pytorch/pytorch/issues/155023 (parent PR https://github.com/pytorch/pytorch/pull/155429 )
- converted jit_language_reference.rst to jit_language_reference.md
@pytorchbot label "topic: docs"
@pytorchbot label "topic: not user facing"
@pytorchbot label docathon-h1-2025
@pytorchbot label module: docs
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155633
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-13 04:58:28 +00:00
Runtian (Rachel) Li
3f65e38b73
Convert hub.rst to hub.md ( #155483 )
...
Part of changes https://github.com/pytorch/pytorch/issues/155023 (parent PR https://github.com/pytorch/pytorch/pull/155429 )
@pytorchbot label "topic: docs"
@pytorchbot label "topic: not user facing"
@pytorchbot label docathon-h1-2025
@pytorchbot label module: docs
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155483
Approved by: https://github.com/svekars
2025-06-13 04:39:55 +00:00
Justin Silver
e085012335
Fix #155020 - rst2markdown for export.rst (split PR) ( #155753 )
...
Used [rst2myst tool](https://rst-to-myst.readthedocs.io/en/latest/ )
Fixes #155020 . This PR is split into 3 to pass sanity check. This is the 3rd one.
Docs comparison (check out the 'new' whenever docs build)
1. export ([old](https://docs.pytorch.org/docs/main/export.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155567/export.html ))
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155753
Approved by: https://github.com/sekyondaMeta
2025-06-12 19:30:52 +00:00
Grant Smith
7986c0dba6
rename distributed.rst to md ( #155767 )
...
Fixes #155019
For sanity checks, split PR to have this one only include distributed.rst -> distributed.md
Preview -> [distributed.md](https://docs-preview.pytorch.org/pytorch/pytorch/155767/distributed.html )
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155767
Approved by: https://github.com/sekyondaMeta
2025-06-12 18:42:15 +00:00
Runtian (Rachel) Li
9df2e8020f
fix code indentation for fx.md ( #155764 )
...
Fixes https://github.com/pytorch/pytorch/issues/155023
Related PR: #155482
Description:
As discussed here https://github.com/pytorch/pytorch/pull/155482#pullrequestreview-2918032289 , I removed indentation for python code blocks as a follow-up modification for fx.md
Checklist:
- [x] The issue being fixed is referenced above (Fixes https://github.com/pytorch/pytorch/issues/155023 )
- [x] Only one issue is addressed in this pull request
- [x] Labels from the issue that this PR is fixing are added to this pull request
- [x] No unnecessary issues are included into this pull request.
@pytorchbot label "topic: docs"
@pytorchbot label "topic: not user facing"
@pytorchbot label docathon-h1-2025
@pytorchbot label module: docs
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155764
Approved by: https://github.com/svekars
2025-06-12 16:02:33 +00:00
Kazuaki Ishizaki
b00b641ff1
[Docs] Convert to markdown: accelerator.rst, amp.rst, autograd.rst, backends.rst, benchmark_utils.rst ( #155762 )
...
Fixes #155013
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155762
Approved by: https://github.com/svekars
2025-06-12 02:55:06 +00:00
Justin Silver
cf9878d7a2
Fix #155022 rst to markdown conversion ( #155540 )
...
Used [rst2myst tool](https://rst-to-myst.readthedocs.io/en/latest/ )
Fixes #155022
Docs comparison (check out the 'new' whenever docs build)
1. func.ux_limitations ([old](https://docs.pytorch.org/docs/main/func.ux_limitations.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155540/func.ux_limitations.html ))
2. func.whirlwind_tour ([old](https://docs.pytorch.org/docs/main/func.whirlwind_tour.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155540/func.whirlwind_tour.html ))
3. future_mod ([old](https://docs.pytorch.org/docs/main/future_mod.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155540/future_mod.html ))
4. futures ([old](https://docs.pytorch.org/docs/main/futures.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155540/futures.html ))
5. fx.experimental ([old](https://docs.pytorch.org/docs/main/fx.experimental.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155540/fx.experimental.html ))
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155540
Approved by: https://github.com/AlannaBurke , https://github.com/svekars
2025-06-12 00:21:22 +00:00
jafraustro
1b032384b1
Convert rst files to md ( #155369 )
...
Fixes #155021
Fixes #155158
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155369
Approved by: https://github.com/svekars , https://github.com/malfet
2025-06-11 23:00:52 +00:00
loganthomas
458cc7213b
DOC: Convert to markdown: mobile_optimizer.rst, model_zoo.rst, module_tracker.rst, monitor.rst, mps_environment_variables.rst ( #155702 )
...
Fixes #155026
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155702
Approved by: https://github.com/sekyondaMeta , https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-11 22:16:04 +00:00
Justin Silver
b7a73a2cdb
Convert to markdown: export.programming_model.rst ( #155659 )
...
Converts only export.programming_model.rst to markdown
Used [rst2myst tool](https://rst-to-myst.readthedocs.io/en/latest/ )
Fixes #155020 , but split into a second PR to pass sanity check
Docs comparison (check out the 'new' whenever docs build)
1. export.programming_model ([old](https://docs.pytorch.org/docs/main/export.programming_model.html ) vs. [new](https://docs-preview.pytorch.org/pytorch/pytorch/155659/export.programming_model.html ))
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155659
Approved by: https://github.com/sekyondaMeta
2025-06-11 20:23:46 +00:00
Kazuaki Ishizaki
2002e3a311
[Docs] Convert to markdown: torch.compiler_transformations.rst, torch.compiler.config.rst ( #155347 )
...
Part of changes #155040 (parent PR #155120 )
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155347
Approved by: https://github.com/svekars
2025-06-11 18:55:30 +00:00
Runtian (Rachel) Li
925fbfca27
Convert fx.rst to fx.md ( #155482 )
...
Part of changes #155023 (parent PR #155429 )
@pytorchbot label "topic: docs"
@pytorchbot label "topic: not user facing"
@pytorchbot label docathon-h1-2025
@pytorchbot label module: docs
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155482
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-11 18:46:35 +00:00
GdoongMathew
14f3639e09
Convert to .md: onnx_verification.rst, onnx.rst, package.rst, ( #155556 )
...
Fixes https://github.com/pytorch/pytorch/issues/155031
* [onnx_verification.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/onnx_verification.rst )
* [onnx.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/onnx.rst )
* [package.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/package.rst )
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155556
Approved by: https://github.com/AlannaBurke , https://github.com/sekyondaMeta
2025-06-10 21:40:40 +00:00
nirajkamalk
ae0f1f8984
Convert to markdown onnx rst ( #155228 )
...
Fixes #155030
Converts the following files to MyST markdown and ensure that the doc tests are green:
- [x] [onnx_dynamo_onnxruntime_backend.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/onnx_dynamo_onnxruntime_backend.rst )
- [x] [onnx_dynamo.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/onnx_dynamo.rst )
- [x] [onnx_ops.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/onnx_ops.rst )
- [onnx_torchscript_supported_aten_ops.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/onnx_torchscript_supported_aten_ops.rst ) - not changed as it is autogenerated
- [onnx_torchscript.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/onnx_torchscript.rst ) - fixed in #155390
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155228
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-10 21:33:07 +00:00
Alberto A. Gallegos
8a396c5635
DOC: Convert to markdown: torch.compiler_best_practices_for_backends.rst, torch.compiler_cudagraph_trees.rst, torch.compiler_custom_backends.rst, torch.compiler_dynamic_shapes.rst, torch.compiler_dynamo_deepdive.rst ( #155137 )
...
Fixes #155037
[torch.compiler_best_practices_for_backends.rst](https://github.com/pytorch/pytorch/tree/main/docs/source/torch.compiler_best_practices_for_backends.rst ) shows error 404
cc @svekars @sekyondaMeta @AlannaBurke
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155137
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-10 20:51:05 +00:00
jafraustro
01b8f5e685
Convert to markdown: testing.rst, threading_environment_variables.rst, torch_cuda_memory.rst, torch_environment_variables.rst, torch_nccl_environment_variables.rst ( #155523 )
...
Fixes #155035
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155523
Approved by: https://github.com/AlannaBurke , https://github.com/svekars
2025-06-10 20:38:36 +00:00
Kazuaki Ishizaki
08d15d3ec1
[Docs] Convert to markdown: torch.compiler_troubleshooting.rst ( #155514 )
...
Part of changes #155040 (parent PR #155120 )
Follow-up of #155351 . I split the changes of `torch.compiler_troubleshooting.rst ` into #155351 and this PR due to the 2000-line limit in one PR.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155514
Approved by: https://github.com/svekars
2025-06-10 15:41:31 +00:00
Vivek Nayak
75f258dd1f
Fix spelling mistake ( #155495 )
...
Summary: Change "primtivies" to "primitives".
Test Plan:
n/a
Rollback Plan:
Differential Revision: D76229938
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155495
Approved by: https://github.com/angelayi , https://github.com/cyyever
2025-06-10 09:06:58 +00:00
Sahdev Zala
f34335bf33
Convert compiler rst files to markdown ( #155335 )
...
Convert following compiler rst files to md file.
torch.compiler_inductor_profiling.rst
torch.compiler_ir.rst
torch.compiler_nn_module.rst
torch.compiler_performance_dashboard.rst
torch.compiler_profiling_torch_compile.rst
Fixes #155039
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155335
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-10 01:12:11 +00:00
Kazuaki Ishizaki
5df3bf13ec
[Docs] Convert to markdown: torch.compiler_troubleshooting.rst ( #155351 )
...
Part of changes #155040 (parent PR #155120 )
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155351
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-09 23:18:31 +00:00
Qasim Khan
82e6475d92
Add doc for missing functions for torch.special module ( #155074 )
...
Fixes #132178
Added all the missing functions that had a docstring but were not present in the documentation
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155074
Approved by: https://github.com/albanD
2025-06-09 22:28:26 +00:00
Parag Ekbote
2908c10259
Document the default garbage_collection_threshold value and improve the organization of cuda docs ( #155341 )
...
Fixes #150917
As mentioned in the issue, I've updated the documentation of `garbage_collection_threshold`and improved the organization.
Could you please review?
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155341
Approved by: https://github.com/AlannaBurke , https://github.com/ngimel
2025-06-08 22:09:35 +00:00
Abhinav Tharamel
d41f62b7a0
Fix/issue #155027 ( #155252 )
...
Fixes #155027
Converted RST files to Markdown
Pull Request resolved: https://github.com/pytorch/pytorch/pull/155252
Approved by: https://github.com/svekars
Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
2025-06-08 21:17:31 +00:00