Document the Execution Graph generation process #498
Merged
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
Shillaker
approved these changes
Oct 14, 2021
Collaborator
Shillaker
left a comment
There was a problem hiding this comment.
Once tests pass this looks good 👍
c2f0a81 to
872597a
Compare
872597a to
9147608
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In this PR I add documentation for the generation of execution graphs. Execution graphs are useful to analyse an application's performance (i.e. a running application) thus why I chosed to include the docs in the profiling section, rather than in the debugging one.
In this PR I bump the faabric dependency to be able to generate execution graphs from MPI applications, and therefore I will also bump the code version once that gets merged in, so that we can use this in production.