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.

Sign up for GitHub

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

Jump to bottom

Document torch.cuda.profiler.start #128098

Closed
wants to merge 7 commits into from
Closed

Document torch.cuda.profiler.start #128098

wants to merge 7 commits into from

Conversation

anandptl84
Copy link
Contributor

@anandptl84 anandptl84 commented Jun 6, 2024 •
edited by pytorch-bot bot
Loading

@anandptl84
Update start method docstring for profiler.py
dd162d7 
document pytorch#127917 start function of cuda/ profiler.py
@anandptl84 anandptl84 requested a review from eqy as a code owner June 6, 2024 02:29
@pytorch-bot PyTorch Bot
Copy link

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

🔗 Helpful Links

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

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 7583757 with merge base 2b9465d (image):

FLAKY - The following job failed but was likely due to flakiness present on trunk:

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

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Jun 6, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@janeyx99 janeyx99 requested a review from svekars June 6, 2024 17:16
@janeyx99 janeyx99 added the triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module label Jun 6, 2024
@svekars svekars added docathon-h1-2024 medium Label for medium docathon tasks module: docs Related to our documentation, both in docs/ and docblocks module: cuda Related to torch.cuda, and CUDA support in general labels Jun 6, 2024
@svekars svekars added the oncall: profiler profiler-related issues (cpu, gpu, kineto) label Jun 10, 2024
aaronenyeshi
aaronenyeshi approved these changes Jun 11, 2024
View reviewed changes
Copy link
Member

@aaronenyeshi aaronenyeshi left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Could we also document the other apis?

davidberard98
davidberard98 requested changes Jun 11, 2024
View reviewed changes
torch/cuda/profiler.py Outdated
Comment on lines 52 to 53
>>> profiler = Profiler();
>>> profiler.start()
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the usage would be more like torch.cuda.profiler.start(), I don't think there's a Profiler() object that would have to be constructed first

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have removed the usage for now to be consistent with other docstrings in this folder.

@malfet malfet added release notes: profiler release notes category topic: docs topic category release notes: cuda release notes category labels Jun 12, 2024
@malfet
Copy link
Contributor

malfet commented Jun 12, 2024

@pytorchbot merge

@pytorch-bot pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Jun 12, 2024
@malfet malfet changed the title Update start method docstring for profiler.py Document torch.cuda.profiler.start Jun 12, 2024
@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

@pytorchmergebot
Copy link
Collaborator

Merge failed

Reason: 1 mandatory check(s) failed. The first few are:

Dig deeper by viewing the failures on hud

Details for Dev Infra team Raised by workflow job

Failing merge rule: Core Maintainers

@anandptl84 anandptl84 requested a review from davidberard98 June 13, 2024 22:53
@davidberard98
Copy link
Contributor

@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

TharinduRusira pushed a commit to TharinduRusira/pytorch that referenced this pull request Jun 14, 2024
@anandptl84 @TharinduRusira
Document torch.cuda.profiler.start (pytorch#128098)
a204a08 
document pytorch#127917 start function of cuda/ profiler.py

Fixes 127917

Pull Request resolved: pytorch#128098
Approved by: /~https://github.com/aaronenyeshi
ignaciobartol pushed a commit to ignaciobartol/pytorch that referenced this pull request Jun 14, 2024
@anandptl84 @ignaciobartol
Document torch.cuda.profiler.start (pytorch#128098)
de50a67 
document pytorch#127917 start function of cuda/ profiler.py

Fixes 127917

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

@aaronenyeshi aaronenyeshi aaronenyeshi approved these changes

@eqy eqy Awaiting requested review from eqy eqy is a code owner

@svekars svekars Awaiting requested review from svekars

@davidberard98 davidberard98 Awaiting requested review from davidberard98

Assignees
No one assigned
Labels
ciflow/trunk Trigger trunk jobs on your pull request docathon-h1-2024 medium Label for medium docathon tasks Merged module: cuda Related to torch.cuda, and CUDA support in general module: docs Related to our documentation, both in docs/ and docblocks oncall: profiler profiler-related issues (cpu, gpu, kineto) open source release notes: cuda release notes category release notes: profiler release notes category topic: docs topic category triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@anandptl84 @malfet @pytorchmergebot @davidberard98 @aaronenyeshi @svekars @pytorchbot @janeyx99