Procházet zdrojové kódy

docs: improve clarity and formatting in advanced_cli_parameters.md, docker_deployment.md, and index.md

myhloli před 4 měsíci
rodič
revize
3ff5bb3e67

+ 2 - 0
docs/zh/quick_start/docker_deployment.md

@@ -38,6 +38,7 @@ docker run --gpus all \
 执行该命令后,您将进入到Docker容器的交互式终端,并映射了一些端口用于可能会使用的服务,您可以直接在容器内运行MinerU相关命令来使用MinerU的功能。
 您也可以直接通过替换`/bin/bash`为服务启动命令来启动MinerU服务,详细说明请参考[MinerU使用文档](../usage/index_back.md)。
 
+
 ## 通过 Docker Compose 直接启动服务
 
 我们提供了`compose.yml`文件,您可以通过它来快速启动MinerU服务。
@@ -46,6 +47,7 @@ docker run --gpus all \
 # 下载 compose.yaml 文件
 wget https://gcore.jsdelivr.net/gh/opendatalab/MinerU@master/docker/compose.yaml
 ```
+
 - 启动`sglang-server`服务,并通过`vlm-sglang-client`后端连接`sglang-server`:
   ```bash
   docker compose -f compose.yaml --profile mineru-sglang-server up -d

+ 1 - 1
docs/zh/quick_start/index.md

@@ -77,7 +77,7 @@ uv pip install -e .[core] -i https://mirrors.aliyun.com/pypi/simple
 
 > [!TIP]
 > `mineru[core]`包含除`sglang`加速外的所有核心功能,兼容Windows / Linux / macOS系统,适合绝大多数用户。
-> 如果您有使用`sglang`加速VLM模型推理,或是在边缘设备安装轻量版client端等需求,可以参考文档[安装扩展模块指南](./extension_modules.md)。
+> 如果您有使用`sglang`加速VLM模型推理,或是在边缘设备安装轻量版client端等需求,可以参考文档[扩展模块安装指南](./extension_modules.md)。
 
 ---
  

+ 6 - 4
docs/zh/usage/advanced_cli_parameters.md

@@ -5,7 +5,8 @@
 ### 显存优化参数
 > [!TIP]
 > sglang加速模式目前支持在最低8G显存的Turing架构显卡上运行,但在显存<24G的显卡上可能会遇到显存不足的问题, 可以通过使用以下参数来优化显存使用:
-> - 如果您使用单张显卡遇到显存不足的情况时,可能需要调低KV缓存大小,`--mem-fraction-static 0.5`,如仍出现显存不足问题,可尝试进一步降低到`0.4`或更低。
+> 
+> - 如果您使用单张显卡遇到显存不足的情况时,可能需要调低KV缓存大小,`--mem-fraction-static 0.5`,如仍出现显存不足问题,可尝试进一步降低到`0.4`或更低
 > - 如您有两张以上显卡,可尝试通过张量并行(TP)模式简单扩充可用显存:`--tp-size 2`
 
 ### 性能优化参数
@@ -24,7 +25,7 @@
 
 ### CUDA_VISIBLE_DEVICES 基本用法
 > [!TIP]
-> - 任何情况下,您都可以通过在命令行的开头添加`CUDA_VISIBLE_DEVICES` 环境变量来指定可见的 GPU 设备。例如
+> - 任何情况下,您都可以通过在命令行的开头添加`CUDA_VISIBLE_DEVICES` 环境变量来指定可见的 GPU 设备:
 >   ```bash
 >   CUDA_VISIBLE_DEVICES=1 mineru -p <input_path> -o <output_path>
 >   ```
@@ -42,13 +43,14 @@
 >   ```
 
 ### 实际应用场景
+
 > [!TIP]
 > 以下是一些可能的使用场景:
-> - 如果您有多张显卡,需要指定卡0和卡1,并使用多卡并行来启动'sglang-server',可以使用以下命令:
+> - 如果您有多张显卡,需要指定卡0和卡1,并使用多卡并行来启动'sglang-server',可以使用以下命令: 
 >   ```bash
 >   CUDA_VISIBLE_DEVICES=0,1 mineru-sglang-server --port 30000 --dp-size 2
 >   ```
-> - 如果您有多张显卡,需要在卡0和卡1上启动两个`fastapi`服务,并分别监听不同的端口,可以使用以下命令:
+> - 如果您有多张显卡,需要在卡0和卡1上启动两个`fastapi`服务,并分别监听不同的端口,可以使用以下命令: 
 >   ```bash
 >   # 在终端1中
 >   CUDA_VISIBLE_DEVICES=0 mineru-api --host 127.0.0.1 --port 8000