Skip to content

Commit 2abd91c

Browse files
authored
[cherry-pick]fix docs (#3589)
* update * update mkdocs.yml
1 parent 2325d31 commit 2abd91c

File tree

8 files changed

+348
-699
lines changed

8 files changed

+348
-699
lines changed

docs/index.md

Lines changed: 186 additions & 608 deletions
Large diffs are not rendered by default.

docs/installation/installation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ comments: true
33
---
44

55
# PaddleX本地安装教程
6-
> ❗安装 PaddleX 前请先确保您有基础的 <b>Python 运行环境</b>(注:当前支持Python 3.8 ~ Python 3.10下运行,更多Python版本适配中)。
6+
> ❗安装 PaddleX 前请先确保您有基础的 <b>Python 运行环境</b>(注:当前支持Python 3.8 ~ Python 3.12下运行)。
77
88
## 1. 快速安装
99
欢迎您使用飞桨低代码开发工具PaddleX,在我们正式开始本地安装之前,请首先明确您的开发需求,并根据您的需求选择合适的安装模式。
@@ -61,8 +61,8 @@ PaddleX支持的插件如下,请您根据开发需求,确定所需的一个
6161
</tr>
6262
<tr>
6363
<td>通用OCR</td>
64-
<td>文本检测<br>文本识别</td>
65-
<td><code>PaddleOCR</code></td>
64+
<td>文档图像方向分类<br>文本图像矫正<br>文本检测<br>文本行方向分类<br>文本识别</td>
65+
<td><code>PaddleOCR</code><br><code>PaddleClas</code></td>
6666
</tr>
6767
<tr>
6868
<td>通用表格识别</td>
@@ -131,7 +131,7 @@ paddlex --install PaddleXXX # 例如PaddleOCR
131131

132132
当您使用自定义方式安装时,需要先安装飞桨 PaddlePaddle 框架,随后获取 PaddleX 源码,最后选择PaddleX的安装模式。
133133

134-
> 注:目前 PaddleX 仅支持 11.8 和 12.3 版本的 CUDA,请确保已安装的 Nvidia 驱动支持的上述 CUDA 版本
134+
> 无需关注物理机上的 CUDA 版本,只需关注显卡驱动程序版本
135135
136136
### 2.1 基于Docker获取PaddleX
137137
参考下述命令,使用 PaddleX 官方 Docker 镜像,创建一个名为 `paddlex` 的容器,并将当前工作目录映射到容器内的 `/paddle` 目录。
@@ -143,10 +143,10 @@ paddlex --install PaddleXXX # 例如PaddleOCR
143143
docker run --name paddlex -v $PWD:/paddle --shm-size=8g --network=host -it ccr-2vdh3abv-pub.cnc.bj.baidubce.com/paddlex/paddlex:paddlex3.0.0rc0-paddlepaddle3.0.0rc0-cpu /bin/bash
144144

145145
# 对于 GPU 用户
146-
# 对于 CUDA11.8 用户
146+
# GPU 版本,需显卡驱动程序版本 ≥450.80.02(Linux)或 ≥452.39(Windows)
147147
docker run --gpus all --name paddlex -v $PWD:/paddle --shm-size=8g --network=host -it ccr-2vdh3abv-pub.cnc.bj.baidubce.com/paddlex/paddlex:paddlex3.0.0rc0-paddlepaddle3.0.0rc0-gpu-cuda11.8-cudnn8.6-trt8.5 /bin/bash
148148

149-
# 对于 CUDA12.3 用户
149+
# GPU 版本,需显卡驱动程序版本 ≥545.23.06(Linux)或 ≥545.84(Windows)
150150
docker run --gpus all --name paddlex -v $PWD:/paddle --shm-size=8g --network=host -it ccr-2vdh3abv-pub.cnc.bj.baidubce.com/paddlex/paddlex:paddlex3.0.0rc0-paddlepaddle3.0.0rc0-gpu-cuda12.3-cudnn9.0-trt8.6 /bin/bash
151151
```
152152

docs/installation/paddlepaddle_install.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ comments: true
1818
docker run --name paddlex -v $PWD:/paddle --shm-size=8G --network=host -it ccr-2vdh3abv-pub.cnc.bj.baidubce.com/paddlepaddle/paddle:3.0.0rc0 /bin/bash
1919

2020
# 对于 gpu 用户:
21-
# CUDA11.8 用户
21+
# GPU 版本,需显卡驱动程序版本 ≥450.80.02(Linux)或 ≥452.39(Windows)
2222
docker run --gpus all --name paddlex -v $PWD:/paddle --shm-size=8G --network=host -it ccr-2vdh3abv-pub.cnc.bj.baidubce.com/paddlepaddle/paddle:3.0.0rc0-gpu-cuda11.8-cudnn8.6-trt8.5 /bin/bash
2323

24-
# CUDA12.3 用户
24+
# GPU 版本,需显卡驱动程序版本 ≥545.23.06(Linux)或 ≥545.84(Windows)
2525
docker run --gpus all --name paddlex -v $PWD:/paddle --shm-size=8G --network=host -it ccr-2vdh3abv-pub.cnc.bj.baidubce.com/paddlepaddle/paddle:3.0.0rc0-gpu-cuda12.3-cudnn9.0-trt8.6 /bin/bash
2626
```
2727

@@ -57,7 +57,7 @@ python -m pip install paddlepaddle-gpu==3.0.0rc0 -i https://www.paddlepaddle.org
5757
# gpu,该命令仅适用于 CUDA 版本为 12.3 的机器环境
5858
python -m pip install paddlepaddle-gpu==3.0.0rc0 -i https://www.paddlepaddle.org.cn/packages/stable/cu123/
5959
```
60-
> ❗ <b>注</b>:更多飞桨 Wheel 版本请参考[飞桨官网](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/pip/linux-pip.html)
60+
> ❗ <b>注</b>:无需关注物理机上的 CUDA 版本,只需关注显卡驱动程序版本。更多飞桨 Wheel 版本请参考[飞桨官网](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/pip/linux-pip.html)
6161
6262
<b>关于其他硬件安装飞桨,请参考</b>[PaddleX多硬件使用指南](../other_devices_support/multi_devices_use_guide.md)<b>。</b>
6363

docs/pipeline_usage/tutorials/cv_pipelines/human_keypoint_detection.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,23 +73,43 @@ PaddleX 的人体关键点检测产线是一个 Top-Down 方案,由行人检
7373
</tr>
7474
</table>
7575

76-
**测试环境说明:**
76+
<b>测试环境说明:</b>
7777

78-
- **性能测试环境**
79-
- **测试数据集**
78+
- <b>性能测试环境</b>
79+
- <b>测试数据集</b>
8080
- 行人检测模型:CrowdHuman数据集。
8181
- 人体关键点检测模型:COCO数据集 AP(0.5:0.95),所依赖的检测框为ground truth标注得到。
82-
- **硬件配置**
82+
- <b>硬件配置</b>
8383
- GPU:NVIDIA Tesla T4
8484
- CPU:Intel Xeon Gold 6271C @ 2.60GHz
8585
- 其他环境:Ubuntu 20.04 / cuDNN 8.6 / TensorRT 8.5.2.2
8686

87-
- **推理模式说明**
88-
89-
| 模式 | GPU配置 | CPU配置 | 加速技术组合 |
90-
|-------------|----------------------------------|------------------|---------------------------------------------|
91-
| 常规模式 | FP32精度 / 无TRT加速 | FP32精度 / 8线程 | PaddleInference |
92-
| 高性能模式 | 选择先验精度类型和加速策略的最优组合 | FP32精度 / 8线程 | 选择先验最优后端(Paddle/OpenVINO/TRT等) |
87+
- <b>推理模式说明</b>
88+
89+
<table border="1">
90+
<thead>
91+
<tr>
92+
<th>模式</th>
93+
<th>GPU配置</th>
94+
<th>CPU配置</th>
95+
<th>加速技术组合</th>
96+
</tr>
97+
</thead>
98+
<tbody>
99+
<tr>
100+
<td>常规模式</td>
101+
<td>FP32精度 / 无TRT加速</td>
102+
<td>FP32精度 / 8线程</td>
103+
<td>PaddleInference</td>
104+
</tr>
105+
<tr>
106+
<td>高性能模式</td>
107+
<td>选择先验精度类型和加速策略的最优组合</td>
108+
<td>FP32精度 / 8线程</td>
109+
<td>选择先验最优后端(Paddle/OpenVINO/TRT等)</td>
110+
</tr>
111+
</tbody>
112+
</table>
93113

94114
</details>
95115

0 commit comments

Comments
 (0)