[Docs] Convert to markdown: torch.compiler_transformations.rst, torch.compiler_troubleshooting_old.rst, torch.compiler_troubleshooting.rst, torch.compiler.config.rst, torch.compiler.rst #155120

kiszk · 2025-06-04T14:47:56Z

Fixes #155040

cc @svekars @sekyondaMeta @AlannaBurke

pytorch-bot · 2025-06-04T14:48:01Z

🔗 Helpful Links

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

📄 Preview Python docs built from this PR
📄 Preview C++ docs built from this PR
❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

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

❌ 28 New Failures, 6 Cancelled Jobs, 4 Unrelated Failures

As of commit 27df1a9 with merge base ca0c298 ():

NEW FAILURES - The following jobs have failed:

Lint / pr-sanity-checks (gh)
Process completed with exit code 1.
pull / linux-jammy-cuda12.6-py3.10-gcc11 / test (default, 1, 5, linux.4xlarge.nvidia.gpu) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-cuda12.6-py3.10-gcc11 / test (default, 2, 5, linux.4xlarge.nvidia.gpu) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-cuda12.6-py3.10-gcc11 / test (default, 3, 5, linux.4xlarge.nvidia.gpu) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-cuda12.6-py3.10-gcc11 / test (default, 4, 5, linux.4xlarge.nvidia.gpu) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-cuda12.6-py3.10-gcc11 / test (default, 5, 5, linux.4xlarge.nvidia.gpu) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-cuda12.6-py3.10-gcc11-build-distributed / build (gh)
pull / linux-jammy-cuda12.6-py3.10-gcc11-sm89 / build (gh)
pull / linux-jammy-py3.13-clang12 / test (crossref, 1, 2, linux.2xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.13-clang12 / test (default, 1, 5, linux.4xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.13-clang12 / test (default, 2, 5, linux.4xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.13-clang12 / test (default, 3, 5, linux.4xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.13-clang12 / test (default, 4, 5, linux.4xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.13-clang12 / test (default, 5, 5, linux.4xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.13-clang12 / test (dynamo_wrapped, 1, 3, linux.2xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.13-clang12 / test (dynamo_wrapped, 2, 3, linux.2xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12 / test (crossref, 1, 2, linux.2xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12 / test (crossref, 2, 2, linux.2xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12 / test (default, 1, 5, linux.4xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12 / test (default, 2, 5, linux.4xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12 / test (default, 3, 5, linux.4xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12 / test (default, 4, 5, linux.4xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12 / test (default, 5, 5, linux.4xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12 / test (dynamo_wrapped, 1, 3, linux.2xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12 / test (dynamo_wrapped, 2, 3, linux.2xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12 / test (dynamo_wrapped, 3, 3, linux.2xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12-onnx / test (default, 1, 2, linux.2xlarge) (gh)
Final attempt failed. Child_process exited with error code 1
pull / linux-jammy-py3.9-clang12-onnx / test (default, 2, 2, linux.2xlarge) (gh)
Final attempt failed. Child_process exited with error code 1

CANCELLED JOBS - The following jobs were cancelled. Please retry:

Lint / Link checks / lint-urls / linux-job (gh)
##[error]The operation was canceled.
Lint / Link checks / lint-xrefs / linux-job (gh)
##[error]The operation was canceled.
Lint / quick-checks / linux-job (gh)
##[error]The operation was canceled.
Lint / Test tools / linux-job (gh)
##[error]The operation was canceled.
Lint / toc / linux-job (gh)
##[error]The operation was canceled.
Lint / workflow-checks / linux-job (gh)
##[error]The operation was canceled.

FLAKY - The following jobs failed but were likely due to flakiness present on trunk:

pull / linux-jammy-py3.13-clang12 / test (crossref, 2, 2, linux.2xlarge) (gh) (matched linux rule in flaky-rules.json)
The runner has received a shutdown signal. This can happen when the runner service is stopped, or a manually started runner is canceled.
pull / linux-jammy-py3.13-clang12 / test (dynamo_wrapped, 3, 3, linux.2xlarge) (gh) (matched linux rule in flaky-rules.json)
The runner has received a shutdown signal. This can happen when the runner service is stopped, or a manually started runner is canceled.

UNSTABLE - The following jobs are marked as unstable, possibly due to flakiness on trunk:

pull / linux-jammy-py3-clang12-executorch / build (gh) (#150261)
Final attempt failed. Child_process exited with error code 1
pull / unstable-linux-jammy-cuda12.6-py3.10-gcc11-sm89-xfail / build (gh)

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

svekars · 2025-06-04T16:18:21Z

Please only have .rst -> .md files that were converted using git mv. I see there are some files that were deleted and added.

I'm not a reviewer for the docathon.

kiszk · 2025-06-05T01:23:23Z

@svekars The first commit only renamed .rst to .md files. Then, the second commit only updates .md files. So, I did not delete or add any files.
However, GitHub finally recognizes some of them as a combination of add and delete. I see the same behavior in other PRs like #155104 and #155198. Do you have any suggestions to handle it as expected?

kiszk · 2025-06-05T05:30:14Z

@svekars I realized GitHub WebUI cannot follow the history with git mv if the number of lines with differences is big.
In this PR, we still keep histories. We can see them by executing git log --follow --oneline -- .... Does it make sense?

$ git log --follow --oneline -- docs/source/torch.compiler_transformations.md
8a7d34ab4f convert to MyST markdown format
d9b56e6b09 rename rst files to md files
aa3629ee3e Fix typo under docs directory (#110359)
4d3ea5df65 Restructure torch.compile docs (#105376)
8eb82135d1 [docs] Docs for writing ATen IR passes + FX Pattern matching (#100577)
$ 
$ git log --follow --oneline -- docs/source/torch.compiler_troubleshooting.md
8a7d34ab4f convert to MyST markdown format
d9b56e6b09 rename rst files to md files
dc55704b48 Rename cache limit to recompile limit in configs (#143709)
be172d2a60 [pt2, docs] Add new PT2 troubleshooting doc (#138620)
22e19bd2d7 Add link to torch.compile the missing manual in troubleshooting (#137301)
32f45f01a9 [dynamo] Retire CompileProfiler (#135133)
79655a1321 Add force_disable_caches to the docs (#126184)
b27ee6548d Add a Dynamo deepdive to documentation (#122305)
a8b7480f0d fix dynamo.explain examples (#122745)
17175cdbc7 [Docs] Add extended debugging options for troubleshooting (#122028)
abe3c55a6a Update DDP dynamo debug docs (#118295)
d37c4c6995 Update `torch.compiler_troubleshooting.rst` (#114530)
35b2b3ee47 Fix rst formatting in torch.compiler_troubleshooting.rst (#107360)
c913f3857f Remove dynamo+nvfuser (#105789)
891bb259f8 Revert "Remove dynamo+nvfuser (#105789)"
6030151d37 Remove dynamo+nvfuser (#105789)
4eeda6616c Correct URL Link for torchDynamo (#105903)
4d3ea5df65 Restructure torch.compile docs (#105376)
edebdaf182 Change _dynamo.explain to be explain(f)(*args, **kwargs) (#106066)
15c67ca95c Update troubleshooting.rst (#105018)
28f43c767c Fix outdated log settings in doc (#102285) (#102286)
0d17bd5fa4 DOC Fixes unpacking issue in dynamo explain docs (#101761)
a12b640dc9 Fix typos in troubleshooting.rst (#101305)
8994d9e610 [dynamo] Hide guard_fail_hook behind a flag to improve cache lookup time (+10% DebertaV2) (#100590)
d425da8bf3 Replace master with main in links and docs/conf.py (#100176)
6110effa86 Rework torch.compile docs (#96706)
f03db8d6cb [reland2][inductor] Add an AOT compilation mode for Inductor CPP backend (#96520)
184fb9f11d Small doc update for torch_compile_debug (#95809)
e9c70b0b20 Fix typo and grammatical errors in community docs and dynamo docs (#95692)
8d45f555d7 [BE] [1/3] Rewrite `super()` calls in caffe2 and benchmarks (#94587)
c7b03010ec Split the aot/dynamo TORCHDYNAMO_REPRO_AFTER cases (#93226)
d40a4540d6 Fix typo under docs directory (#92762)
a2b8e891f6 Fix/modernize dynamo docs (#92572)
4f91b8e0ee Fix typo under docs directory  (#91871)
e9cd7e0869 [dynamo] Fix rst syntax for list (#90390)
a188e6ddc0 Fix typo in troubleshooting.rst (#91301)
548960f68e Replace TORCHINDUCTOR_TRACE with TORCH_COMPILE_DEBUG in documentation (#91011)
015b05af18 Editorial pass on Dyamo docs (#89921)
9048cf16fe Move Dynamo docs back to core (#89769)
47cca5e444 Revert "Move Dynamo docs back to core (#89769)"
be2816db18 Move Dynamo docs back to core (#89769)
$ 
$ git log --follow --oneline -- docs/source/torch.compiler_troubleshooting_old.md
e652a7f4b0 (HEAD -> issue155040, origin/issue155040) fix failure by lint-xrefs
8a7d34ab4f convert to MyST markdown format
d9b56e6b09 rename rst files to md files
e2f9759bd0 Fix broken URLs (#152237)
dc55704b48 Rename cache limit to recompile limit in configs (#143709)
be172d2a60 [pt2, docs] Add new PT2 troubleshooting doc (#138620)
22e19bd2d7 Add link to torch.compile the missing manual in troubleshooting (#137301)
32f45f01a9 [dynamo] Retire CompileProfiler (#135133)
79655a1321 Add force_disable_caches to the docs (#126184)
b27ee6548d Add a Dynamo deepdive to documentation (#122305)
a8b7480f0d fix dynamo.explain examples (#122745)
17175cdbc7 [Docs] Add extended debugging options for troubleshooting (#122028)
abe3c55a6a Update DDP dynamo debug docs (#118295)
d37c4c6995 Update `torch.compiler_troubleshooting.rst` (#114530)
35b2b3ee47 Fix rst formatting in torch.compiler_troubleshooting.rst (#107360)
c913f3857f Remove dynamo+nvfuser (#105789)
891bb259f8 Revert "Remove dynamo+nvfuser (#105789)"
6030151d37 Remove dynamo+nvfuser (#105789)
4eeda6616c Correct URL Link for torchDynamo (#105903)
4d3ea5df65 Restructure torch.compile docs (#105376)
edebdaf182 Change _dynamo.explain to be explain(f)(*args, **kwargs) (#106066)
15c67ca95c Update troubleshooting.rst (#105018)
28f43c767c Fix outdated log settings in doc (#102285) (#102286)
0d17bd5fa4 DOC Fixes unpacking issue in dynamo explain docs (#101761)
a12b640dc9 Fix typos in troubleshooting.rst (#101305)
8994d9e610 [dynamo] Hide guard_fail_hook behind a flag to improve cache lookup time (+10% DebertaV2) (#100590)
d425da8bf3 Replace master with main in links and docs/conf.py (#100176)
6110effa86 Rework torch.compile docs (#96706)
f03db8d6cb [reland2][inductor] Add an AOT compilation mode for Inductor CPP backend (#96520)
184fb9f11d Small doc update for torch_compile_debug (#95809)
e9c70b0b20 Fix typo and grammatical errors in community docs and dynamo docs (#95692)
8d45f555d7 [BE] [1/3] Rewrite `super()` calls in caffe2 and benchmarks (#94587)
c7b03010ec Split the aot/dynamo TORCHDYNAMO_REPRO_AFTER cases (#93226)
d40a4540d6 Fix typo under docs directory (#92762)
a2b8e891f6 Fix/modernize dynamo docs (#92572)
4f91b8e0ee Fix typo under docs directory  (#91871)
e9cd7e0869 [dynamo] Fix rst syntax for list (#90390)
a188e6ddc0 Fix typo in troubleshooting.rst (#91301)
548960f68e Replace TORCHINDUCTOR_TRACE with TORCH_COMPILE_DEBUG in documentation (#91011)
015b05af18 Editorial pass on Dyamo docs (#89921)
9048cf16fe Move Dynamo docs back to core (#89769)
47cca5e444 Revert "Move Dynamo docs back to core (#89769)"
be2816db18 Move Dynamo docs back to core (#89769)

kiszk · 2025-06-05T05:52:53Z

@svekars I also found an issue in this failure of the lint process.
According to the log file, this failure occurs due to a large number of changes ( > 2000 lines) in a PR. The current script recognized them as 4569 lines for my PR.

I have two possible suggestions.

To add -M option to git diff: this issue occurs since git diff --stat=10000 cannot recognize file renaming by git mv. My suggestion is to add -M option like git diff --stat=10000-M20%.
Alleviate the limit of lines for docs directory.

cc @albanD

Part of the log file.

...
2025-06-04T16:19:44.1178029Z INFO: Checking aginst the following stats
2025-06-04T16:19:44.1187307Z + git diff --stat=10000 ca0c2985d3b29c062b567b4cddfd405a43e9c95a e652a7f4b0f0cdfcb1511ce063ee57bb28789815
2025-06-04T16:19:44.1192532Z + sed '$d'
2025-06-04T16:19:44.1667580Z INFO: Showing non-generated files:
2025-06-04T16:19:44.1669883Z + cat /tmp/tmp.7A9MjaOyF0
2025-06-04T16:19:44.1677366Z  docs/source/{torch.compiler.config.rst => torch.compiler.config.md} |    9 +++++++--
2025-06-04T16:19:44.1679127Z  docs/source/{torch.compiler.rst => torch.compiler.md}               |   58 +++++++++++++++++++++++++++++++++-------------------------
2025-06-04T16:19:44.1682281Z  docs/source/torch.compiler_transformations.md                       |  424 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2025-06-04T16:19:44.1687388Z  docs/source/torch.compiler_transformations.rst                      |  436 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2025-06-04T16:19:44.1694638Z  docs/source/torch.compiler_troubleshooting.md                       | 1085 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2025-06-04T16:19:44.1708115Z  docs/source/torch.compiler_troubleshooting.rst                      | 1113 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2025-06-04T16:19:44.1718643Z  docs/source/torch.compiler_troubleshooting_old.md                   |  715 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2025-06-04T16:19:44.1726240Z  docs/source/torch.compiler_troubleshooting_old.rst                  |  727 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2025-06-04T16:19:44.1857760Z INFO: PR SIZE is 4500
2025-06-04T16:19:44.1858347Z 
2025-06-04T16:19:44.1859141Z Your PR is 4500 LOC which is more than the 2000 maximum
2025-06-04T16:19:44.1860153Z allowed within PyTorch infra. PLease make sure to split up
2025-06-04T16:19:44.1861221Z your PR into smaller pieces that can be reviewed.
2025-06-04T16:19:44.1862123Z If you think that this rule should not apply to your PR,
2025-06-04T16:19:44.1862858Z please contact @albanD or @seemethere.
...

Current: 2264+2303 lines

$ git diff --stat=10000 main
 docs/source/{torch.compiler.config.rst => torch.compiler.config.md} |    9 +++++++--
 docs/source/{torch.compiler.rst => torch.compiler.md}               |   58 +++++++++++++++++++++++++++++++++-------------------------
 docs/source/torch.compiler_transformations.md                       |  424 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/source/torch.compiler_transformations.rst                      |  436 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 docs/source/torch.compiler_troubleshooting.md                       | 1085 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/source/torch.compiler_troubleshooting.rst                      | 1113 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 docs/source/torch.compiler_troubleshooting_old.md                   |  715 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/source/torch.compiler_troubleshooting_old.rst                  |  727 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 8 files changed, 2264 insertions(+), 2303 deletions(-)

Proposed: 1381+1420 lines

 docs/source/{torch.compiler.config.rst => torch.compiler.config.md}                           |    9 +++++++--
 docs/source/{torch.compiler.rst => torch.compiler.md}                                         |   58 +++++++++++++++++++++++++++++++++-------------------------
 docs/source/{torch.compiler_transformations.rst => torch.compiler_transformations.md}         |  544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 docs/source/{torch.compiler_troubleshooting.rst => torch.compiler_troubleshooting.md}         | 1420 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 docs/source/{torch.compiler_troubleshooting_old.rst => torch.compiler_troubleshooting_old.md} |  770 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 5 files changed, 1381 insertions(+), 1420 deletions(-)

zxiiro · 2025-06-05T11:53:09Z

@svekars I realized GitHub WebUI cannot follow the history with git mv if the number of lines with differences is big. In this PR, we still keep histories. We can see them by executing git log --follow --oneline -- .... Does it make sense?

That's right. Git doesn't actually store the history of files in its database. Every commit actually stores the entire current state of the workspace. Git then compares the state of the current commit against its parent commit to determine what was changed when it shows you a diff between 2 commits (this is also why you can compare 2 completely random commits in a git log and don't have to compare them in order). When you rename a file Git treats the new filename and old filename as different files referencing the same blob object in the git database.

For very small files where we have to convert rst to md formatting, if more than 50% of the lines are changed then GitHub's WebUI will show it as a deleted and new file because git doesn't detect enough similar lines between the 2 blob objects so is not able to map them as similar objects anymore and since its not tracking history of filename changes its not able to tell its the same file. On the commandline we can adjust the threshold by using -M50% in my testing you can go as low as -M1% but it might still fail for very small files where most of the lines are changed.

I've found Scott Chacon's book very useful in explaining how commits are actually made and stored in the database https://schacon.github.io/gitbook/1_the_git_object_model.html which helps explain why this happens.

From Git's perspective whether or not you use "git mv" or just delete and add the file makes no difference if enough lines are similar git will detect that the file was renamed.

Edit:

You can test this like this.

# Create a new git repo
$ mkdir git-tree
$ cd git-tree
$ git init

# Create our first commit
$ echo "Hello World" > README.rst
$ git add README.rst
$ git commit -m "Add RST"
[master (root-commit) 2e5f2f7] Add RST

# Find our tree from commit
$ git cat-file commit 2e5f2f7
tree 21597b4f5dd3b5304a2218ce9278d7b817c5c5be

# Print the tree
$ git cat-file -p 21597b4f5dd3b5304a2218ce9278d7b817c5c5be
100644 blob 557db03de997c86a4a028e1ebd3a1ceb225be238	README.rst

# print the blob
$ git cat-file -p 557db03de997c86a4a028e1ebd3a1ceb225be238
Hello World

# List the git database // You can see the blob and tree are in there 557db0... and 21597b4...
find .git/objects
.git/objects
.git/objects/pack
.git/objects/21
.git/objects/21/597b4f5dd3b5304a2218ce9278d7b817c5c5be
.git/objects/info
.git/objects/55
.git/objects/55/7db03de997c86a4a028e1ebd3a1ceb225be238
.git/objects/2e
.git/objects/2e/5f2f7f5093317e6976e2f671e08174d76efc0c

# Let's delete and the readme as README.md
$ git rm README.rst
$ echo "Hello World" > README.md
$ git add README.md

# Check what Git thinks happened. // Notice that it detects the rename here despite not using `git mv`
$ git status
On branch master
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	renamed:    README.rst -> README.md

# Commit it
$ git commit -m "README.md"

# Let's make a new file and see how Git shows it in the worktree.
$ echo "Hello World 2" > NEWFILE
$ git add NEWFILE
$ git commit -m "NEWFILE"
[master a9145f4] NEWFILE

# Let's find the tree hash
$ git cat-file commit a9145f4
tree 8e2ff7a197713d862346b690e1fa1063045821bc

# Let's check the tree // We can see from here that even though I didn't commit README.md again 
# in this commit it still shows up. This shows that git commits track the full state of the repo rather 
# than changes to the files.
$ git cat-file -p 8e2ff7a197713d862346b690e1fa1063045821bc
100644 blob 3ee384936466a484e0089c82ce559a10dc9c46ea	NEWFILE
100644 blob 557db03de997c86a4a028e1ebd3a1ceb225be238	README.md

Hope this helps explain what's happening here.

docs/source/torch.compiler.md

svekars

Try fixing broken targets like suggested to resolve the build errors.

docs/source/torch.compiler_troubleshooting_old.md

docs/source/torch.compiler_troubleshooting.md

docs/source/torch.compiler_troubleshooting_old.md

kiszk · 2025-06-05T19:57:40Z

@svekars Thank you for pointing them out. I addressed them and fixed the similar broken targets.

svekars

Two very minor issues - otherwise LGTM

docs/source/torch.compiler.md

docs/source/torch.compiler_transformations.md

kiszk · 2025-06-06T06:04:13Z

@svekars Thank you for fixing issues.
How do we address this problem at pr-sanity-checks in CI? The number of lines changed is more than 2000 lines. So, pr-sanity-checks always fails.

kiszk · 2025-06-06T16:51:40Z

@svekars Should I split this PR into multiple PRs to have fewer than 2000 lines of difference in each PR?

svekars · 2025-06-06T16:56:58Z

@kiszk yes, please split into a smaller PR and link here

kiszk · 2025-06-06T17:19:03Z

@svekars I may misunderstand. The file docs/source/torch.compiler_troubleshooting.rst will have more than 2000 (1085+1113) line diffs alone. Is it OK to change one file by using multiple PRs?

 docs/source/torch.compiler_troubleshooting.md                       | 1085 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/source/torch.compiler_troubleshooting.rst                      | 1113 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

kiszk · 2025-06-06T17:43:22Z

#155347
#155348

…orch.compiler.rst (#155348) Part of changes #155040 (parent PR #155120) Pull Request resolved: #155348 Approved by: https://github.com/svekars

AlannaBurke · 2025-06-09T19:53:15Z

You've got some conflicts here that need to be resolved manually.

Part of changes #155040 (parent PR #155120) Pull Request resolved: #155351 Approved by: https://github.com/svekars Co-authored-by: Svetlana Karslioglu <svekars@meta.com>

kiszk · 2025-06-10T00:57:56Z

This PR is not used for updating rst files now. This is just a parent PR for the four child PRs.
Should I remove all of changes from this PR? cc @svekars

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: #155514 Approved by: https://github.com/svekars

svekars · 2025-06-10T18:03:55Z

closing this as this is handled through other PRs.

….compiler.config.rst (#155347) Part of changes #155040 (parent PR #155120) Pull Request resolved: #155347 Approved by: https://github.com/svekars

kiszk added 2 commits June 4, 2025 09:39

rename rst files to md files

d9b56e6

convert to MyST markdown format

8a7d34a

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 4, 2025

sekyondaMeta added the topic: not user facing topic category label Jun 4, 2025

pytorchbot added the open source label Jun 4, 2025

zxiiro previously approved these changes Jun 4, 2025

View reviewed changes

fix failure by lint-xrefs

e652a7f

zxiiro requested review from zxiiro and removed request for zxiiro June 4, 2025 16:28

svekars reviewed Jun 5, 2025

View reviewed changes

docs/source/torch.compiler.md Outdated Show resolved Hide resolved

svekars reviewed Jun 5, 2025

View reviewed changes

fix broken targets

7f2df34

svekars reviewed Jun 6, 2025

View reviewed changes

docs/source/torch.compiler.md Outdated Show resolved Hide resolved

docs/source/torch.compiler_transformations.md Outdated Show resolved Hide resolved

Update docs/source/torch.compiler.md

a10c208

Update docs/source/torch.compiler_transformations.md

27df1a9

kiszk mentioned this pull request Jun 10, 2025

[Docs] Convert to markdown: torch.compiler_troubleshooting.rst #155514

Closed

svekars closed this Jun 10, 2025

j-silv mentioned this pull request Jun 11, 2025

Fix #155022 rst to markdown conversion #155540

Closed

[Docs] Convert to markdown: torch.compiler_transformations.rst, torch.compiler_troubleshooting_old.rst, torch.compiler_troubleshooting.rst, torch.compiler.config.rst, torch.compiler.rst #155120

[Docs] Convert to markdown: torch.compiler_transformations.rst, torch.compiler_troubleshooting_old.rst, torch.compiler_troubleshooting.rst, torch.compiler.config.rst, torch.compiler.rst #155120

Uh oh!

Conversation

kiszk commented Jun 4, 2025 • edited by pytorch-bot bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

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

❌ 28 New Failures, 6 Cancelled Jobs, 4 Unrelated Failures

Uh oh!

svekars commented Jun 4, 2025

Uh oh!

kiszk commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kiszk commented Jun 5, 2025

Uh oh!

kiszk commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zxiiro commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

svekars left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kiszk commented Jun 5, 2025

Uh oh!

svekars left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kiszk commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kiszk commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

svekars commented Jun 6, 2025

Uh oh!

kiszk commented Jun 6, 2025

Uh oh!

kiszk commented Jun 6, 2025

Uh oh!

AlannaBurke commented Jun 9, 2025

Uh oh!

kiszk commented Jun 10, 2025

Uh oh!

svekars commented Jun 10, 2025

Uh oh!

Uh oh!

kiszk commented Jun 4, 2025 •

edited by pytorch-bot bot

Loading

pytorch-bot bot commented Jun 4, 2025 •

edited

Loading

kiszk commented Jun 5, 2025 •

edited

Loading

kiszk commented Jun 5, 2025 •

edited

Loading

zxiiro commented Jun 5, 2025 •

edited

Loading

kiszk commented Jun 6, 2025 •

edited

Loading

kiszk commented Jun 6, 2025 •

edited

Loading