Docs: document the TinyProfileParser script#5525
Open
SuryanshSS1011 wants to merge 1 commit into
Open
Conversation
Adds a subsection to the Tiny Profiling docs covering Tools/TinyProfileParser/profileparser.py, which converts TinyProfiler stdout into JSON for Hatchet. Covers usage and the metrics it emits. Closes AMReX-Codes#4160
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #4160.
The
Tools/TinyProfileParser/profileparser.pyscript wasn't mentioned anywhere in the docs, so this adds a short subsection to the Tiny Profiling page covering it.The new "Converting TinyProfiler Output for Hatchet" subsection goes right after "Hot Spots and Load Balance", since the script consumes TinyProfiler stdout. It covers:
I went with a subsection rather than a separate page since it's one small utility and this keeps it next to the profiler output it parses. Happy to split it into its own page under the chapter toctree instead if you'd prefer that.
Docs-only change; the wording is checked against the current script.