Skip to content

docs: add the pages moved out of the HAMi repo docs folder #914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
moezdil wants to merge 4 commits into
base: master
Choose a base branch
from
+536 −28
Open

docs: add the pages moved out of the HAMi repo docs folder #914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6408432
docs: add the pages moved out of the HAMi repo docs folder
moezdil Oct 9, 2026
10c5e66
docs: align the roadmap with the supported devices list and narrow th…
moezdil Oct 9, 2026
706f87f
docs: drop horizontal rules and add zh translation of general technic…
moezdil Oct 10, 2026
b99d7ec
docs: align general technical review Kubernetes baseline with prerequ…
moezdil Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
223 changes: 223 additions & 0 deletions docs/contributor/general-technical-review.md
View file
Open in desktop

Large diffs are not rendered by default.

29 changes: 15 additions & 14 deletions docs/contributor/roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,21 @@ sidebar_label: Roadmap

## Device Support Matrix

| Device Type | Manufacturer | Models | Memory Isolation | Core Isolation | Multi-Card |
| ----------- | ------------- | ----------------- | :--------------: | :------------: | :--------: |
| GPU | NVIDIA | All | Yes | Yes | Yes |
| MLU | Cambricon | 370, 590 | Yes | Yes | No |
| GCU | Enflame | S60 | Yes | Yes | No |
| HCU | Hygon | All | Yes | Yes | No |
| NPU | Huawei Ascend | 310P, 910B, 910B3 | Yes | Yes | No |
| GPU | Iluvatar | All | Yes | Yes | No |
| DPU | Teco | Checking | In progress | In progress | No |
| GPU | Moore Threads | MTT S4000 | Yes | Yes | No |
| GPU | Birentech | Model 110 | In progress | In progress | No |
| GPU | MetaX | MXC500 | Yes | Yes | No |
| XPU | Kunlunxin | P800 | Yes | Yes | No |
| GPU | Vastai | VA16 | Yes | Yes | No |
| Device Type | Manufacturer | Models | Memory Isolation | Core Isolation | Multi-Card |
| --- | --- | --- | :-: | :-: | :-: |
| GPU | NVIDIA | All | Yes | Yes | Yes |
| MLU | Cambricon | 370, 590 | Yes | Yes | No |
| GCU | Enflame | S60 | Yes | Yes | No |
| HCU | Hygon | All | Yes | Yes | No |
| NPU | Huawei Ascend | 310P, 910B, 910B3 | Yes | Yes | No |
| GPU | Iluvatar | All | Yes | Yes | No |
| DPU | Teco | Checking | In progress | In progress | No |
| GPU | Moore Threads | MTT S4000 | Yes | Yes | No |
| GPU | Birentech | Biren166M | No | No | No |
| GPU | MetaX | MXC500 | Yes | Yes | No |
| XPU | Kunlunxin | P800 | Yes | Yes | No |
| GPU | Vastai | VA16 | Yes | Yes | No |
| Neuron | AWS | Inferentia, Trainium | No | Yes | No |

## Planned Features

Expand Down
28 changes: 28 additions & 0 deletions docs/developers/scheduler-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
id: scheduler-metrics
title: Scheduler Metrics
sidebar_label: Scheduler Metrics
---

HAMi exposes scheduler metrics on the configured scheduler metrics endpoint. The allocation outcome metrics use only bounded label values:

| Metric | Meaning |
| --- | --- |
| `hami_scheduler_allocations_total` | Successful device reservations recorded by the filter phase. |
| `hami_scheduler_allocation_failures_total` | Filter and bind allocation failures. |
| `hami_scheduler_bind_rollbacks_total` | Bind failures that release a reservation. |

The labels are `phase`, `device_type`, and `failure_reason`. They never contain pod, namespace, node, UUID, or request identifiers. `failure_reason` uses this complete, fixed set:

| Value | Meaning |
| ------------------ | ------------------------------------------------------------------ |
| `none` | The operation succeeded. |
| `no_fit` | No candidate node could satisfy the device request. |
| `lookup` | A required pod or node could not be read from the scheduler cache. |
| `identity` | The bind request did not match the current pod identity or target. |
| `lock` | Device reservation locking failed. |
| `annotation_patch` | A required pod annotation update failed. |
| `bind` | Another bind operation failed. |
| `internal` | Internal usage, scoring, discovery, or cleanup failed. |

A successful filter reservation uses `failure_reason="none"`; bind failures are reported by the failure and rollback counters.
Loading
Loading