Skip to content

[Profiler] Add Documentation for FunctionEvent#167688

Closed
sraikund16 wants to merge 1 commit intopytorch:mainfrom
sraikund16:export-D86913697
Closed

[Profiler] Add Documentation for FunctionEvent#167688
sraikund16 wants to merge 1 commit intopytorch:mainfrom
sraikund16:export-D86913697

Conversation

@sraikund16
Copy link
Contributor

@sraikund16 sraikund16 commented Nov 12, 2025

Summary:
Adds documentation for EventList, FunctionEvent and FunctionEventAvg.

Closes #165907

Test Plan: N/A Documentation

Differential Revision: D86913697

cc @svekars @sekyondaMeta @AlannaBurke @robieta @chaekit @guotuofeng @guyang3532 @dzhulgakov @davidberard98 @briancoutinho @sanrise

@pytorch-bot
Copy link

pytorch-bot bot commented Nov 12, 2025

🔗 Helpful Links

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

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

✅ You can merge normally! (1 Unrelated Failure)

As of commit 0dc19c1 with merge base 6ea7791 (image):

UNSTABLE - The following job is marked as unstable, possibly due to flakiness on trunk:

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

@meta-codesync
Copy link

meta-codesync bot commented Nov 12, 2025

@sraikund16 has exported this pull request. If you are a Meta employee, you can view the originating Diff in D86913697.

Summary:

Adds documentation for EventList, FunctionEvent and FunctionEventAvg.

Closes pytorch#165907

Test Plan: N/A Documentation

Differential Revision: D86913697
Copy link
Contributor

@sanrise sanrise left a comment

Choose a reason for hiding this comment

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

much appreciated

@pytorch-bot pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Nov 13, 2025
@sraikund16 sraikund16 added the oncall: profiler profiler-related issues (cpu, gpu, kineto) label Nov 13, 2025
@pytorch-bot pytorch-bot bot removed the oncall: profiler profiler-related issues (cpu, gpu, kineto) label Nov 13, 2025
@pytorch-bot
Copy link

pytorch-bot bot commented Nov 13, 2025

The label oncall: profiler is only applicable to issues and has been removed. Please only use this label on issues.

@sraikund16 sraikund16 added release notes: profiler release notes category module: docs Related to our documentation, both in docs/ and docblocks labels Nov 13, 2025
@pytorch-bot pytorch-bot bot removed the module: docs Related to our documentation, both in docs/ and docblocks label Nov 13, 2025
@pytorch-bot
Copy link

pytorch-bot bot commented Nov 13, 2025

The label module: docs is only applicable to issues and has been removed. Please only use this label on issues.

@sraikund16 sraikund16 added the topic: docs topic category label Nov 13, 2025
@sraikund16
Copy link
Contributor Author

@pytorchbot merge

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

Silv3S pushed a commit to Silv3S/pytorch that referenced this pull request Nov 18, 2025
Summary:
Adds documentation for EventList, FunctionEvent and FunctionEventAvg.

Closes pytorch#165907

Test Plan: N/A Documentation

Differential Revision: D86913697

Pull Request resolved: pytorch#167688
Approved by: https://github.com/sanrise
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ciflow/trunk Trigger trunk jobs on your pull request fb-exported Merged meta-exported release notes: profiler release notes category topic: docs topic category

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feedback on profiler key_averages documentation

3 participants