Document complete list of fundamental profiling events#722
Document complete list of fundamental profiling events#722vagxrth wants to merge 4 commits intoprecice:masterfrom
Conversation
|
This pull request has been mentioned on preCICE Forum on Discourse. There might be relevant details there: https://precice.discourse.group/t/recent-prs-docs-update-and-ui-fix-for-website/2737/1 |
|
Thank you for the PR. We are aware of it and will eventually review it as any other external PR. Good catch for the typo, we need to check where else we might need to update it. |
Ok got it. Let me know if any other changes are needed. |
|
@vagxrth is the merging from master automatic? It keeps popping up without any pushes after that. |
I hope it's not an automatic thing but I'll look into it. |
fsimonis
left a comment
fsimonis
left a comment
There was a problem hiding this comment.
Hi, thanks for the PR.
There is detail missing here. This information can largely be inferred by the name of the events themselves.
I recommend looking into the code of preCICE to find out what happens inside these events. You can rg --fixed-strings profiling::Fundamental should give you the full list of locations to look at.
| * `initialize()` time spent in preCICE `initialize()`. This includes establishing communication between participants, mesh and data transfer, as well as mapping computation. | ||
| * `solver.advance` time spent in the solver between `advance()` calls, including the time between `initialize()` and the first `advance()` call. | ||
| * `advance()` time spent in preCICE `advance()`. This includes data mapping, data transfer, acceleration. | ||
| * `_GLOBAL`: Time spent from the initialization of the events framework to finalization. Starts in participant construction and ends in `finalize` or the destructor. |
There was a problem hiding this comment.
This one is deprecated.
| * `_GLOBAL`: Time spent from the initialization of the events framework to finalization. Starts in participant construction and ends in `finalize` or the destructor. | |
| * `_GLOBAL` *Deprecated*: Time spent from the initialization of the events framework to finalization. Starts in participant construction and ends in `finalize` or the destructor. |
4 participants
Summary
This updates the Fundamental Events section of the performance analysis docs to include the full set of currently emitted fundamental profiling events.
What changed
/content/docs/tooling/tooling-performance-analysis.mdm2n.requestPrimaryRankConnection.<participant>m2n.acceptPrimaryRankConnection.<participant>Why
Issue #705 reported that not all fundamental events were explained in the docs page:
/tooling-performance-analysis.html#fundamental-events.This PR aligns the documentation with the event names currently used in profiling output.
Validation
bundle exec jekyll build/tooling-performance-analysis.html#fundamental-eventsCloses #705
Screenshots