improve documentation for the coll tuned component #12642
Merged
Conversation
This file contains 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
bosilca
reviewed
Jun 26, 2024
burlen
force-pushed
the
coll_tuned_doc_tuning
branch
from
65accb9
to
0d66d5f
Compare
bosilca
approved these changes
Jun 27, 2024
jsquyres
reviewed
Jun 28, 2024
docs/tuning-apps/coll-tuned.rst
Outdated
| Tuning Collectives | ||
| ================== | ||
|
|
||
| Open MPI's `coll` framework provides a number of components implementing |
There was a problem hiding this comment.
In the rest of the docs, I think the convention we've used is
``coll``
i.e., double quotes so that coll shows up in fixed-width font, not italics.
Same with the coll component names, below. Like this:
resolves open-mpi#12641 Signed-off-by: Burlen Loring <[email protected]>
burlen
force-pushed
the
coll_tuned_doc_tuning
branch
from
0d66d5f
to
55c9dda
Compare
jsquyres
approved these changes
Jul 10, 2024
|
Thank you @burlen! |
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.
Adds documentation to the user guide for the
coll tunedcomponent. It's not intended to be comprehensive but rather summarize the key information needed to effectively use the tuning features.resolves #12641