Skip to content

Commit

Permalink
[Docs] Update README.md (#706)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeffwan authored Feb 19, 2025
1 parent dcda623 commit 3357d95
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ The initial release includes the following key features:
- **Unified AI Runtime**: A versatile sidecar enabling metric standardization, model downloading, and management.
- **Distributed KV Cache**: Enables high-capacity, cross-engine KV reuse.
- **GPU Hardware Failure Detection (TBD)**: Proactive detection of GPU hardware issues.
- **Benchmark Tool (TBD)**: A tool for measuring inference performance and resource efficiency.

## Architecture

![aibrix-architecture-v1](docs/source/assets/images/aibrix-architecture-v1.jpeg)


## Quick Start
Expand Down Expand Up @@ -43,12 +46,14 @@ kubectl create -k "github.com/aibrix/aibrix/config/overlays/release?ref=v0.2.0"

## Documentation

For detailed documentation on installation, configuration, and usage, please visit our [documentation page](https://github.com/aibrix/aibrix).
For detailed documentation on installation, configuration, and usage, please visit our [documentation page](https://aibrix-aibrix.readthedocs-hosted.com/en/latest/).

## Contributing

We welcome contributions from the community! Check out our [contributing guidelines](https://github.com/aibrix/aibrix/CONTRIBUTING.md) to see how you can make a difference.

Slack Channel: https://vllm-dev.slack.com/archives/C07QP347J4D

## License

AIBrix is licensed under the [APACHE License](https://github.com/aibrix/aibrix/LICENSE.md).
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/assets/images/aibrix-architecture-v1.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/source/designs/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ AIBrix Architecture

The following diagram gives an overview of the AIBrix Ecosystem and how it relates to the wider Kubernetes and LLM landscapes.

.. figure:: ../assets/images/aibrix-architecture-v1.png
.. figure:: ../assets/images/aibrix-architecture-v1.jpeg
:alt: aibrix-architecture-v1
:width: 100%
:align: center
Expand Down

0 comments on commit 3357d95

Please sign in to comment.