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

Docs - Fix metrics name in user tutorial #651

Conversation

polarG
Copy link
Contributor

@polarG polarG commented Sep 23, 2024

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

Major Revision

  • Major Revision A
  • Major Revision B
  • ...

Minor Revision

  • Minor Revision A
  • Minor Revision B
  • ...

dependabot bot and others added 2 commits September 20, 2024 07:46
Bumps [serve-static](https://github.com/expressjs/serve-static) and [express](https://github.com/expressjs/express). These dependencies needed to be updated together.

Updates `serve-static` from 1.15.0 to 1.16.2
- [Release notes](https://github.com/expressjs/serve-static/releases)
- [Changelog](https://github.com/expressjs/serve-static/blob/v1.16.2/HISTORY.md)
- [Commits](expressjs/[email protected])

Updates `express` from 4.19.2 to 4.21.0
- [Release notes](https://github.com/expressjs/express/releases)
- [Changelog](https://github.com/expressjs/express/blob/4.21.0/History.md)
- [Commits](expressjs/[email protected])

---
updated-dependencies:
- dependency-name: serve-static
  dependency-type: indirect
- dependency-name: express
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
@polarG polarG requested a review from cp5555 as a code owner September 23, 2024 18:36
@polarG polarG self-assigned this Sep 23, 2024
Copy link

codecov bot commented Sep 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.80%. Comparing base (e65629a) to head (e400fb7).
Report is 1 commits behind head on release/0.11.

Additional details and impacted files
@@              Coverage Diff              @@
##           release/0.11     #651   +/-   ##
=============================================
  Coverage         85.80%   85.80%           
=============================================
  Files                97       97           
  Lines              6923     6923           
=============================================
  Hits               5940     5940           
  Misses              983      983           
Flag Coverage Δ
cpu-python3.6-unit-test 71.61% <ø> (ø)
cpu-python3.7-unit-test 71.61% <ø> (ø)
cpu-python3.8-unit-test 71.64% <ø> (ø)
cuda-unit-test 83.88% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@abuccts abuccts changed the base branch from main to release/0.11 September 23, 2024 22:05
@abuccts abuccts requested a review from a team as a code owner September 23, 2024 22:05
@abuccts abuccts changed the title [Docs Enhancement]: Fix user-tutorial conflict. Docs - Fix metrics name in user tutorial Sep 23, 2024
@polarG
Copy link
Contributor Author

polarG commented Sep 23, 2024

@polarG please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree company="Microsoft"

@yukirora yukirora enabled auto-merge (squash) September 24, 2024 06:44
@yukirora yukirora merged commit 0ac21a5 into microsoft:release/0.11 Sep 25, 2024
23 of 24 checks passed
@cp5555 cp5555 mentioned this pull request Sep 25, 2024
22 tasks
@cp5555 cp5555 linked an issue Sep 25, 2024 that may be closed by this pull request
@polarG polarG deleted the hongtaozhang/fix-metric-names-are-not-identical-usertutorial branch September 25, 2024 17:21
yukirora pushed a commit that referenced this pull request Oct 8, 2024
**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]>
yukirora added a commit that referenced this pull request Oct 10, 2024
**Description**
Cherry pick bug fixes from v0.11.0 to main

**Major Revision**
* #645 
* #648 
* #646 
* #647 
* #651 
* #652 
* #650

---------

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc improvement]: metric names are not identical in user-tutorial
4 participants