Skip to content

docs(v2.9): correct GPU scoring formulas - #842

Open
blackdragoon26 wants to merge 1 commit into
Project-HAMi:masterfrom
blackdragoon26:docs/fix-v2.9-gpu-scoring-formula
Open

docs(v2.9): correct GPU scoring formulas#842
blackdragoon26 wants to merge 1 commit into
Project-HAMi:masterfrom
blackdragoon26:docs/fix-v2.9-gpu-scoring-formula

Conversation

@blackdragoon26

@blackdragoon26 blackdragoon26 commented Sep 3, 2026

Copy link
Copy Markdown

What type of PR is this?
/kind documentation

What this PR does / why we need it:

Corrects the GPU scoring formulas in the frozen v2.9.0 documentation.

The existing formulas omit the virtual-device slot utilization term, although this term was already part of ComputeScore before the configurable scoring weights were introduced.

This update:

  • adds the missing slot-utilization term to the GPU Binpack and Spread formulas
  • corrects the example scores from 6.75 and 17.75 to 7.75 and 18.75
  • clarifies that Binpack prefers the higher utilization score while Spread prefers the lower score
  • updates both the English and Chinese v2.9.0 documentation
  • remains scoped only to the released v2.9.0 documentation, as requested during the review of docs(scheduler): document per-pod scoring weights #759

This PR does not backport the new hami.io/device-scoring-weights annotation, which belongs to the upcoming release documentation.

Which issue(s) this PR fixes:

Follow-up to #759.

Checklist:

  • npm run lint and npm run format:check pass
  • npm run build succeeds for both en and zh
  • Chinese translation updated if English docs changed (or noted why not)
  • Commits are signed off (git commit -s)

AI Disclosure:
This PR is assisted with AI Assistance for formatting purpose check and am responsible for all the content pushed in this PR.

Summary by CodeRabbit

  • Documentation
    • Updated GPU scheduling policy documentation to include device-slot utilization in Binpack and Spread scoring formulas.
    • Revised scoring examples and terminology to reflect device-utilization scoring.
    • Clarified that the Spread example uses the same scenario as the Binpack example.

Signed-off-by: blackdragoon26 <sankalp.jha9643@gmail.com>
@hami-robot hami-robot Bot added the kind/documentation Improvements or additions to documentation label Sep 3, 2026
@hami-robot
hami-robot Bot requested review from rootsongjc and wawa0210 September 3, 2026 15:51
@hami-robot

hami-robot Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: blackdragoon26
Once this PR has been reviewed and has the lgtm label, please assign wawa0210 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@netlify

netlify Bot commented Sep 3, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 4bb1f9b
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a9997792257a200074d8a6b
😎 Deploy Preview https://deploy-preview-842--project-hami.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 470eb87d-90be-453d-b20c-9787db893985

📥 Commits

Reviewing files that changed from the base of the PR and between ceade29 and 4bb1f9b.

📒 Files selected for processing (2)
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/developers/scheduling.md
  • versioned_docs/version-v2.9.0/developers/scheduling.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The v2.9.0 GPU scheduling documentation updates Binpack and Spread scoring formulas to include virtual device slots, compute cores, and memory usage. The worked examples now use scores of 7.75 and 18.75.

Changes

GPU Scheduling Documentation

Layer / File(s) Summary
Slot-aware Binpack and Spread scoring
versioned_docs/version-v2.9.0/developers/scheduling.md, i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/developers/scheduling.md
The Binpack and Spread formulas now include virtual device slots. The descriptions and GPU1/GPU2 examples use the updated scores.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 4bb1f

This documentation-only update corrects GPU scoring formulas and examples consistently in English and Chinese, with no remaining merge-readiness risk identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: correcting the GPU scoring formulas in the v2.9 documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mesutoezdil

Copy link
Copy Markdown
Contributor

/lgtm

exactly the follow up i asked for on #759: scoped to the v2.9.0 english and chinese snapshots only, and the 7.75 and 18.75 figures match the three term formula in gpu_policy.go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs area/i18n kind/documentation Improvements or additions to documentation lgtm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants