[Docs] Setup Documentation System and Re-organize Dependencies (#49)

Signed-off-by: SamitHuang <285365963@qq.com>
This commit is contained in:
Samit authored and GitHub committed 2025-11-15 21:45:43 +08:00
1 parent a089dd4c4e
commit 8cafb4294d
37 files changed
+1217 -165

No files matched your search

@@ -0,0 +1,56 @@
# Quickstart
This guide will help you get started with vLLM-omni.
## Installation
Use Docker to keep consistent basic environment (Optional, Recommended)
```bash
docker run --gpus all --ipc=host --network=host -v $source_dir:$container_dir --rm --name $container_name -it nvcr.io/nvidia/pytorch:25.01-py3 bash
```
Set up basic uv environment
```bash
pip install uv
uv venv --python 3.12 --seed
source .venv/bin/activate
```
Install vLLM
```bash
uv pip install vllm==0.11.0 --torch-backend=auto
```
Install vLLM-omni
```bash
git clone https://github.com/vllm-project/vllm-omni.git
cd vllm_omni
uv pip install -e .
```
## Run examples (Qwen2.5-omni)
Get into the example folder
```bash
cd examples/offline_inference/qwen_2_5_omni
```
Then run.
```bash
bash run.sh
```
The output audio is saved in ./output_audio
## Next Steps
- Read the [architecture documentation](../../contributing/design_documents/vllm_omni_design.md)
- Check out the [API reference](../../api/overview.md)
- Explore the [examples](../examples/index.md)