docs: audit supported devices matrix and clarify support status - #684
docs: audit supported devices matrix and clarify support status#684Adii-45 wants to merge 4 commits into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Adii-45 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Welcome @Adii-45! It looks like this is your first PR to Project-HAMi/website 🎉 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughThe English and Chinese device support guides update the HAMi v2.9.0 support matrix. They add statuses, capability definitions, device guide links, Neuron and Biren entries, and revised DPU values. The Chinese sidebar adds the Biren-management category translation. ChangesDevice support status documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Signed-off-by: Aditya Kumar Nayak <adi.nayak45@gmail.com>
018d482 to
01dcd18
Compare
|
Hi @rootsongjc, just a quick note: while testing, I confirmed that the default |
|
pls read the rules of contributions in/for the website |
|
Hi @mesutoezdil, thanks for pointing that out! I went through the website contribution guidelines again and updated the PR description to match the repository's template. If you were referring to something else in the contribution guidelines, could you please let me know? I'd be happy to address it! |
| | GPU | Vastai | VA16 | Stable | Yes | Yes | No | | ||
| | Neuron | AWS Neuron | Inf, Trn | Stable | Yes | Yes | No | | ||
| | GPU | Biren | Biren166M | Experimental | Yes | Yes | No | | ||
| | DPU | Teco | Checking | Under Validation | In progress | In progress | No | |
There was a problem hiding this comment.
The meanings of the columns MemoryIsolation, CoreIsolation, and MultiCard Support should be explained to avoid ambiguity.
There was a problem hiding this comment.
Thanks for the suggestion! I've addressed this in the latest commit by adding explanations for the capability columns. Please let me know if you think any further clarification would be helpful..
mesutoezdil
left a comment
mesutoezdil
left a comment
There was a problem hiding this comment.
left a few notes, mostly the em dashes and the neuron row.
no ai assistance disclosure is present. if any ai tool was used, it must be disclosed per CONTRIBUTING.md: https://github.com/Project-HAMi/HAMi/blob/master/CONTRIBUTING.md#ai-assistance-notice
| - **Stable** — Available in the latest released HAMi version and verified working. | ||
| - **Experimental** — Implemented in HAMi but not yet included in a released version. | ||
| - **Under Validation** — Support is still being implemented; not yet functional. |
There was a problem hiding this comment.
our style guide says no em dashes in docs, pls use a plain - here (docs/contributor/contribute-docs.md, writing style).
|
|
||
| Support status: | ||
|
|
||
| - **Stable** — Available in the latest released HAMi version and verified working. |
There was a problem hiding this comment.
"verified working" is a strong claim for every row, maybe just say it's in the latest release.
| | GCU | Enflame | S60 | Stable | Yes | Yes | No | | ||
| | XPU | Kunlunxin | P800 | Stable | Yes | Yes | No | | ||
| | GPU | Vastai | VA16 | Stable | Yes | Yes | No | | ||
| | Neuron | AWS Neuron | Inf, Trn | Stable | Yes | Yes | No | |
There was a problem hiding this comment.
mfr should be aws, neuron is the device type not the vendor.
| | GCU | Enflame | S60 | Stable | Yes | Yes | No | | ||
| | XPU | Kunlunxin | P800 | Stable | Yes | Yes | No | | ||
| | GPU | Vastai | VA16 | Stable | Yes | Yes | No | | ||
| | Neuron | AWS Neuron | Inf, Trn | Stable | Yes | Yes | No | |
There was a problem hiding this comment.
the neuron guide only allocs cores (1 neuroncore = 1/2 device) and does topo aware sched for multi device pods, so memoryisolation yes and multicard no both look wrong.
There was a problem hiding this comment.
multicard is fixed but memoryisolation is still yes, neuron only allocs cores so this should be no (zh too).
There was a problem hiding this comment.
Fixed in the latest commit.. Thanks for the clarification!
| | XPU | Kunlunxin | P800 | Stable | Yes | Yes | No | | ||
| | GPU | Vastai | VA16 | Stable | Yes | Yes | No | | ||
| | Neuron | AWS Neuron | Inf, Trn | Stable | Yes | Yes | No | | ||
| | GPU | Biren | Biren166M | Experimental | Yes | Yes | No | |
There was a problem hiding this comment.
biren is listed as supported in the v2.9.0 release post, so experimental (not in a released ver) doesn't match.
There was a problem hiding this comment.
still experimental, biren is in the v2.9.0 release so this should be stable.
There was a problem hiding this comment.
Fixed in the latest commit.. Thanks for the clarification!
| | GPU | Vastai | VA16 | Stable | Yes | Yes | No | | ||
| | Neuron | AWS Neuron | Inf, Trn | Stable | Yes | Yes | No | | ||
| | GPU | Biren | Biren166M | Experimental | Yes | Yes | No | | ||
| | DPU | Teco | Checking | Under Validation | In progress | In progress | No | |
There was a problem hiding this comment.
teco row mixes the new status wording with the old "in progress" cells, pls pick one.
| - **稳定（Stable）** — 已在最新发布版本中提供，并已验证可正常工作。 | ||
| - **实验性（Experimental）** — 已在 HAMi 中实现，但尚未包含在正式发布版本中。 | ||
| - **验证中（Under Validation）** — 支持仍在实现中，尚不可用。 |
There was a problem hiding this comment.
same em dash issue here.
| | GCU | 燧原科技（Enflame） | S60 | 稳定 | 是 | 是 | 否 | | ||
| | XPU | 昆仑芯（Kunlunxin） | P800 | 稳定 | 是 | 是 | 否 | | ||
| | GPU | 瀚博（Vastai） | VA16 | 稳定 | 是 | 是 | 否 | | ||
| | Neuron | AWS Neuron | Inf、Trn | 稳定 | 是 | 是 | 否 | |
There was a problem hiding this comment.
same neuron fixes needed in the zh table.
Signed-off-by: Aditya Kumar Nayak <adi.nayak45@gmail.com>
|
Hi @mesutoezdil, thanks a lot for the detailed review and feedback! |
Signed-off-by: Aditya Kumar Nayak <adi.nayak45@gmail.com>
coderabbitai
Bot
added
the
kind/documentation
| @@ -5,17 +5,30 @@ title: Device supported by HAMi | |||
| The table below lists the devices supported by HAMi: | |||
There was a problem hiding this comment.
@Adii-45 great start.
I want to point out a few things that are still missing
- No links to device setup guides or tracking issues.
- No HAMi version or last‑verification date .
- Limitations not mentioned.
4.Missing device guide references.
There was a problem hiding this comment.
Addressed the remaining documentation feedback in the latest commit!
Changes made:
- Added a release version statement for the device support matrix
- Added references to the primary device guides for each supported device
- Clarified that the linked guides include device-specific setup instructions, configuration notes, and known limitations/constraints
I intentionally did not add a "last verified" date because I couldn't find an existing verification convention or a reliable source of truth for that metadata anywhere in the repository. Rather than introducing information that could quickly become stale or inconsistent, I left that part out. I'm happy to add it if there's a preferred convention or source that the project follows..!
Please let me know if there's anything else you'd like me to update. Thanks!
There was a problem hiding this comment.
Addressed the remaining documentation feedback in the latest commit!
Changes made:
- Added a release version statement for the device support matrix
- Added references to the primary device guides for each supported device
- Clarified that the linked guides include device-specific setup instructions, configuration notes, and known limitations/constraints
I intentionally did not add a "last verified" date because I couldn't find an existing verification convention or a reliable source of truth for that metadata anywhere in the repository. Rather than introducing information that could quickly become stale or inconsistent, I left that part out. I'm happy to add it if there's a preferred convention or source that the project follows..!
Please let me know if there's anything else you'd like me to update. Thanks!
Reminder: Answers must be written by human being. You can view the relevant rule here.
https://github.com/Project-HAMi/HAMi/blob/master/CONTRIBUTING.md#contribution-gates
"4. Review replies. The reply you post must be written by you and must address the specific point raised. Verbatim or canned AI replies, or replies that do not engage the comment, lead to the PR being closed."
Signed-off-by: Aditya Kumar Nayak <adi.nayak45@gmail.com>
the changes are not visible at in the deployment preview? |
4 participants
What type of PR is this?
Documentation enhancement
What this PR does / why we need it
This PR addresses the first documentation slice for issue #672 by auditing the supported devices matrix.
Changes include:
Which issue(s) this PR fixes
Part of #672
Checklist
git commit -s)AI Assistance
I consulted Claude Code while working on this documentation update (primarily for repository navigation, understanding the existing documentation structure, and reviewing wording). All changes, verification of the documentation, and the final content were reviewed and authored by me!
Summary by CodeRabbit