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] Move each profiler to its own file + Add missing PyTorchProfiler to the doc #7822

Merged
merged 10 commits into from
Jun 4, 2021

Conversation

tchaton
Copy link
Contributor

@tchaton tchaton commented Jun 3, 2021

What does this PR do?

Fixes #7806

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@tchaton tchaton self-assigned this Jun 3, 2021
@tchaton tchaton added this to the v1.3.x milestone Jun 3, 2021
@tchaton tchaton added the docs Documentation related label Jun 3, 2021
@codecov
Copy link

codecov bot commented Jun 3, 2021

Codecov Report

Merging #7822 (8d4a299) into master (36770b2) will decrease coverage by 0%.
The diff coverage is 97%.

@@          Coverage Diff           @@
##           master   #7822   +/-   ##
======================================
- Coverage      93%     92%   -0%     
======================================
  Files         199     202    +3     
  Lines       13016   13039   +23     
======================================
- Hits        12051   12036   -15     
- Misses        965    1003   +38     

@tchaton tchaton changed the title [doc] Missing PyTorchProfiler [doc] Move each profiler to its own file + Add missing PyTorchProfiler to the doc Jun 4, 2021
@tchaton tchaton marked this pull request as ready for review June 4, 2021 08:03
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

imports may brake for some people who do not import at top level from init file

@tchaton
Copy link
Contributor Author

tchaton commented Jun 4, 2021

imports may brake for some people who do not import at top level from init file

Hey @awaelchli. Added a depreciation call.

Best,
T.C

@Borda
Copy link
Member

Borda commented Jun 4, 2021

Is it rename files or adding new code, from the PR diff it is not clear...

@tchaton
Copy link
Contributor Author

tchaton commented Jun 4, 2021

Is it rename files or adding new code, from the PR diff it is not clear...

This PR extracts each profiler from profilers.py and move it to simple.py, advanced.py, etc..

Best,
T.C

@kaushikb11 kaushikb11 merged commit 51d370f into master Jun 4, 2021
@kaushikb11 kaushikb11 deleted the add_pytorch_profiler branch June 4, 2021 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PytorchProfiler API documentation missing
8 participants