Update docs (#1558)

Jintao-Huang · web-flow · commit 59765af1d396 · 2024-07-31T20:51:35.000+08:00
diff --git a/docs/source/LLM/LmDeploy推理加速与部署.md b/docs/source/LLM/LmDeploy推理加速与部署.md
@@ -19,6 +19,7 @@ git clone https://github.com/modelscope/swift.git
 cd swift
 pip install -e '.[llm]'
 
+# lmdeploy与cuda版本有对应关系，请按照`https://github.com/InternLM/lmdeploy#installation`进行安装
 pip install lmdeploy
 ```
 
diff --git a/docs/source/Multi-Modal/LmDeploy推理加速文档.md b/docs/source/Multi-Modal/LmDeploy推理加速文档.md
@@ -18,6 +18,7 @@ git clone https://github.com/modelscope/swift.git
 cd swift
 pip install -e '.[llm]'
 
+# lmdeploy与cuda版本有对应关系，请按照`https://github.com/InternLM/lmdeploy#installation`进行安装
 pip install lmdeploy
 ```
 
diff --git a/docs/source/Multi-Modal/index.md b/docs/source/Multi-Modal/index.md
@@ -13,9 +13,10 @@
 1. [Qwen-VL最佳实践](qwen-vl最佳实践.md)
 2. [Qwen-Audio最佳实践](qwen-audio最佳实践.md)
 3. [Llava最佳实践](llava最佳实践.md), [LLava Video最佳实践](llava-video最佳实践.md)
-4. [Deepseek-VL最佳实践](deepseek-vl最佳实践.md)
-5. [Internlm2-Xcomposers最佳实践](internlm-xcomposer2最佳实践.md)
-6. [Phi3-Vision最佳实践](phi3-vision最佳实践.md)
+4. [InternVL系列最佳实践](internvl最佳实践.md)
+5. [Deepseek-VL最佳实践](deepseek-vl最佳实践.md)
+6. [Internlm2-Xcomposers最佳实践](internlm-xcomposer2最佳实践.md)
+7. [Phi3-Vision最佳实践](phi3-vision最佳实践.md)
 
 
 一轮对话只能包含一张图片（可能可以不含图片）:
@@ -26,4 +27,3 @@
 整个对话围绕一张图片（可能可以不含图片）:
 1. [CogVLM最佳实践](cogvlm最佳实践.md), [CogVLM2最佳实践](cogvlm2最佳实践.md), [glm4v最佳实践](glm4v最佳实践.md), [CogVLM2-Video最佳实践](cogvlm2-video最佳实践.md)
 2. [MiniCPM-V最佳实践](minicpm-v最佳实践.md), [MiniCPM-V-2最佳实践](minicpm-v-2最佳实践.md), [MiniCPM-V-2.5最佳实践](minicpm-v-2.5最佳实践.md)
-3. [InternVL-Chat-V1.5最佳实践](internvl最佳实践.md)
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -50,13 +50,18 @@ Swift DOCUMENTATION
    :caption: Multi-Modal LLM Training and Inference
 
    Multi-Modal/index.md
+   Multi-Modal/人类偏好对齐训练文档.md
+   Multi-Modal/LmDeploy推理加速文档.md
+   Multi-Modal/vLLM推理加速文档.md
+   Multi-Modal/MLLM部署文档.md
    Multi-Modal/qwen-vl最佳实践.md
    Multi-Modal/qwen-audio最佳实践.md
+   Multi-Modal/llava最佳实践.md
+   Multi-Modal/llava-video最佳实践.md
+   Multi-Modal/internvl最佳实践.md
    Multi-Modal/deepseek-vl最佳实践.md
    Multi-Modal/internlm-xcomposer2最佳实践.md
    Multi-Modal/phi3-vision最佳实践.md
-   Multi-Modal/llava最佳实践.md
-   Multi-Modal/llava-video最佳实践.md
    Multi-Modal/yi-vl最佳实践.md
    Multi-Modal/mplug-owl2最佳实践.md
    Multi-Modal/florence最佳实践.md
@@ -67,11 +72,6 @@ Swift DOCUMENTATION
    Multi-Modal/minicpm-v最佳实践.md
    Multi-Modal/minicpm-v-2最佳实践.md
    Multi-Modal/minicpm-v-2.5最佳实践.md
-   Multi-Modal/internvl最佳实践.md
-   Multi-Modal/人类偏好对齐训练文档.md
-   Multi-Modal/LmDeploy推理加速文档.md
-   Multi-Modal/vLLM推理加速文档.md
-   Multi-Modal/MLLM部署文档.md
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source_en/LLM/LmDeploy-inference-acceleration-and-deployment.md b/docs/source_en/LLM/LmDeploy-inference-acceleration-and-deployment.md
@@ -19,6 +19,7 @@ git clone https://github.com/modelscope/swift.git
 cd swift
 pip install -e '.[llm]'
 
+# There is a correspondence between lmdeploy and CUDA versions. Please follow the installation instructions at `https://github.com/InternLM/lmdeploy#installation`.
 pip install lmdeploy
 ```
 
diff --git a/docs/source_en/Multi-Modal/LmDeploy-inference-acceleration.md b/docs/source_en/Multi-Modal/LmDeploy-inference-acceleration.md
@@ -18,6 +18,7 @@ git clone https://github.com/modelscope/swift.git
 cd swift
 pip install -e '.[llm]'
 
+# There is a correspondence between lmdeploy and CUDA versions. Please follow the installation instructions at `https://github.com/InternLM/lmdeploy#installation`.
 pip install lmdeploy
 ```
 
diff --git a/docs/source_en/Multi-Modal/index.md b/docs/source_en/Multi-Modal/index.md
@@ -13,9 +13,10 @@ A single round of dialogue can contain multiple images (or no images):
 1. [Qwen-VL Best Practice](qwen-vl-best-practice.md)
 2. [Qwen-Audio Best Practice](qwen-audio-best-practice.md)
 3. [Llava Best Practice](llava-best-practice.md), [LLava Video Best Practice](llava-video-best-practice.md)
-4. [Deepseek-VL Best Practice](deepseek-vl-best-practice.md)
-5. [Internlm2-Xcomposers Best Practice](internlm-xcomposer2-best-practice.md)
-6. [Phi3-Vision Best Practice](phi3-vision-best-practice.md)
+4. [InternVL Series Best Practice](internvl-best-practice.md)
+5. [Deepseek-VL Best Practice](deepseek-vl-best-practice.md)
+6. [Internlm2-Xcomposers Best Practice](internlm-xcomposer2-best-practice.md)
+7. [Phi3-Vision Best Practice](phi3-vision-best-practice.md)
 
 
 A single round of dialogue can only contain one image:
@@ -25,4 +26,3 @@ A single round of dialogue can only contain one image:
 The entire conversation revolves around one image.
 1. [CogVLM Best Practice](cogvlm-best-practice.md), [CogVLM2 Best Practice](cogvlm2-best-practice.md), [GLM4V Best Practice](glm4v-best-practice.md), [CogVLM2-Video Best Practice](cogvlm2-video-best-practice.md)
 2. [MiniCPM-V Best Practice](minicpm-v-best-practice.md)
-3. [InternVL-Chat-V1.5 Best Practice](internvl-best-practice.md)
diff --git a/docs/source_en/index.rst b/docs/source_en/index.rst
@@ -51,25 +51,25 @@ Swift DOCUMENTATION
    :caption: Multi-Modal LLM Training and Inference
 
    Multi-Modal/index.md
+   Multi-Modal/human-preference-alignment-training-documentation.md
+   Multi-Modal/LmDeploy-inference-acceleration.md
+   Multi-Modal/vllm-inference-acceleration.md
+   Multi-Modal/mutlimodal-deployment.md
    Multi-Modal/qwen-vl-best-practice.md
    Multi-Modal/qwen-audio-best-practice.md
+   Multi-Modal/llava-best-practice.md
+   Multi-Modal/llava-video-best-practice.md
+   Multi-Modal/internvl-best-practice.md
    Multi-Modal/deepseek-vl-best-practice.md
    Multi-Modal/internlm-xcomposer2-best-practice.md
    Multi-Modal/phi3-vision-best-practice.md
-   Multi-Modal/llava-best-practice.md
-   Multi-Modal/llava-video-best-practice.md
    Multi-Modal/yi-vl-best-practice.md
    Multi-Modal/florence-best-pratice.md
    Multi-Modal/cogvlm-best-practice.md
    Multi-Modal/cogvlm2-best-practice.md
    Multi-Modal/glm4v-best-practice.md
    Multi-Modal/cogvlm2-video-best-practice.md
    Multi-Modal/minicpm-v-best-practice.md
-   Multi-Modal/internvl-best-practice.md
-   Multi-Modal/human-preference-alignment-training-documentation.md
-   Multi-Modal/LmDeploy-inference-acceleration.md
-   Multi-Modal/vllm-inference-acceleration.md
-   Multi-Modal/mutlimodal-deployment.md
 
 .. toctree::
    :maxdepth: 2
