-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add documentation about profiling and performance analysis #5597
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
Conversation
|
@DudeNr33 I wrote a little something just so we have this information somewhere and can refer to it. Please let me know what you think of it! |
Pull Request Test Coverage Report for Build 1623987012
π - Coveralls |
DudeNr33
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great idea to document this for future reference!
Maybe a short summary what to look for in the results could be helpful.
I think besides the "general" profiling, a contributor might be interested in optimising a new checker they wrote. They are probably interested which method is called how many times, and what the most taxing portions of their code (both in total and cumulative time) are.
Co-authored-by: Andreas Finkler <[email protected]>
β¦into profiler-docs
DudeNr33
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Thank you for documenting this!
Pierre-Sassoulas
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think only talking about the specific of pylint is good. We could add possible tools in the last part or remove the part where we explains how cprofile works altogether and link to the documentation instead. Performance inclined contributor are unlikely to need basic advises like this imo.
Pierre-Sassoulas
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work, the basis for pylint getting faster π
Type of Changes
Description
Closes #4067
While by no means perfect, this might be a good step towards better documentation on performance analysis. At least it shows users how to generate a useful profiler report.