gh-138122: Add sampling profiler visualisation to docs #142772
+2,040
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add an interactive JS visualisation to demonstrate how the sampling profiler works. A small demo program is shown executing line by line, demonstrating how stack frames are created and destroyed and how samples are taken periodically during the process. A new Sphinx extension is used to capture and inject the trace into the JS file during documentation build to make these traces reproducible (and avoid hard coding them in the source code).
| .. only:: html | ||
|
|
||
| The following interactive visualization demonstrates how sampling profiling | ||
| works. Press **Play** to watch a Python program execute, and observe how the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a visualisation explaining how the sampling profiler works.
CC: @pablogsal
📚 Documentation preview 📚: https://cpython-previews--142772.org.readthedocs.build/