Skip to content

add documentation for Biren#430

Open
DSFans2014 wants to merge 4 commits into
Project-HAMi:masterfrom
DSFans2014:docs/support-biren
Open

add documentation for Biren#430
DSFans2014 wants to merge 4 commits into
Project-HAMi:masterfrom
DSFans2014:docs/support-biren

Conversation

@DSFans2014

@DSFans2014 DSFans2014 commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation / New Features
    • Added a new user guide page explaining how to enable and use Biren device sharing in Kubernetes, including supported sharing modes and node labeling.
    • Added an end-to-end example showing how to request a single Biren GPU in a Pod.
    • Expanded the device support list with Biren166M GPU support details and isolation capabilities.
    • Updated the user guide navigation to include a new Managing Biren devices section with an Examples subsection.

@netlify

netlify Bot commented Jun 3, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit ec61f36
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a3e4a102ac53600083ee806
😎 Deploy Preview https://deploy-preview-430--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 added the size/L label Jun 3, 2026
@DSFans2014 DSFans2014 force-pushed the docs/support-biren branch from e27d656 to c4871d1 Compare June 3, 2026 04:03
@DSFans2014 DSFans2014 marked this pull request as ready for review June 15, 2026 03:10
Signed-off-by: james <open4pd@4paradigm.com>
@DSFans2014 DSFans2014 force-pushed the docs/support-biren branch from c4871d1 to d58339d Compare June 15, 2026 03:14
@mesutoezdil

mesutoezdil commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

node label mismatch: the install step labels the node with biren=on: kubectl label node {biren-node} biren=on

but the DaemonSet nodeSelector looks for birentech.com: gpu:

nodeSelector:
birentech.com: gpu

these do not match, so the DaemonSet will never schedule on a node labeled biren=on.
*missing newline at end of file: both docs/userguide/biren-device/examples/default-use.md and its zh counterpart are missing a newline at the end of the file.

Signed-off-by: james <open4pd@4paradigm.com>
@DSFans2014

Copy link
Copy Markdown
Contributor Author

node label mismatch: the install step labels the node with biren=on: kubectl label node {biren-node} biren=on

but the DaemonSet nodeSelector looks for birentech.com: gpu:

nodeSelector: birentech.com: gpu

these do not match, so the DaemonSet will never schedule on a node labeled biren=on. *missing newline at end of file: both docs/userguide/biren-device/examples/default-use.md and its zh counterpart are missing a newline at the end of the file.

thanks you. All comments have been fixed. @mesutoezdil

@DSFans2014 DSFans2014 force-pushed the docs/support-biren branch from 5030b0d to f538817 Compare June 22, 2026 02:43
Signed-off-by: james <open4pd@4paradigm.com>
@DSFans2014 DSFans2014 force-pushed the docs/support-biren branch from f538817 to 0db201b Compare June 22, 2026 02:58
@DSFans2014

Copy link
Copy Markdown
Contributor Author

@windsonsea Could you please review this PR when you have a moment?

@windsonsea windsonsea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/approve

@hami-robot

hami-robot Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: DSFans2014, windsonsea

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

The pull request process is described 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 added the approved label Jun 24, 2026
@mesutoezdil

Copy link
Copy Markdown
Contributor

@DSFans2014 there are some conflicts.

@DSFans2014

Copy link
Copy Markdown
Contributor Author

@DSFans2014 there are some conflicts.

the conflicts fixed. thanks

@mesutoezdil

Copy link
Copy Markdown
Contributor

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

No new commits to review since the last review.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f0985773-ea52-458c-93db-1dd3acdc9f42

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Added Biren device documentation in English and Chinese, including sharing setup instructions, Pod request examples, usage notes, a device support table entry, and sidebar navigation.

Changes

Biren device documentation

Layer / File(s) Summary
Sharing guide setup
docs/userguide/biren-device/enable-biren-sharing.md, i18n/zh/.../enable-biren-sharing.md
Adds the Biren sharing guide introduction and setup steps in English and Chinese, covering sharing modes, device UUID annotations, node labeling, RBAC, DaemonSet configuration, and host mounts.
Pod examples and notes
docs/userguide/biren-device/enable-biren-sharing.md, docs/userguide/biren-device/examples/default-use.md, i18n/zh/.../enable-biren-sharing.md, i18n/zh/.../examples/default-use.md
Adds Biren Pod request examples in the main guide and dedicated example pages in English and Chinese, then adds the resource-request notes on memory-size limits and SVI partitioning limits.
Support table and sidebar
docs/userguide/device-supported.md, sidebars.js
Adds a Biren166M support table row and a new “Managing Biren devices” sidebar category with the Biren sharing guide and example page entries.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hop, hop—new Biren paths are here,
In English and zh, the steps are clear.
A GPU nibble, a sidebar grin,
Hoppy docs for every hop within!

🚥 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 matches the main change: adding documentation for Biren support and device sharing.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/userguide/biren-device/examples/default-use.md`:
- Line 5: The description in the Biren device example incorrectly says the Pod
runs a container image provided by Birentech, but the manifest uses a generic
ubuntu image. Update the prose in the example to remove the Birentech
attribution and keep it generic, matching the existing wording around the Pod,
container image, and resources.limits in the default-use example.

In
`@i18n/zh/docusaurus-plugin-content-docs/current/userguide/biren-device/enable-biren-sharing.md`:
- Around line 5-11: Update the localized introduction in the biren sharing guide
so it matches the English source: replace the mistranslated vendor/product name
with the correct one for the Biren device and remove the duplicated “SVI”
wording in the capability bullet. Keep the wording in the Introduction section
of enable-biren-sharing.md aligned with the corresponding English doc,
especially the device name and the “整卡和 SVI 切分” capability description.

In
`@i18n/zh/docusaurus-plugin-content-docs/current/userguide/biren-device/examples/default-use.md`:
- Line 5: Update the localized example text in the userguide Biren device docs
so the vendor name matches the English source and the rest of the doc set
branding. In the sentence describing the Kubernetes Pod example, replace the
current vendor name in the prose with 壁仞, and keep the rest of the example
wording aligned with the corresponding docs content.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d09cf372-6398-4163-a24f-ea93472a07a8

📥 Commits

Reviewing files that changed from the base of the PR and between 8526dff and a899327.

📒 Files selected for processing (6)
  • docs/userguide/biren-device/enable-biren-sharing.md
  • docs/userguide/biren-device/examples/default-use.md
  • docs/userguide/device-supported.md
  • i18n/zh/docusaurus-plugin-content-docs/current/userguide/biren-device/enable-biren-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/current/userguide/biren-device/examples/default-use.md
  • sidebars.js

Comment thread docs/userguide/biren-device/examples/default-use.md Outdated
Signed-off-by: james <open4pd@4paradigm.com>
@DSFans2014 DSFans2014 force-pushed the docs/support-biren branch from a899327 to ec61f36 Compare June 26, 2026 09:44
@DSFans2014

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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.

3 participants