Browse Source

fix: update quick_usage.md to clarify support for vllm and lmdeploy acceleration

myhloli 1 week ago
parent
commit
376d1e38d5
2 changed files with 22 additions and 10 deletions
  1. 11 5
      docs/en/usage/quick_usage.md
  2. 11 5
      docs/zh/usage/quick_usage.md

+ 11 - 5
docs/en/usage/quick_usage.md

@@ -29,7 +29,7 @@ mineru -p <input_path> -o <output_path>
 mineru -p <input_path> -o <output_path> -b vlm-transformers
 ```
 > [!TIP]
-> The vlm backend additionally supports `vllm` acceleration. Compared to the `transformers` backend, `vllm` can achieve 20-30x speedup. You can check the installation method for the complete package supporting `vllm` acceleration in the [Extension Modules Installation Guide](../quick_start/extension_modules.md).
+> The vlm backend additionally supports `vllm`/`lmdeploy` acceleration. Compared to the `transformers` backend, inference speed can be significantly improved. You can check the installation method for the complete package supporting `vllm`/`lmdeploy` acceleration in the [Extension Modules Installation Guide](../quick_start/extension_modules.md).
 
 If you need to adjust parsing options through custom parameters, you can also check the more detailed [Command Line Tools Usage Instructions](./cli_tools.md) in the documentation.
 
@@ -48,6 +48,8 @@ If you need to adjust parsing options through custom parameters, you can also ch
   mineru-gradio --server-name 0.0.0.0 --server-port 7860
   # Or using vlm-vllm-engine/pipeline backends (requires vllm environment)
   mineru-gradio --server-name 0.0.0.0 --server-port 7860 --enable-vllm-engine true
+  # Or using vlm-lmdeploy-engine/pipeline backends (requires lmdeploy environment)
+  mineru-gradio --server-name 0.0.0.0 --server-port 7860 --enable-lmdeploy-engine true
   ```
   >[!TIP]
   >
@@ -55,8 +57,12 @@ If you need to adjust parsing options through custom parameters, you can also ch
 
 - Using `http-client/server` method:
   ```bash
-  # Start vllm server (requires vllm environment)
-  mineru-vllm-server --port 30000
+  # Start openai compatible server (requires vllm or lmdeploy environment)
+  mineru-openai-server
+  # Or start vllm server (requires vllm environment)
+  mineru-openai-server --engine vllm --port 30000
+  # Or start lmdeploy server (requires lmdeploy environment)
+  mineru-openai-server --engine lmdeploy --server-port 30000
   ``` 
   >[!TIP]
   >In another terminal, connect to vllm server via http client (only requires CPU and network, no vllm environment needed)
@@ -65,8 +71,8 @@ If you need to adjust parsing options through custom parameters, you can also ch
   > ```
 
 > [!NOTE]
-> All officially supported vllm parameters can be passed to MinerU through command line arguments, including the following commands: `mineru`, `mineru-vllm-server`, `mineru-gradio`, `mineru-api`.
-> We have compiled some commonly used parameters and usage methods for `vllm`, which can be found in the documentation [Advanced Command Line Parameters](./advanced_cli_parameters.md).
+> All officially supported `vllm/lmdeploy` parameters can be passed to MinerU through command line arguments, including the following commands: `mineru`, `mineru-openai-server`, `mineru-gradio`, `mineru-api`.
+> We have compiled some commonly used parameters and usage methods for `vllm/lmdeploy`, which can be found in the documentation [Advanced Command Line Parameters](./advanced_cli_parameters.md).
 
 ## Extending MinerU Functionality with Configuration Files
 

+ 11 - 5
docs/zh/usage/quick_usage.md

@@ -28,7 +28,7 @@ mineru -p <input_path> -o <output_path>
 mineru -p <input_path> -o <output_path> -b vlm-transformers
 ```
 > [!TIP]
-> vlm后端另外支持`vllm`加速,与`transformers`后端相比,`vllm`的加速比可达20~30倍,可以在[扩展模块安装指南](../quick_start/extension_modules.md)中查看支持`vllm`加速的完整包安装方法。
+> vlm后端另外支持`vllm`/`lmdeploy`加速,与`transformers`后端相比,推理速度可大幅提升。可以在[扩展模块安装指南](../quick_start/extension_modules.md)中查看支持`vllm`/`lmdeploy`加速的扩展包安装方法。
 
 如果需要通过自定义参数调整解析选项,您也可以在文档中查看更详细的[命令行工具使用说明](./cli_tools.md)。
 
@@ -47,6 +47,8 @@ mineru -p <input_path> -o <output_path> -b vlm-transformers
   mineru-gradio --server-name 0.0.0.0 --server-port 7860
   # 或使用 vlm-vllm-engine/pipeline 后端(需安装vllm环境)
   mineru-gradio --server-name 0.0.0.0 --server-port 7860 --enable-vllm-engine true
+  # 或使用 vlm-lmdeploy-engine/pipeline 后端(需安装lmdeploy环境)
+  mineru-gradio --server-name 0.0.0.0 --server-port 7860 --enable-lmdeploy-engine true
   ```
   >[!TIP]
   > 
@@ -54,8 +56,12 @@ mineru -p <input_path> -o <output_path> -b vlm-transformers
 
 - 使用`http-client/server`方式调用:
   ```bash
-  # 启动vllm server(需要安装vllm环境)
-  mineru-vllm-server --port 30000
+  # 启动openai兼容服务器(需要安装vllm或lmdeploy环境)
+  mineru-openai-server
+  # 或指定vllm为推理引擎(需要安装vllm环境)
+  mineru-openai-server --engine vllm --port 30000
+  # 或指定lmdeploy为推理引擎(需要安装lmdeploy环境)
+  mineru-openai-server --engine lmdeploy --server-port 30000
   ``` 
   >[!TIP]
   >在另一个终端中通过http client连接vllm server(只需cpu与网络,不需要vllm环境)
@@ -64,8 +70,8 @@ mineru -p <input_path> -o <output_path> -b vlm-transformers
   > ```
 
 > [!NOTE]
-> 所有vllm官方支持的参数都可用通过命令行参数传递给 MinerU,包括以下命令:`mineru`、`mineru-vllm-server`、`mineru-gradio`、`mineru-api`,
-> 我们整理了一些`vllm`使用中的常用参数和使用方法,可以在文档[命令行进阶参数](./advanced_cli_parameters.md)中获取。
+> 所有`vllm/lmdeploy`官方支持的参数都可用通过命令行参数传递给 MinerU,包括以下命令:`mineru`、`mineru-openai-server`、`mineru-gradio`、`mineru-api`,
+> 我们整理了一些`vllm/lmdeploy`使用中的常用参数和使用方法,可以在文档[命令行进阶参数](./advanced_cli_parameters.md)中获取。
 
 ## 基于配置文件扩展 MinerU 功能