[Doc] Fix mkdocs. (#785)
Signed-off-by: Alicia <115451386+congw729@users.noreply.github.com>
This commit is contained in:
1 parent
1fe64e85a6
commit
314bb4e324
5 files changed
+13
-23
No files matched your search
+1
-1
@@ -3,7 +3,7 @@ nav:
|
|||||||
- User Guide:
|
- User Guide:
|
||||||
- Getting Started:
|
- Getting Started:
|
||||||
- getting_started/quickstart.md
|
- getting_started/quickstart.md
|
||||||
- getting_started/installation
|
- getting_started/installation/*
|
||||||
- Serving:
|
- Serving:
|
||||||
- OpenAI-Compatible API:
|
- OpenAI-Compatible API:
|
||||||
- Image Generation: serving/image_generation_api.md
|
- Image Generation: serving/image_generation_api.md
|
||||||
|
|||||||
@@ -64,13 +64,13 @@ According to analysis for current popular open-source models, most of them have
|
|||||||
|
|
||||||
## Key Components
|
## Key Components
|
||||||
|
|
||||||
| Component | Description |
|
| Component | Description |
|
||||||
|-----------|-------------|
|
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| **OmniRouter** | provide an intelligent router for Omni-modality requests dispatch |
|
| **OmniRouter** | provide an intelligent router for Omni-modality requests dispatch |
|
||||||
| **EntryPoints** | define the APIs for offline/online serving (APIServer, Omni/AsyncOmni) and provide the OmniStage abstraction for different AR/DiT stages |
|
| **EntryPoints** | define the APIs for offline/online serving (APIServer, Omni/AsyncOmni) and provide the OmniStage abstraction for different AR/DiT stages |
|
||||||
| **AR** | adapted for omni-modality models while inheriting efficient features from vLLM, such as cache management |
|
| **AR** | adapted for omni-modality models while inheriting efficient features from vLLM, such as cache management |
|
||||||
| **Diffusion** | natively implemented and optimized using acceleration components |
|
| **Diffusion** | natively implemented and optimized using acceleration components |
|
||||||
| **OmniConnector** | supports fully disaggregation based on E/P/D/G (Encoding/Processing/Decoding/Generation) disaggregation across stages |
|
| **OmniConnector** | supports fully disaggregation based on E/P/D/G (Encoding/Processing/Decoding/Generation) disaggregation across stages |
|
||||||
|
|
||||||
Disaggregated stages are managed through configuration, such as in the Qwen3-Omni example, where stages like Thinker, Talker, and Code2wav are defined as separate OmniStage instances with specific resources and input/output type.
|
Disaggregated stages are managed through configuration, such as in the Qwen3-Omni example, where stages like Thinker, Talker, and Code2wav are defined as separate OmniStage instances with specific resources and input/output type.
|
||||||
|
|
||||||
@@ -192,4 +192,4 @@ curl -sS -X POST http://localhost:8091/v1/chat/completions \
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
For more usages, please refer to [examples](../user_guide/examples/).
|
For more usages, please refer to [examples](../examples/README.md).
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
# Gradio Demo
|
|
||||||
|
|
||||||
Source <https://github.com/vllm-project/vllm-omni/blob/main/examples/online_serving/gradio_demo.py>.
|
|
||||||
|
|
||||||
``````py
|
|
||||||
--8<-- "examples/online_serving/gradio_demo.py"
|
|
||||||
``````
|
|
||||||
-7
@@ -1,7 +0,0 @@
|
|||||||
# OpenAI Chat Completion Client For Multimodal Generation
|
|
||||||
|
|
||||||
Source <https://github.com/vllm-project/vllm-omni/blob/main/examples/online_serving/openai_chat_completion_client_for_multimodal_generation.py>.
|
|
||||||
|
|
||||||
``````py
|
|
||||||
--8<-- "examples/online_serving/openai_chat_completion_client_for_multimodal_generation.py"
|
|
||||||
``````
|
|
||||||
@@ -60,6 +60,10 @@ hooks:
|
|||||||
- docs/mkdocs/hooks/url_schemes.py
|
- docs/mkdocs/hooks/url_schemes.py
|
||||||
- docs/mkdocs/hooks/generate_examples.py
|
- docs/mkdocs/hooks/generate_examples.py
|
||||||
|
|
||||||
|
# Exclude include files from navigation warnings
|
||||||
|
exclude_docs: |
|
||||||
|
**/*.inc.md
|
||||||
|
|
||||||
# Plugins
|
# Plugins
|
||||||
plugins:
|
plugins:
|
||||||
- meta
|
- meta
|
||||||
|
|||||||
Reference in new issue
Block a user