<img src="docs/logo-horizontal.png" alt="HAMi-WebUI Logo (Light)" width="50%">

English | [简体中文](README_ZH.md)

An open-source platform for managing and observing GPU resources, based on the HAMi project

[![License](https://img.shields.io/github/license/Project-HAMi/HAMi)](LICENSE)

HAMi-WebUI is built upon the [HAMi](https://github.com/Project-HAMi/HAMi) open-source project. It extends HAMi by providing an intuitive web interface for visualizing and managing GPU resource allocation and usage across nodes. The platform supports detailed views for tasks and GPUs, enabling teams to monitor resource consumption effectively.

- **Resource Overview:** Provides a comprehensive view of all resources, including node and GPU usage. Quickly assess the status of all nodes and GPUs.
- **Node Management:** Explore detailed node information, including node status, resource usage, and availability.
- **GPU Management:** Visualize the GPU usage on each node, providing detailed insights into the allocation and usage of compute power and memory.
- **Task Management:** Track tasks and their resource consumption. View task creation times, status, GPU allocations, and more.

## Get started

- [Installation guide](docs/installation/helm/index.md)

## Contributing

If you're interested in contributing to HAMi-WebUI:

- Start by reading the [Contributing guide](CONTRIBUTING.md).
- Set up your local environment by following our [Developer guide](docs/contribute/developer-guide.md).
- Explore [beginner-friendly issues](https://github.com/Project-HAMi/HAMi-WebUI/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22).

## Get involved

- Regular Community Meeting: Friday at 16:00 UTC+8 (Chinese)(weekly). [Convert to your timezone](https://www.thetimezoneconverter.com/?t=14%3A30&tz=GMT%2B8&).
  - [Meeting Notes and Agenda](https://docs.google.com/document/d/1YC6hco03_oXbF9IOUPJ29VWEddmITIKIfSmBX8JtGBw/edit#heading=h.g61sgp7w0d0c)
  - [Meeting Link](https://meeting.tencent.com/dm/Ntiwq1BICD1P)
- Join our community on [Slack](https://join.slack.com/t/hami-hsf3791/shared_invite/zt-2gcteqiph-Ls8Atnpky6clrspCAQ_eGQ).

## License

HAMi-WebUI is distributed under [Apache-2.0](LICENSE). For details, see [LICENSE](LICENSE).