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.

Sign up for GitHub

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

Jump to bottom

[Doc improvement]: metric names are not identical in user-tutorial #649

Closed
polarG opened this issue Sep 18, 2024 · 0 comments · Fixed by #651
Closed

[Doc improvement]: metric names are not identical in user-tutorial #649

polarG opened this issue Sep 18, 2024 · 0 comments · Fixed by #651

Comments

@polarG
Copy link
Contributor

polarG commented Sep 18, 2024

What's the issue, what's expected?:
In result-summary.md line 73-74, the example of kernel-launch used metrics 'kernel-launch/event_overhead' and 'kernel-launch/wall_overhead'.

But in micro-benchmarks.md line 20-21, the metrics names are 'kernel-launch/event_time' and ' kernel-launch/wall_time'.

How to reproduce it?:

Log message or shapshot?:

Additional information:
@polarG polarG mentioned this issue Sep 23, 2024
Merged
yukirora pushed a commit that referenced this issue Sep 25, 2024
@polarG @dependabot @abuccts
Docs - Fix metrics name in user tutorial (#651)
0ac21a5 
**Description**
In result-summary.md line 73-74, the example of kernel-launch used
metrics 'kernel-launch/event_overhead' and
'kernel-launch/wall_overhead'.

But in micro-benchmarks.md line 20-21, the metric names are described as
'kernel-launch/event_time' and ' kernel-launch/wall_time'.

Solution: Use identical metric names described in micro-benchmarks.md.

#649

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: hongtaozhang <[email protected]>
Co-authored-by: Yifan Xiong <[email protected]>
@cp5555 cp5555 linked a pull request Sep 25, 2024 that will close this issue
Docs - Fix metrics name in user tutorial #651
Merged
@cp5555 cp5555 closed this as completed Sep 25, 2024
yukirora pushed a commit that referenced this issue Oct 8, 2024
@polarG @dependabot
@abuccts @yukirora
Docs - Fix metrics name in user tutorial (#651)
5027327 
**Description**
In result-summary.md line 73-74, the example of kernel-launch used
metrics 'kernel-launch/event_overhead' and
'kernel-launch/wall_overhead'.

But in micro-benchmarks.md line 20-21, the metric names are described as
'kernel-launch/event_time' and ' kernel-launch/wall_time'.

Solution: Use identical metric names described in micro-benchmarks.md.

#649

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: hongtaozhang <[email protected]>
Co-authored-by: Yifan Xiong <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs - Fix metrics name in user tutorial polarG/superbenchmark
2 participants
@cp5555 @polarG