Skip to content

docs(scheduler): document per-pod scoring weights - #759

Open
blackdragoon26 wants to merge 1 commit into
Project-HAMi:masterfrom
blackdragoon26:docs/device-scoring-weights
Open

docs(scheduler): document per-pod scoring weights#759
blackdragoon26 wants to merge 1 commit into
Project-HAMi:masterfrom
blackdragoon26:docs/device-scoring-weights

Conversation

@blackdragoon26

@blackdragoon26 blackdragoon26 commented Aug 11, 2026

Copy link
Copy Markdown

What type of PR is this?
/kind documentation

What this PR does / why we need it:

Documents the per-Pod device-scoring weights introduced by Project-HAMi/HAMi#2469.

This update:

  • documents the hami.io/device-scoring-weights annotation
  • explains defaults and validation requirements
  • provides a complete Pod manifest
  • documents the weighted slot/core/memory formula
  • includes a checked example showing how weights affect device selection
  • clarifies interaction with binpack, spread, topology, mutex, capacity checks, and vendor-specific Fit behavior
  • updates the existing default GPU scoring examples to include virtual-device slot utilisation

This PR depends on Project-HAMi/HAMi#2469. The documented contract should be finalised together with that implementation.

Which issue(s) this PR fixes:

Fixes #758

I have not done the Chinese translation in this PR yet. This documents an unreleased feature in the English source-of-truth page, once I can get an initial review and green flag, I would update the the translation version as well in the PR

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:
Codex was used to cross-check the implementation semantics and calculations, and to help draft the documentation. I reviewed and verified the final content and test results.

Summary by CodeRabbit

  • Documentation
    • Documented configurable GPU device-scoring weights for slot, core, and memory utilization.
    • Added validation rules, default values, and scoring examples.
    • Clarified that fit and topology constraints take precedence.
    • Updated GPU binpack and spread formulas to include virtual-device slot utilization.

Signed-off-by: blackdragoon26 <sankalp.jha9643@gmail.com>
@hami-robot hami-robot Bot added kind/documentation Improvements or additions to documentation dco-signoff: yes labels Aug 11, 2026
@hami-robot
hami-robot Bot requested a review from rootsongjc August 11, 2026 13:15
@hami-robot

hami-robot Bot commented Aug 11, 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 archlitchi 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

@hami-robot
hami-robot Bot requested a review from windsonsea August 11, 2026 13:15
@netlify

netlify Bot commented Aug 11, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 11b09f9
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a7b2085ffea3d00088165a3
😎 Deploy Preview https://deploy-preview-759--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.

@hami-robot

hami-robot Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Welcome @blackdragoon26! It looks like this is your first PR to Project-HAMi/website 🎉

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The scheduling guide documents per-Pod device-scoring weights for slot, core, and memory utilization. It also updates GPU binpack and spread formulas and examples to include virtual-device slot utilization.

Changes

GPU scoring documentation

Layer / File(s) Summary
Scoring contract and policy formulas
docs/developers/scheduling.md
Documents the hami.io/device-scoring-weights annotation, validation rules, defaults, weighted scoring, and unchanged scheduling constraints. Updates binpack and spread formulas and examples to include slot utilization.

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

Possibly related issues

  • Project-HAMi/HAMi issue 2220: Covers the configurable slot, core, and memory device-scoring weights and updated binpack and spread formulas documented here.

Suggested reviewers: mesutoezdil

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The documentation covers the annotation, defaults, validation, formula, policy behavior, scope boundaries, manifest, and memory-weighting example required by #758.
Out of Scope Changes check ✅ Passed The changes are limited to scheduling documentation and align with the linked issue objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documentation update for per-Pod scheduler scoring weights.
✨ 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.

@Creativeklvn

Copy link
Copy Markdown
Contributor

LGTM

@FouoF FouoF left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The doc seem placing incorrect. This is a user-face change so it should update or draft a user guide instead of developer doc. Also better add a Chinese version.

@blackdragoon26

Copy link
Copy Markdown
Author

The doc seem placing incorrect. This is a user-face change so it should update or draft a user guide instead of developer doc. Also better add a Chinese version.

Thanks for the review.
my bad on that part, I will do fixing on it quickly.

@blackdragoon26

Copy link
Copy Markdown
Author

@FouoF , sorry to ping you again
I am bit confused that since HAMi#2469 implements this in the generic device-scoring path,
So should I create a general user-guide page, or
add it to the existing NVIDIA scheduling-policy page because the example uses NVIDIA resources?
Honestly, I am leaning toward a general page to avoid implying the feature is NVIDIA-only.

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

Labels

area/docs dco-signoff: yes kind/documentation Improvements or additions to documentation size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document per-Pod device scoring weights

3 participants