Skip to content

Conversation

@DanielNoord
Copy link
Collaborator

  • Add yourself to CONTRIBUTORS if you are a new contributor.
  • Write a good description on what the PR does.

Type of Changes

Type
βœ“ πŸ“œ Docs

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.

@DanielNoord
Copy link
Collaborator Author

@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!

@coveralls
Copy link

coveralls commented Dec 24, 2021

Pull Request Test Coverage Report for Build 1623987012

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 93.708%

Totals Coverage Status
Change from base Build 1617209026: 0.0%
Covered Lines: 14312
Relevant Lines: 15273

πŸ’› - Coveralls

Copy link
Collaborator

@DudeNr33 DudeNr33 left a 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.

Copy link
Collaborator

@DudeNr33 DudeNr33 left a 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 Pierre-Sassoulas added this to the 2.13.0 milestone Dec 25, 2021
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a 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.

Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a 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 πŸ‘Œ

@Pierre-Sassoulas Pierre-Sassoulas merged commit 99a8f70 into pylint-dev:main Dec 27, 2021
@DanielNoord DanielNoord deleted the profiler-docs branch December 28, 2021 13:25
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.

Create documentation for performance analysis on pylint

4 participants