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

[doc] add small example to flight recorder tutorial #3163

Merged
merged 4 commits into from
Nov 26, 2024
Merged

Conversation

c-p-i-o
Copy link
Contributor

@c-p-i-o c-p-i-o commented Nov 18, 2024

Summary:
Add a small example that demonstrates flight recorder end-to-end.

Test Plan:
Test on github to make sure that the tutorial renders correctly.

Description

Add an example to demonstrates flight recorder by using a small program that induces a crash.

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.

@c-p-i-o c-p-i-o requested a review from fduwjj November 18, 2024 18:13
@c-p-i-o c-p-i-o self-assigned this Nov 18, 2024
Copy link

pytorch-bot bot commented Nov 18, 2024

🔗 Helpful Links

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

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

✅ No Failures

As of commit 4e7692a with merge base 540bd0c (image):
💚 Looks good so far! There are no failures yet. 💚

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

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 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
@c-p-i-o c-p-i-o force-pushed the cpio/add_fr_example branch 3 times, most recently from dfbd8c0 to 0c7de76 Compare November 19, 2024 22:47
Summary:
Add a small example that demonstrated flight recorder end-to-end.

Test Plan:
Test on github to make sure that the tutorial renders correctly.
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.

A couple of min

prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
prototype_source/flight_recorder_tutorial.rst Outdated Show resolved Hide resolved
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.

From the publishing perspective this should be okay. Can @fduwjj do a technical review?

@c-p-i-o
Copy link
Contributor Author

c-p-i-o commented Nov 21, 2024

From the publishing perspective this should be okay. Can @fduwjj do a technical review?

Will sync with @fduwjj to get a tech review! Thanks @svekars !

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. Thanks for adding that.

@svekars svekars merged commit 3ba3a46 into main Nov 26, 2024
20 checks passed
@svekars svekars deleted the cpio/add_fr_example branch November 26, 2024 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants