Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add modifier docs #190

Merged
merged 19 commits into from
Apr 24, 2024
Merged

Add modifier docs #190

merged 19 commits into from
Apr 24, 2024

Conversation

pearce8
Copy link
Collaborator

@pearce8 pearce8 commented Mar 26, 2024

  • (later) modifiers for setting up the resources etc
  • Modifiers section - generic definition of a modifier, link to Ramble modifiers
  • Caliper modifiers section - generic “Caliper modifier” definition, how to use them, link to Caliper. Followed with a list of specific Caliper modifiers available, where they are applicable (the initial one is platform independent, then its x86 for top-down, and cuda GPUs for the cuda one), and what metrics they collect (so maybe a table with 3 columns we can add to?)
Screenshot 2024-04-04 at 10 48 45 PM

@github-actions github-actions bot added the docs Improvements or additions to documentation label Mar 26, 2024
@pearce8 pearce8 added this to the v0.1.1 milestone Mar 26, 2024
@slabasan slabasan requested a review from rfhaque March 26, 2024 21:44
@pearce8 pearce8 linked an issue Mar 26, 2024 that may be closed by this pull request
@slabasan slabasan changed the title Docs/caliper modifier Add modifier docs Apr 4, 2024
@pearce8
Copy link
Collaborator Author

pearce8 commented Apr 5, 2024

@slabasan Thanks for the table! I think we can put the modifier name in the left column, so this would be:

caliper
caliper-topdown
caliper-cuda

and would match the string one would put after --modifier="one of the strings in the list above". Do you think this you can make this clear?

@slabasan slabasan marked this pull request as ready for review April 10, 2024 18:29
Copy link
Collaborator

@scheibelp scheibelp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a couple suggestions but don't see any major issues.

bin/benchpark Outdated Show resolved Hide resolved
bin/benchpark Outdated Show resolved Hide resolved
@pearce8 pearce8 merged commit 15769ec into develop Apr 24, 2024
7 checks passed
@pearce8 pearce8 deleted the docs/caliper-modifier branch April 24, 2024 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation on caliper modifier
3 participants