Skip to content
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.

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

Add a tutorial for PyTorch Flight recorder #3024

Closed
wants to merge 31 commits into from
Closed

Conversation

c-p-i-o
Copy link
Contributor

@c-p-i-o c-p-i-o commented Sep 3, 2024

Add a tutorial for PyTorch Flight Recorder

Description

We are announcing PyTorch flight recorder as a prototype feature in PyTorch 2.5. Add a small tutorial on how to configure and use flight recorder.

Checklist

  • [x ] The issue that is being fixed is referred in the description (see above "Fixes #ISSUE_NUMBER")
  • [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
  • No unnecessary issues are included into this pull request.

c-p-i-o and others added 4 commits August 20, 2024 11:53
Summary:
Add a tutorial file for flight recorder.

Test Plan:
N/A

Reviewers:

Subscribers:

Tasks:

Tags:
Add dump example and command line.
Summary:
Update tutorial

Test Plan:

Reviewers:

Subscribers:

Tasks:

Tags:
@c-p-i-o c-p-i-o self-assigned this Sep 3, 2024
Copy link

pytorch-bot bot commented Sep 3, 2024

🔗 Helpful Links

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

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

❌ 1 New Failure

As of commit 44493fb with merge base a811de6 (image):

NEW FAILURE - The following job has failed:

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

@svekars svekars added the 2.5 PR related to version 2.5 label Sep 3, 2024
Copy link
Contributor

@fduwjj fduwjj left a comment

Choose a reason for hiding this comment

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

yeah! Finally we have the tutorial for our users.

@tstatler tstatler requested review from tstatler and removed request for tstatler September 3, 2024 20:25
Summary:
Add missing sections from the template and clarify some notes further in the tutorial.
Summary:
add missing "what you will learn" section.
Summary:
fix a typo.
Copy link
Contributor

@fduwjj fduwjj left a comment

Choose a reason for hiding this comment

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

LGTM

Summary:
1. Add flight recorder to README.txt.
2. Add a pre-requisite.
Summary:
Add flight recorder to index file.
@fduwjj
Copy link
Contributor

fduwjj commented Sep 4, 2024

Thanks for updating the weblink, by looking at preview, link: https://docs-preview.pytorch.org/pytorch/tutorials/3024/prototype/flight_recorder_tutorial.html there are things I noticed:

  1. The link to github for authors do not work as expected.
  2. The indentation looks wired:
image 3. Shall we give the environment variables a grey highlight like what we did in https://pytorch.org/docs/stable/distributed.html? image 4. There are unexpected lines in the json files as well: image

Since you are the UI expert here, you know how to fix better than me. I just want to bring the awareness to you. Once we are happy with the actual preview, I think we can merge it.

Copy link
Contributor

@svekars svekars left a comment

Choose a reason for hiding this comment

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

An editorial pass and some formatting fixes. Let me know if you have any questions.

prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
prototype_source/flight_recorder_tutorial.rst Show resolved Hide resolved
prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
c-p-i-o and others added 3 commits September 5, 2024 16:51
Address code formatting changes

Co-authored-by: Svetlana Karslioglu <[email protected]>
Summary:

Test Plan:

Reviewers:

Subscribers:

Tasks:

Tags:
Test Plan:
Ran rst2html5 and viewed HTML on browser.
XilunWu and others added 18 commits September 6, 2024 09:19
* Add [dtensor][debug] CommDebugMode recipe
---------

Co-authored-by: Svetlana Karslioglu <[email protected]>
Co-authored-by: Svetlana Karslioglu <[email protected]>
* Add programmable Google Search to pytorch tutorials site
* Tutorial for AOTI Python runtime
---------

Co-authored-by: Svetlana Karslioglu <[email protected]>
Co-authored-by: Angela Yi <[email protected]>
- Add a policy for new tutorials submissions

---------

Co-authored-by: albanD <[email protected]>
Co-authored-by: Nikita Shulga <[email protected]>
* Add weights_only=True to torch.load
Co-authored-by: Svetlana Karslioglu <[email protected]>
* Fix hovering over the GCS search button
…ExecuTorch (#3016)

* Added warnings to select ExecuTorch tutorials/recipes/prototypes

* Added warnings to select ExecuTorch tutorials/recipes/prototypes

* Added redirect for renamed prototype

* Update deeplabv3_on_android.rst

Fixed misplaced info tag.

* Apply suggestions from code review

---------

Co-authored-by: Svetlana Karslioglu <[email protected]>
* Patched docs for torch_compile_tutorial

---------

Co-authored-by: Svetlana Karslioglu <[email protected]>
This allows one to install pygame binaries for Python-3.11/3.12 runtime, while PyGame-2.1.2 was only available up to python-3.10, see https://pypi.org/project/pygame/2.1.2/#files

Fixes #3023
Add onnxruntime dependency
* Fixed Rst formatting, minor text changes
* Removed duplicate sentence about CUDA hardware that is already mentioned in the intro text. Minor text change.

---------

Co-authored-by: Svetlana Karslioglu <[email protected]>
* Add meta tag to torch_export_aoti_python

* Feature on the landing page
* Fix reference to DCP
* Keep import style as saving

---------

Co-authored-by: Iris Z <[email protected]>
@c-p-i-o c-p-i-o force-pushed the cpio/flight_recorder branch from 1f33f46 to 4223ce7 Compare September 6, 2024 16:25
@c-p-i-o
Copy link
Contributor Author

c-p-i-o commented Sep 6, 2024

Oops. I did a bad rebase ... fixing it.

@c-p-i-o c-p-i-o force-pushed the cpio/flight_recorder branch from 4223ce7 to 44493fb Compare September 6, 2024 16:30
@c-p-i-o
Copy link
Contributor Author

c-p-i-o commented Sep 6, 2024

Abandoning this branch as I did a bad merge to main. I'll make a new PR ... sorry about that!

@c-p-i-o c-p-i-o closed this Sep 6, 2024
c-p-i-o added a commit that referenced this pull request Sep 6, 2024
Summary:
Recreating pull request #3024 because of bad merges. Re-add flight recorder tutorial with prior comments addressed

Test Plan:
Ran:

rst2html5 flight_recorder_tutorial.rst flight_recorder_tutorial.html


Reviewers: fduwjj, svekars
c-p-i-o added a commit that referenced this pull request Sep 6, 2024
Summary:
Recreating pull request #3024 because of bad merges. Re-add flight recorder tutorial with prior comments addressed

Test Plan:
Ran:

rst2html5 flight_recorder_tutorial.rst flight_recorder_tutorial.html


Reviewers: fduwjj, svekars
c-p-i-o added a commit that referenced this pull request Sep 6, 2024
Summary:
Recreating pull request #3024 because of bad merges.
Re-add flight recorder tutorial with prior comments addressed

Test Plan:
Ran:

rst2html5 flight_recorder_tutorial.rst flight_recorder_tutorial.html

Reviewers: fduwjj, svekars
c-p-i-o added a commit that referenced this pull request Sep 6, 2024
Summary:
Recreating pull request #3024 because of bad merges.
Re-add flight recorder tutorial with prior comments addressed

Test Plan:
Ran:

rst2html5 flight_recorder_tutorial.rst flight_recorder_tutorial.html

Reviewers: fduwjj, svekars
c-p-i-o added a commit that referenced this pull request Sep 9, 2024
* [c10d][Doc] Add a flight recorder tutorial

Summary:
Recreated pull request #3024 because of bad merges.
Re-add flight recorder tutorial with prior comments addressed.

Test Plan:

Ran:

rst2html5 flight_recorder_tutorial.rst flight_recorder_tutorial.html

Co-authored-by: Svetlana Karslioglu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.5 PR related to version 2.5 cla signed new tutorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.