Skip to content

Commit 6d25397

Browse files
Lijiachen1018lijiachen19
andauthored
[build] project docs for pypi (#466)
add docs for pypi Co-authored-by: lijiachen19 <lijiachen19@huawei.com>
1 parent 260dfe7 commit 6d25397

File tree

3 files changed

+28
-8
lines changed

3 files changed

+28
-8
lines changed

MANIFEST.in

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
1-
recursive-include ucm/csrc *
2-
exclude CMakeLists.txt
1+
include LICENSE
2+
include pyproject.toml
3+
include CMakeLists.txt
4+
include requirements.txt
5+
6+
recursive-include examples *
7+
recursive-include benchmarks *

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<p align="center">
22
<picture>
3-
<source media="(prefers-color-scheme: dark)" srcset="docs/source/logos/UCM-dark.png">
4-
<img alt="UCM" src="docs/source/logos/UCM-light.png" width=50%>
3+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ModelEngine-Group/unified-cache-management/main/docs/source/logos/UCM-dark.png">
4+
<img alt="UCM" src="https://raw.githubusercontent.com/ModelEngine-Group/unified-cache-management/main/docs/source/logos/UCM-light.png" width=50%>
55
</picture>
66
</p>
77

@@ -32,7 +32,7 @@ Sparse KV cache have many different choices. Recently paper point out that there
3232
and all models. So better to build a common framework then different sparse algorithms can be plugin to it like KV
3333
connector for PC.
3434

35-
![architecture.png](./docs/source/_static/images/idea.png)
35+
![architecture.png](https://raw.githubusercontent.com/ModelEngine-Group/unified-cache-management/main/docs/source/_static/images/idea.png)
3636

3737
All gray boxes in the diagram represent existing classes in vLLM version 0.9.2, while the green boxes indicate newly added components by UCM.
3838
The light green boxes demonstrate potential future subclass extensions based on this framework.
@@ -68,7 +68,7 @@ in either a local filesystem for single-machine scenarios or through NFS mount p
6868

6969
## Quick Start
7070

71-
please refer to [Quick Start](./docs/source/getting-started/quick_start.md).
71+
please refer to [Quick Start](https://ucm.readthedocs.io/en/latest/getting-started/quick_start.html).
7272

7373
---
7474

@@ -85,8 +85,8 @@ please refer to [Quick Start](./docs/source/getting-started/quick_start.md).
8585
1. For technical questions and feature requests, please use GitHub [Issues](https://github.com/ModelEngine-Group/unified-cache-management/issues).
8686
2. WeChat technical discussion group: Scan the QR code below.
8787

88-
<img src="docs/source/_static/images/qrcode_for_wechat.png" alt="wechat-gh" width="40%">
88+
<img src="https://raw.githubusercontent.com/ModelEngine-Group/unified-cache-management/main/docs/source/_static/images/qrcode_for_wechat.png" alt="wechat-gh" width="40%">
8989

9090
## License
9191

92-
UCM is licensed under the MIT with additional conditions. Please read the [LICENSE](./LICENSE) file for details.
92+
UCM is licensed under the MIT with additional conditions. Please read the [LICENSE](https://raw.githubusercontent.com/ModelEngine-Group/unified-cache-management/main/LICENSE) file for details.

pyproject.toml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
11
[build-system]
22
requires = ["setuptools>=45", "wheel", "cmake", "torch", "pybind11"]
33
build-backend = "setuptools.build_meta"
4+
5+
[project]
6+
name = "uc-manager"
7+
authors = [{name = "UCM Team"}]
8+
license = "MIT"
9+
license-files = ["LICENSE"]
10+
readme = "README.md"
11+
description = "Persist and reuse KV Cache to speedup your LLM."
12+
requires-python = ">=3.10"
13+
dynamic = [ "version", "dependencies", "optional-dependencies"]
14+
15+
[project.urls]
16+
Homepage="https://github.com/ModelEngine-Group/unified-cache-management"
17+
Documentation="https://ucm.readthedocs.io/en/latest"
18+
WeChat="https://github.com/ModelEngine-Group/unified-cache-management/blob/develop/docs/source/_static/images/qrcode_for_wechat.png?raw=true"

0 commit comments

Comments
 (0)