Skip to content

docs: update vGPU memory metric documentation - #738

Merged
rootsongjc merged 1 commit into
Project-HAMi:masterfrom
hyy321:docs/sync-vgpu-memory-metric-schema
Aug 13, 2026
Merged

docs: update vGPU memory metric documentation#738
rootsongjc merged 1 commit into
Project-HAMi:masterfrom
hyy321:docs/sync-vgpu-memory-metric-schema

Conversation

@hyy321

@hyy321 hyy321 commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

The current vGPU monitoring docs still show labels that have been removed from hami_container_device_memory_bytes.

This PR:

  • updates the metric description and example to match the current schema
  • removes context_size, module_size, buffer_size, and offset from the example
  • updates the v2.10.0 note to reference the separate context, module, and buffer memory metrics
  • updates both English and Chinese current docs

The versioned v2.9.0 docs are unchanged.

Which issue(s) this PR fixes:

Related to Project-HAMi/HAMi#2356

Related to Project-HAMi/HAMi#2126 (vGPU observability documentation)

Checklist:

  • npm run lint and npm run format:check pass
  • npm run build succeeds
  • Chinese translation updated
  • Commits are signed off (git commit -s)

AI assistance disclosure:

AI assistance was used only for wording suggestions and verification guidance. I made the final decisions, reviewed the changes, and ran the checks myself.

Summary by CodeRabbit

  • Documentation
    • Updated real-time device usage documentation to clarify that the container device memory metric reports total memory usage without memory-breakdown labels.
    • Noted that, since v2.10.0, context, module, and buffer memory are reported through separate vGPU metrics.
    • Updated both English and Chinese documentation.

Signed-off-by: hyy321 <1970476830@qq.com>
@hami-robot hami-robot Bot added kind/documentation Improvements or additions to documentation dco-signoff: yes labels Aug 8, 2026
@netlify

netlify Bot commented Aug 8, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit cdb9df1
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a7744359caabf00088d5320
😎 Deploy Preview https://deploy-preview-738--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 requested review from archlitchi and rootsongjc August 8, 2026 14:59
@hami-robot hami-robot Bot added the size/XS label Aug 8, 2026
@hami-robot

hami-robot Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

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

@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The documentation now describes hami_container_device_memory_bytes as total container device memory. It removes memory-breakdown labels and identifies the corresponding vGPU metrics for context, module, and buffer memory in English and Chinese.

Changes

Device memory metric documentation

Layer / File(s) Summary
Metric description and version note
docs/userguide/monitoring/real-time-device-usage.md, i18n/zh/docusaurus-plugin-content-docs/current/userguide/monitoring/real-time-device-usage.md
The examples no longer include memory-breakdown labels. The v2.10.0 notes state that these labels were removed and reference the corresponding vGPU metrics.

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

Possibly related PRs

Suggested reviewers: ntheanh201

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation updates for vGPU memory metrics, which is the main change in the pull request.
✨ 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.

@rootsongjc rootsongjc 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.

/LGTM

@hami-robot

hami-robot Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: hyy321, rootsongjc
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

@rootsongjc
rootsongjc merged commit 0b8e569 into Project-HAMi:master Aug 13, 2026
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants