Patched docs for torch_compile_tutorial #2936

ignaciobartol · 2024-06-16T17:35:10Z

Description

Based on the discussion on #2858 I added a few examples on how to use torch.compile in nested modules and functions. Also, I added a few lines for "Best practices" to debug if there is a compilation problem and also how to disable a function from being compiled (along with its children functions) using torch.compiler.disable.

Let me know if anything can be improved in the tutorial and I will work on it. As a side note, from this issue in pytorch, I am not sure if torch.compiler.disable is working properly, but I used as specified as in the docs here

Checklist

The issue that is being fixed is referred in the description (see above "Fixes #ISSUE_NUMBER")
Only one issue is addressed in this pull request
Labels from the issue that this PR is fixing are added to this pull request
No unnecessary issues are included into this pull request.

cc @williamwen42 @msaroufim @sekyondaMeta @svekars @kit1980 @brycebortree

pytorch-bot · 2024-06-16T17:35:13Z

🔗 Helpful Links

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

📄 Preview Python docs built from this PR

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

✅ No Failures

As of commit f36b152 with merge base e07d43b ():
💚 Looks good so far! There are no failures yet. 💚

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

williamwen42

I think this doc update would be better placed in the troubleshooting tutorial (@mlazos is working on this and will have an update soon).

intermediate_source/torch_compile_tutorial.py

williamwen42 · 2024-06-17T18:41:19Z

intermediate_source/torch_compile_tutorial.py

+# 
+# This includes:
+#
+# - **Nested function calls:** All functions called within the decorated or compiled function will also be compiled.


There isn't really too much of a difference in the nested call behavior between torch.compile'd functions and torch.compile'd modules, so I don't think we need to highlight them as distinct cases.

intermediate_source/torch_compile_tutorial.py

williamwen42 · 2024-06-17T20:13:52Z

intermediate_source/torch_compile_tutorial.py

+#
+# Behavior of ``torch.compile`` with Nested Modules and Function Calls
+#
+# When you use ``torch.compile``, the compiler will try to recursively inline


Don't have to mention inlining - going over how dynamo inlines is a little more involved.

williamwen42 · 2024-06-17T20:14:50Z

intermediate_source/torch_compile_tutorial.py

+# Behavior of ``torch.compile`` with Nested Modules and Function Calls
+#
+# When you use ``torch.compile``, the compiler will try to recursively inline
+# and compile every function call inside the target function or module.


"every function call" is not exactly right - there is a skiplist of various functions (e.g. builtins, some functions in the torch.* namespace).

Thanks, so I will modify the wording adding your comment to something like "compile every function call inside the target function or module that is not in a skiplist (e.g. builtins, some functions in the torch.* namespace)."

ignaciobartol · 2024-06-17T20:53:54Z

I think this doc update would be better placed in the troubleshooting tutorial (@mlazos is working on this and will have an update soon).

Thanks @williamwen42 for the review and the great feedback! I will work on them. Once I have an update on which doc to contribute I will create a new commit.

ignaciobartol · 2024-06-24T12:11:43Z

@pytorchbot rebase

pytorch-bot · 2024-06-24T12:11:46Z

You don't have permissions to rebase this PR since you are a first time contributor. If you think this is a mistake, please contact PyTorch Dev Infra.

williamwen42

Content looks good, but can you fix any formatting issues that you see in the doc preview?

Also waiting for response from @mlazos to see where this change should go

mlazos · 2024-06-25T01:25:07Z

Thanks @ignaciobartol, this looks like a good tutorial! I think we should add a section called "Best Practices for Onboarding a New Model" to https://pytorch.org/docs/stable/torch.compiler_troubleshooting.html and add your best practices section to that. You can also link to it from your tutorial as well. The rest of the troubleshooting doc is a bit outdated and I'll be revamping that next week.

ignaciobartol · 2024-06-25T06:20:44Z

Content looks good, but can you fix any formatting issues that you see in the doc preview?

Also waiting for response from @mlazos to see where this change should go

Thanks! I am not sure what I am seeing in my build of the docs differs from what is on the preview (See screenshot below). Any ideas of why this may be happening?

intermediate_source/torch_compile_tutorial.py

Small formatting fixes

intermediate_source/torch_compile_tutorial.py

svekars · 2024-06-25T22:36:19Z

From publishing perspective the PR looks good to me. @mlazos - did you mean that this should be moved to torch.compiler troubleshooting instead of being here?

ignaciobartol · 2024-06-28T05:52:38Z

From publishing perspective the PR looks good to me. @mlazos - did you mean that this should be moved to torch.compiler troubleshooting instead of being here?

Thanks @svekars for fixing the formatting errors. Once we have more information about this I can ago ahead and apply those changes

mlazos · 2024-08-20T14:27:34Z

From publishing perspective the PR looks good to me. @mlazos - did you mean that this should be moved to torch.compiler troubleshooting instead of being here?

Correct, it was just a suggestion, I'm okay either way.

* Patched docs for torch_compile_tutorial --------- Co-authored-by: Svetlana Karslioglu <svekars@meta.com>

Patched docs for torch_compile_tutorial

204f9fc

facebook-github-bot added the cla signed label Jun 16, 2024

github-actions bot added docathon-h1-2024 medium tiraged labels Jun 16, 2024

svekars requested review from williamwen42, msaroufim and jerryzh168 June 17, 2024 15:06

svekars added the torch.compile Torch compile and other relevant tutorials label Jun 17, 2024

williamwen42 requested changes Jun 17, 2024

View reviewed changes

ignaciobartol force-pushed the torch-compile branch from 1858ca6 to 204f9fc Compare June 24, 2024 11:48

ignaciobartol force-pushed the torch-compile branch 2 times, most recently from 8aec180 to 204f9fc Compare June 24, 2024 12:33

Reviewed docs for torch_compile_tutorial

e580c60

ignaciobartol requested a review from williamwen42 June 24, 2024 12:37

williamwen42 requested changes Jun 24, 2024

View reviewed changes

svekars reviewed Jun 25, 2024

View reviewed changes

svekars added 2 commits June 25, 2024 13:20

Apply suggestions from code review

8251141

Small formatting fixes

Merge branch 'main' into torch-compile

f4bb0fd

svekars reviewed Jun 25, 2024

View reviewed changes

intermediate_source/torch_compile_tutorial.py Outdated Show resolved Hide resolved

intermediate_source/torch_compile_tutorial.py Outdated Show resolved Hide resolved

svekars added 2 commits June 25, 2024 13:24

Fix spellcheck

a5d38cf

Merge branch 'main' into torch-compile

288748f

Merge branch 'main' into torch-compile

02c90d7

svekars requested a review from williamwen42 August 20, 2024 15:08

williamwen42 approved these changes Aug 20, 2024

View reviewed changes

svekars added 2 commits August 20, 2024 08:15

Merge branch 'main' into torch-compile

fefbe1f

Merge branch 'main' into torch-compile

f36b152

svekars merged commit 748e52b into pytorch:main Aug 30, 2024
17 checks passed

c-p-i-o pushed a commit that referenced this pull request Sep 6, 2024

Patched docs for torch_compile_tutorial (#2936)

64d30af

* Patched docs for torch_compile_tutorial --------- Co-authored-by: Svetlana Karslioglu <svekars@meta.com>

c-p-i-o pushed a commit that referenced this pull request Sep 6, 2024

Patched docs for torch_compile_tutorial (#2936)

f45ddc2

* Patched docs for torch_compile_tutorial --------- Co-authored-by: Svetlana Karslioglu <svekars@meta.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Patched docs for torch_compile_tutorial #2936

Patched docs for torch_compile_tutorial #2936

ignaciobartol commented Jun 16, 2024 •

edited by pytorch-bot bot

Loading

pytorch-bot bot commented Jun 16, 2024 •

edited

Loading

williamwen42 left a comment

williamwen42 Jun 17, 2024

williamwen42 Jun 17, 2024

williamwen42 Jun 17, 2024

ignaciobartol Jun 17, 2024

ignaciobartol commented Jun 17, 2024

ignaciobartol commented Jun 24, 2024

pytorch-bot bot commented Jun 24, 2024

williamwen42 left a comment

mlazos commented Jun 25, 2024 •

edited

Loading

ignaciobartol commented Jun 25, 2024

svekars commented Jun 25, 2024

ignaciobartol commented Jun 28, 2024

mlazos commented Aug 20, 2024

Patched docs for torch_compile_tutorial #2936

Patched docs for torch_compile_tutorial #2936

Conversation

ignaciobartol commented Jun 16, 2024 • edited by pytorch-bot bot Loading

Description

Checklist

pytorch-bot bot commented Jun 16, 2024 • edited Loading

🔗 Helpful Links

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

✅ No Failures

williamwen42 left a comment

Choose a reason for hiding this comment

williamwen42 Jun 17, 2024

Choose a reason for hiding this comment

williamwen42 Jun 17, 2024

Choose a reason for hiding this comment

williamwen42 Jun 17, 2024

Choose a reason for hiding this comment

ignaciobartol Jun 17, 2024

Choose a reason for hiding this comment

ignaciobartol commented Jun 17, 2024

ignaciobartol commented Jun 24, 2024

pytorch-bot bot commented Jun 24, 2024

williamwen42 left a comment

Choose a reason for hiding this comment

mlazos commented Jun 25, 2024 • edited Loading

ignaciobartol commented Jun 25, 2024

svekars commented Jun 25, 2024

ignaciobartol commented Jun 28, 2024

mlazos commented Aug 20, 2024

ignaciobartol commented Jun 16, 2024 •

edited by pytorch-bot bot

Loading

pytorch-bot bot commented Jun 16, 2024 •

edited

Loading

mlazos commented Jun 25, 2024 •

edited

Loading