diff --git a/deploy/cpp_shitu/README.md b/deploy/cpp_shitu/README.md new file mode 120000 index 0000000000000000000000000000000000000000..2f3929f785b2ff37ca78ff974228ac6f69149ec7 --- /dev/null +++ b/deploy/cpp_shitu/README.md @@ -0,0 +1 @@ +../../docs/zh_CN/deployment/PP-ShiTu/cpp.md \ No newline at end of file diff --git a/deploy/cpp_shitu/readme.md b/docs/zh_CN/deployment/PP-ShiTu/cpp.md similarity index 100% rename from deploy/cpp_shitu/readme.md rename to docs/zh_CN/deployment/PP-ShiTu/cpp.md diff --git a/docs/zh_CN/deployment/PP-ShiTu/PaddleLite.md b/docs/zh_CN/deployment/PP-ShiTu/paddle_lite.md similarity index 100% rename from docs/zh_CN/deployment/PP-ShiTu/PaddleLite.md rename to docs/zh_CN/deployment/PP-ShiTu/paddle_lite.md diff --git a/docs/zh_CN/deployment/PP-ShiTu/PaddleServing.md b/docs/zh_CN/deployment/PP-ShiTu/paddle_serving.md similarity index 100% rename from docs/zh_CN/deployment/PP-ShiTu/PaddleServing.md rename to docs/zh_CN/deployment/PP-ShiTu/paddle_serving.md diff --git a/docs/zh_CN/deployment/python.md b/docs/zh_CN/deployment/PP-ShiTu/python.md similarity index 53% rename from docs/zh_CN/deployment/python.md rename to docs/zh_CN/deployment/PP-ShiTu/python.md index e432326bad292c53fc86bfda8e18cf6822c8a506..8245ab2867477b51b57a43ca4eb4eda10c382f49 100644 --- a/docs/zh_CN/deployment/python.md +++ b/docs/zh_CN/deployment/PP-ShiTu/python.md @@ -4,52 +4,20 @@ ## 目录 -- [1. 图像分类模型推理](#1) -- [2. PP-ShiTu模型推理](#2) - - [2.1 主体检测模型推理](#2.1) - - [2.2 特征提取模型推理](#2.2) - - [2.3 PP-ShiTu PipeLine推理](#2.3) +- [1. PP-ShiTu模型推理](#1) + - [1.1 主体检测模型推理](#1.1) + - [1.2 特征提取模型推理](#1.2) + - [1.3 PP-ShiTu PipeLine推理](#1.3) -## 1. 图像分类推理 - -首先请参考文档[模型导出](./export_model.md)准备 inference 模型,然后进入 PaddleClas 的 `deploy` 目录下: - -```shell -cd PaddleClas/deploy -``` - -使用以下命令进行预测: - -```shell -python3.7 python/predict_cls.py -c configs/inference_cls.yaml -``` - -在配置文件 `configs/inference_cls.yaml` 中有以下字段用于配置预测参数: -* `Global.infer_imgs`:待预测的图片文件(夹)路径; -* `Global.inference_model_dir`:inference 模型文件所在文件夹的路径,该文件夹下需要有文件 `inference.pdmodel` 和 `inference.pdiparams` 两个文件; -* `Global.use_gpu`:是否使用 GPU 预测,默认为 `True`; -* `Global.enable_mkldnn`:是否启用 `MKL-DNN` 加速库,默认为 `False`。注意 `enable_mkldnn` 与 `use_gpu` 同时为 `True` 时,将忽略 `enable_mkldnn`,而使用 GPU 预测; -* `Global.use_fp16`:是否启用 `FP16`,默认为 `False`; -* `Global.use_tensorrt`:是否使用 TesorRT 预测引擎,默认为 `False`; -* `PreProcess`:用于数据预处理配置; -* `PostProcess`:由于后处理配置; -* `PostProcess.Topk.class_id_map_file`:数据集 label 的映射文件,默认为 `../ppcls/utils/imagenet1k_label_list.txt`,该文件为 PaddleClas 所使用的 ImageNet 数据集 label 映射文件。 - -**注意**: -* 如果使用 VisionTransformer 系列模型,如 `DeiT_***_384`, `ViT_***_384` 等,请注意模型的输入数据尺寸,该类模型需要修改参数: `PreProcess.resize_short=384`, `PreProcess.resize=384`。 -* 如果你希望提升评测模型速度,使用 GPU 评测时,建议开启 TensorRT 加速预测,使用 CPU 评测时,建议开启 MKL-DNN 加速预测。 - - - -## 2. PP-ShiTu模型推理 +## 1. PP-ShiTu模型推理 PP-ShiTu整个Pipeline包含三部分:主体检测、特征提取模型、特征检索。其中主体检测模型、特征提取模型可以单独推理使用。单独使用主体检测详见[主体检测模型推理](#2.1),特征提取模型单独推理详见[特征提取模型推理](#2.2), PP-ShiTu整体推理详见[PP-ShiTu PipeLine推理](#2.3)。 -### 2.1 主体检测模型推理 +### 1.1 主体检测模型推理 进入 PaddleClas 的 `deploy` 目录下: @@ -78,7 +46,7 @@ python3.7 python/predict_det.py -c configs/inference_det.yaml -### 2.2 特征提取模型推理 +### 1.2 特征提取模型推理 下面以商品图片的特征提取为例,介绍特征提取模型推理。首先进入 PaddleClas 的 `deploy` 目录下: @@ -107,8 +75,8 @@ python3.7 python/predict_rec.py -c configs/inference_rec.yaml * `Global.infer_imgs`:待预测的图片文件路径; * `Global.use_gpu`: 是否使用 GPU 预测,默认为 `True`。 - + -### 2.3. PP-ShiTu PipeLine推理 +### 1.3 PP-ShiTu PipeLine推理 主体检测、特征提取和向量检索的串联预测,可以参考[图像识别快速开始](../quick_start/quick_start_recognition.md)。 diff --git a/docs/zh_CN/deployment/image_classification/paddle2onnx.md b/docs/zh_CN/deployment/image_classification/paddle2onnx.md new file mode 120000 index 0000000000000000000000000000000000000000..b240354840069533084846bfea5053cd28c48e15 --- /dev/null +++ b/docs/zh_CN/deployment/image_classification/paddle2onnx.md @@ -0,0 +1 @@ +../../../../deploy/paddle2onnx/readme.md \ No newline at end of file diff --git a/docs/zh_CN/deployment/image_classification/PaddleHub.md b/docs/zh_CN/deployment/image_classification/paddle_hub.md similarity index 100% rename from docs/zh_CN/deployment/image_classification/PaddleHub.md rename to docs/zh_CN/deployment/image_classification/paddle_hub.md diff --git a/docs/zh_CN/deployment/image_classification/PaddleLite.md b/docs/zh_CN/deployment/image_classification/paddle_lite.md similarity index 100% rename from docs/zh_CN/deployment/image_classification/PaddleLite.md rename to docs/zh_CN/deployment/image_classification/paddle_lite.md diff --git a/docs/zh_CN/deployment/image_classification/PaddleServing.md b/docs/zh_CN/deployment/image_classification/paddle_serving.md similarity index 100% rename from docs/zh_CN/deployment/image_classification/PaddleServing.md rename to docs/zh_CN/deployment/image_classification/paddle_serving.md diff --git a/docs/zh_CN/deployment/image_classification/python.md b/docs/zh_CN/deployment/image_classification/python.md new file mode 100644 index 0000000000000000000000000000000000000000..6f7eac0095febbcc554cb368fc25d26b956b879e --- /dev/null +++ b/docs/zh_CN/deployment/image_classification/python.md @@ -0,0 +1,38 @@ +# Python 预测推理 + +首先请参考文档[环境准备](../installation/install_paddleclas.md)配置运行环境。 + +## 目录 + +- [1. 图像分类模型推理](#1) + + + +## 1. 图像分类推理 + +首先请参考文档[模型导出](./export_model.md)准备 inference 模型,然后进入 PaddleClas 的 `deploy` 目录下: + +```shell +cd PaddleClas/deploy +``` + +使用以下命令进行预测: + +```shell +python3.7 python/predict_cls.py -c configs/inference_cls.yaml +``` + +在配置文件 `configs/inference_cls.yaml` 中有以下字段用于配置预测参数: +* `Global.infer_imgs`:待预测的图片文件(夹)路径; +* `Global.inference_model_dir`:inference 模型文件所在文件夹的路径,该文件夹下需要有文件 `inference.pdmodel` 和 `inference.pdiparams` 两个文件; +* `Global.use_gpu`:是否使用 GPU 预测,默认为 `True`; +* `Global.enable_mkldnn`:是否启用 `MKL-DNN` 加速库,默认为 `False`。注意 `enable_mkldnn` 与 `use_gpu` 同时为 `True` 时,将忽略 `enable_mkldnn`,而使用 GPU 预测; +* `Global.use_fp16`:是否启用 `FP16`,默认为 `False`; +* `Global.use_tensorrt`:是否使用 TesorRT 预测引擎,默认为 `False`; +* `PreProcess`:用于数据预处理配置; +* `PostProcess`:由于后处理配置; +* `PostProcess.Topk.class_id_map_file`:数据集 label 的映射文件,默认为 `../ppcls/utils/imagenet1k_label_list.txt`,该文件为 PaddleClas 所使用的 ImageNet 数据集 label 映射文件。 + +**注意**: +* 如果使用 VisionTransformer 系列模型,如 `DeiT_***_384`, `ViT_***_384` 等,请注意模型的输入数据尺寸,该类模型需要修改参数: `PreProcess.resize_short=384`, `PreProcess.resize=384`。 +* 如果你希望提升评测模型速度,使用 GPU 评测时,建议开启 TensorRT 加速预测,使用 CPU 评测时,建议开启 MKL-DNN 加速预测。 diff --git a/docs/zh_CN/deployment/whl.md b/docs/zh_CN/deployment/image_classification/whl.md similarity index 100% rename from docs/zh_CN/deployment/whl.md rename to docs/zh_CN/deployment/image_classification/whl.md diff --git a/docs/zh_CN/models/PP-ShiTu/introduction.md b/docs/zh_CN/models/PP-ShiTu/README.md similarity index 100% rename from docs/zh_CN/models/PP-ShiTu/introduction.md rename to docs/zh_CN/models/PP-ShiTu/README.md