diff --git a/tutorials/article-implementation/ArticleReproduction_CV.md b/tutorials/article-implementation/ArticleReproduction_CV.md new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/tutorials/article-implementation/ArticleReproduction_NLP.md b/tutorials/article-implementation/ArticleReproduction_NLP.md new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/tutorials/article-implementation/ArticleReproduction_REC.md b/tutorials/article-implementation/ArticleReproduction_REC.md new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/tutorials/pp-series/README.md b/tutorials/pp-series/README.md new file mode 100644 index 0000000000000000000000000000000000000000..599a7f2df942c7164e9b7607302773ea30dd0d46 --- /dev/null +++ b/tutorials/pp-series/README.md @@ -0,0 +1,36 @@ +# 飞桨训推一体全流程（TIPC）开发文档 + +## 1. TIPC简介 + +飞桨除了基本的模型训练和预测，还提供了支持多端多平台的高性能推理部署工具。飞桨训推一体全流程（Training and Inference Pipeline Criterion(TIPC)）旨在建立模型从学术研究到产业落地的桥梁，方便模型更广泛的使用。 + +
+ +
+ +## 2. 不同环境不同训练推理方式的开发文档 + +- [Linux GPU/CPU 基础训练推理开发文档](./train_infer_python/README.md) + +- 更多训练方式开发文档 + - [Linux GPU 多机多卡训练推理开发文档](./train_fleet_infer_python/README.md) + - [Linux GPU 混合精度训练推理开发文档](./train_amp_infer_python/README.md) + +- 更多部署方式开发文档 + - [Linux GPU/CPU PYTHON 服务化部署开发文档](./serving_python/README.md) + - [Linux GPU/CPU C++ 服务化部署开发文档](./serving_cpp/README.md) + - [Linux GPU/CPU C++ 推理开发文档](./infer_cpp/README.md) + - [Paddle.js 部署开发文档](./paddlejs/README.md) + - [Paddle2ONNX 开发文档](./paddle2onnx/README.md) + - ARM CPU 部署开发文档 (coming soon) + - OpenCL ARM GPU 部署开发文档 (coming soon) + - Metal ARM GPU 部署开发文档 (coming soon) + - Jetson 部署开发文档 (coming soon) + - XPU 部署开发文档 (coming soon) + +- 更多训练环境开发文档 + - Linux XPU2 基础训练推理开发文档 (coming soon) + - Linux DCU 基础训练推理开发文档 (coming soon) + - Linux NPU 基础训练推理开发文档 (coming soon) + - Windows GPU 基础训练推理开发文档 (coming soon) + - macOS CPU 基础训练推理开发文档 (coming soon) diff --git a/tutorials/tipc/.ipynb_checkpoints/README-checkpoint.md b/tutorials/tipc/.ipynb_checkpoints/README-checkpoint.md new file mode 100644 index 0000000000000000000000000000000000000000..599a7f2df942c7164e9b7607302773ea30dd0d46 --- /dev/null +++ b/tutorials/tipc/.ipynb_checkpoints/README-checkpoint.md @@ -0,0 +1,36 @@ +# 飞桨训推一体全流程（TIPC）开发文档 + +## 1. TIPC简介 + +飞桨除了基本的模型训练和预测，还提供了支持多端多平台的高性能推理部署工具。飞桨训推一体全流程（Training and Inference Pipeline Criterion(TIPC)）旨在建立模型从学术研究到产业落地的桥梁，方便模型更广泛的使用。 + +
+ +
+ +## 2. 不同环境不同训练推理方式的开发文档 + +- [Linux GPU/CPU 基础训练推理开发文档](./train_infer_python/README.md) + +- 更多训练方式开发文档 + - [Linux GPU 多机多卡训练推理开发文档](./train_fleet_infer_python/README.md) + - [Linux GPU 混合精度训练推理开发文档](./train_amp_infer_python/README.md) + +- 更多部署方式开发文档 + - [Linux GPU/CPU PYTHON 服务化部署开发文档](./serving_python/README.md) + - [Linux GPU/CPU C++ 服务化部署开发文档](./serving_cpp/README.md) + - [Linux GPU/CPU C++ 推理开发文档](./infer_cpp/README.md) + - [Paddle.js 部署开发文档](./paddlejs/README.md) + - [Paddle2ONNX 开发文档](./paddle2onnx/README.md) + - ARM CPU 部署开发文档 (coming soon) + - OpenCL ARM GPU 部署开发文档 (coming soon) + - Metal ARM GPU 部署开发文档 (coming soon) + - Jetson 部署开发文档 (coming soon) + - XPU 部署开发文档 (coming soon) + +- 更多训练环境开发文档 + - Linux XPU2 基础训练推理开发文档 (coming soon) + - Linux DCU 基础训练推理开发文档 (coming soon) + - Linux NPU 基础训练推理开发文档 (coming soon) + - Windows GPU 基础训练推理开发文档 (coming soon) + - macOS CPU 基础训练推理开发文档 (coming soon) diff --git a/tutorials/tipc/EngineeringLandingComp.md b/tutorials/tipc/EngineeringLandingComp.md new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/tutorials/tipc/README.md b/tutorials/tipc/README.md new file mode 100644 index 0000000000000000000000000000000000000000..599a7f2df942c7164e9b7607302773ea30dd0d46 --- /dev/null +++ b/tutorials/tipc/README.md @@ -0,0 +1,36 @@ +# 飞桨训推一体全流程（TIPC）开发文档 + +## 1. TIPC简介 + +飞桨除了基本的模型训练和预测，还提供了支持多端多平台的高性能推理部署工具。飞桨训推一体全流程（Training and Inference Pipeline Criterion(TIPC)）旨在建立模型从学术研究到产业落地的桥梁，方便模型更广泛的使用。 + +
+ +
+ +## 2. 不同环境不同训练推理方式的开发文档 + +- [Linux GPU/CPU 基础训练推理开发文档](./train_infer_python/README.md) + +- 更多训练方式开发文档 + - [Linux GPU 多机多卡训练推理开发文档](./train_fleet_infer_python/README.md) + - [Linux GPU 混合精度训练推理开发文档](./train_amp_infer_python/README.md) + +- 更多部署方式开发文档 + - [Linux GPU/CPU PYTHON 服务化部署开发文档](./serving_python/README.md) + - [Linux GPU/CPU C++ 服务化部署开发文档](./serving_cpp/README.md) + - [Linux GPU/CPU C++ 推理开发文档](./infer_cpp/README.md) + - [Paddle.js 部署开发文档](./paddlejs/README.md) + - [Paddle2ONNX 开发文档](./paddle2onnx/README.md) + - ARM CPU 部署开发文档 (coming soon) + - OpenCL ARM GPU 部署开发文档 (coming soon) + - Metal ARM GPU 部署开发文档 (coming soon) + - Jetson 部署开发文档 (coming soon) + - XPU 部署开发文档 (coming soon) + +- 更多训练环境开发文档 + - Linux XPU2 基础训练推理开发文档 (coming soon) + - Linux DCU 基础训练推理开发文档 (coming soon) + - Linux NPU 基础训练推理开发文档 (coming soon) + - Windows GPU 基础训练推理开发文档 (coming soon) + - macOS CPU 基础训练推理开发文档 (coming soon) diff --git a/tutorials/tipc/images/tipc_guide.png b/tutorials/tipc/images/tipc_guide.png new file mode 100644 index 0000000000000000000000000000000000000000..319ac819daff38ed77e84cdff2b122e8bc4a8e5f Binary files /dev/null and b/tutorials/tipc/images/tipc_guide.png differ diff --git a/tutorials/tipc/infer_cpp/README.md b/tutorials/tipc/infer_cpp/README.md new file mode 100644 index 0000000000000000000000000000000000000000..e996e6bfa914dbfae576e5baa65ec04dce59796f --- /dev/null +++ b/tutorials/tipc/infer_cpp/README.md @@ -0,0 +1,11 @@ +# Linux GPU/CPU C++ 推理开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. C++推理功能开发与规范](#2) + - [2.1 开发流程](#2.1) + - [2.2 核验点](#2.2) +- [3. C++推理功能测试开发与规范](#3) + - [3.1 开发流程](#3.1) + - [3.2 核验点](#3.2) diff --git a/tutorials/tipc/infer_cpp/infer_cpp.md b/tutorials/tipc/infer_cpp/infer_cpp.md new file mode 100644 index 0000000000000000000000000000000000000000..ad748eb1f4c2fbd97574b36ce823267ebec42bd2 --- /dev/null +++ b/tutorials/tipc/infer_cpp/infer_cpp.md @@ -0,0 +1,8 @@ +# Linux GPU/CPU C++ 推理功能开发文档 + +# 目录 + +- [1. 简介](#1---) +- [2. 基本C++推理功能开发](#2---) +- [3. 高级C++推理功能开发](#3---) +- [4. FAQ](#4---) diff --git a/tutorials/tipc/infer_cpp/test_infer_cpp.md b/tutorials/tipc/infer_cpp/test_infer_cpp.md new file mode 100644 index 0000000000000000000000000000000000000000..d8dc7821ebf3834f4761c7e723b2fee10ff54762 --- /dev/null +++ b/tutorials/tipc/infer_cpp/test_infer_cpp.md @@ -0,0 +1,8 @@ +# Linux GPU/CPU C++ 推理功能测试开发文档 + +# 目录 + +- [1. 简介](#1---) +- [2. 基本C++推理功能测试开发](#2---) +- [3. 高级C++推理功能测试开发](#3---) +- [4. FAQ](#4---) diff --git a/tutorials/tipc/infer_python_jeston/README.md b/tutorials/tipc/infer_python_jeston/README.md new file mode 100644 index 0000000000000000000000000000000000000000..9edf23c1585eca22ebd395db639c367a0820c696 --- /dev/null +++ b/tutorials/tipc/infer_python_jeston/README.md @@ -0,0 +1 @@ +coming soon! diff --git a/tutorials/tipc/lite_infer_cpp_arm_cpu/README.md b/tutorials/tipc/lite_infer_cpp_arm_cpu/README.md new file mode 100644 index 0000000000000000000000000000000000000000..9edf23c1585eca22ebd395db639c367a0820c696 --- /dev/null +++ b/tutorials/tipc/lite_infer_cpp_arm_cpu/README.md @@ -0,0 +1 @@ +coming soon! diff --git a/tutorials/tipc/lite_infer_cpp_arm_gpu_opencl/README.md b/tutorials/tipc/lite_infer_cpp_arm_gpu_opencl/README.md new file mode 100644 index 0000000000000000000000000000000000000000..9edf23c1585eca22ebd395db639c367a0820c696 --- /dev/null +++ b/tutorials/tipc/lite_infer_cpp_arm_gpu_opencl/README.md @@ -0,0 +1 @@ +coming soon! diff --git a/tutorials/tipc/macos_train_infer_python/README.md b/tutorials/tipc/macos_train_infer_python/README.md new file mode 100644 index 0000000000000000000000000000000000000000..9edf23c1585eca22ebd395db639c367a0820c696 --- /dev/null +++ b/tutorials/tipc/macos_train_infer_python/README.md @@ -0,0 +1 @@ +coming soon! diff --git a/tutorials/tipc/paddle2onnx/README.md b/tutorials/tipc/paddle2onnx/README.md new file mode 100644 index 0000000000000000000000000000000000000000..623ab8bbae61c4e84412508a19b967a4d18735c0 --- /dev/null +++ b/tutorials/tipc/paddle2onnx/README.md @@ -0,0 +1,11 @@ +# Paddle2ONNX 开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. Paddle2ONNX功能开发与规范](#2) + - [2.1 开发流程](#2.1) + - [2.2 核验点](#2.2) +- [3. Paddle2ONNX功能测试开发与规范](#3) + - [3.1 开发流程](#3.1) + - [3.2 核验点](#3.2) diff --git a/tutorials/tipc/paddle2onnx/paddle2onnx.md b/tutorials/tipc/paddle2onnx/paddle2onnx.md new file mode 100644 index 0000000000000000000000000000000000000000..f9968114bda8a071d795cf5776c5d521245a950d --- /dev/null +++ b/tutorials/tipc/paddle2onnx/paddle2onnx.md @@ -0,0 +1,7 @@ +# Paddle2ONNX功能开发文档 + +# 目录 + +- [1. 简介](#1---) +- [2. Paddle2ONNX功能开发](#2---) +- [3. FAQ](#3---) diff --git a/tutorials/tipc/paddle2onnx/test_paddle2onnx.md b/tutorials/tipc/paddle2onnx/test_paddle2onnx.md new file mode 100644 index 0000000000000000000000000000000000000000..240eaa31dbf43eddda1d1cfb8b8be0182078fe0a --- /dev/null +++ b/tutorials/tipc/paddle2onnx/test_paddle2onnx.md @@ -0,0 +1,7 @@ +# Paddle2ONNX功能测试开发文档 + +# 目录 + +- [1. 简介](#1---) +- [2. Paddle2ONNX功能测试开发](#2---) +- [3. FAQ](#3---) diff --git a/tutorials/tipc/paddlejs/README.md b/tutorials/tipc/paddlejs/README.md new file mode 100644 index 0000000000000000000000000000000000000000..8d66f19315821c05bd33c4caa7594265f1658a71 --- /dev/null +++ b/tutorials/tipc/paddlejs/README.md @@ -0,0 +1,11 @@ +# Paddle.js 部署开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. Paddle.js部署功能开发与规范](#2) + - [2.1 开发流程](#2.1) + - [2.2 核验点](#2.2) +- [3. Paddle.js部署测试开发与规范](#3) + - [3.1 开发流程](#3.1) + - [3.2 核验点](#3.2) diff --git a/tutorials/tipc/paddlejs/paddlejs.md b/tutorials/tipc/paddlejs/paddlejs.md new file mode 100644 index 0000000000000000000000000000000000000000..d6258ea7d2d70ebbdcab9a1755aae3e6d6d42211 --- /dev/null +++ b/tutorials/tipc/paddlejs/paddlejs.md @@ -0,0 +1,8 @@ +# Paddle.js 部署功能开发文档 + +# 目录 + +- [1. 简介](#1---) +- [2. WEB 部署功能开发](#2---) +- [3. Node.js 部署功能开发](#3---) +- [4. FAQ](#4---) diff --git a/tutorials/tipc/paddlejs/test_paddlejs.md b/tutorials/tipc/paddlejs/test_paddlejs.md new file mode 100644 index 0000000000000000000000000000000000000000..6a2c69fdf27ab1911ccf5a835f4a6a6d95c3b455 --- /dev/null +++ b/tutorials/tipc/paddlejs/test_paddlejs.md @@ -0,0 +1,10 @@ +# Paddle.js 部署功能测试开发文档 + +# 目录 + +- [1. 简介](#1---) +- [2. WEB 部署功能测试开发](#2---) +- [3. Node.js 部署功能测试开发](#3---) +- [4. FAQ](#4---) + + diff --git a/tutorials/tipc/serving_cpp/README.md b/tutorials/tipc/serving_cpp/README.md new file mode 100644 index 0000000000000000000000000000000000000000..e1ea698c26f8ee1703175d8181f1f884b9596a1c --- /dev/null +++ b/tutorials/tipc/serving_cpp/README.md @@ -0,0 +1,11 @@ +# Linux GPU/CPU C++ 服务化部署开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 服务化部署功能开发与规范](#2) + - [2.1 开发流程](#2.1) + - [2.2 核验点](#2.2) +- [3. 服务化部署测试开发与规范](#3) + - [3.1 开发流程](#3.1) + - [3.2 核验点](#3.2) diff --git a/tutorials/tipc/serving_cpp/serving_cpp.md b/tutorials/tipc/serving_cpp/serving_cpp.md new file mode 100644 index 0000000000000000000000000000000000000000..63446e92ed33b57bdc15594348b718fc56d14162 --- /dev/null +++ b/tutorials/tipc/serving_cpp/serving_cpp.md @@ -0,0 +1,8 @@ +# Linux GPU/CPU C++ 服务化部署功能开发文档 + +# 目录 + +- [1. 简介](#1---) +- [2. 基本服务化部署功能开发](#2---) +- [3. 高级服务化部署功能开发](#3---) +- [4. FAQ](#4---) diff --git a/tutorials/tipc/serving_cpp/test_serving_cpp.md b/tutorials/tipc/serving_cpp/test_serving_cpp.md new file mode 100644 index 0000000000000000000000000000000000000000..deb1a1f912edd4f113d0f353aefcd5c751cd11ef --- /dev/null +++ b/tutorials/tipc/serving_cpp/test_serving_cpp.md @@ -0,0 +1,9 @@ +# Linux GPU/CPU C++ 服务化部署测试开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 基本服务化部署功能测试开发](#2---) +- [3. 高级服务化部署功能测试开发](#3---) +- [4. FAQ](#4) + diff --git a/tutorials/tipc/serving_python/README.md b/tutorials/tipc/serving_python/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6d15c018f6954f68b883c488086ea7f6fc293c68 --- /dev/null +++ b/tutorials/tipc/serving_python/README.md @@ -0,0 +1,11 @@ +# Linux GPU/CPU PYTHON 服务化部署开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 服务化部署功能开发与规范](#2) + - [2.1 开发流程](#2.1) + - [2.2 核验点](#2.2) +- [3. 服务化部署测试开发与规范](#3) + - [3.1 开发流程](#3.1) + - [3.2 核验点](#3.2) diff --git a/tutorials/tipc/serving_python/serving_python.md b/tutorials/tipc/serving_python/serving_python.md new file mode 100644 index 0000000000000000000000000000000000000000..d952930008249ec8b4a9771bcecc22a5d3b4d915 --- /dev/null +++ b/tutorials/tipc/serving_python/serving_python.md @@ -0,0 +1,8 @@ +# Linux GPU/CPU PYTHON 服务化部署功能开发文档 + +# 目录 + +- [1. 简介](#1---) +- [2. 基本服务化部署功能开发](#2---) +- [3. 高级服务化部署功能开发](#3---) +- [4. FAQ](#4---) diff --git a/tutorials/tipc/serving_python/test_serving_python.md b/tutorials/tipc/serving_python/test_serving_python.md new file mode 100644 index 0000000000000000000000000000000000000000..3a35fd84a348f6501440273102b3d183a3eb958d --- /dev/null +++ b/tutorials/tipc/serving_python/test_serving_python.md @@ -0,0 +1,9 @@ +# Linux GPU/CPU PYTHON 服务化部署测试开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 基本服务化部署功能测试开发](#2---) +- [3. 高级服务化部署功能测试开发](#3---) +- [4. FAQ](#4) + diff --git a/tutorials/tipc/train_amp_infer_python/README.md b/tutorials/tipc/train_amp_infer_python/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f960d9d4a614b5d981e6f323f058eb1bef405f82 --- /dev/null +++ b/tutorials/tipc/train_amp_infer_python/README.md @@ -0,0 +1,11 @@ +# Linux GPU 多机多卡训练推理开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 多机多卡训练功能开发与规范](#2) + - [2.1 开发流程](#2.1) + - [2.2 核验点](#2.2) +- [3. 多机多卡训练推理测试开发与规范](#3) + - [3.1 开发流程](#3.1) + - [3.2 核验点](#3.2) diff --git a/tutorials/tipc/train_amp_infer_python/amp.md b/tutorials/tipc/train_amp_infer_python/amp.md new file mode 100644 index 0000000000000000000000000000000000000000..7a5379d93a0eb48465edf95d1ea4dff25c105fae --- /dev/null +++ b/tutorials/tipc/train_amp_infer_python/amp.md @@ -0,0 +1,7 @@ +# Linux GPU 混合精度训练功能开发文档 + +# 目录 + +- [1. 简介](#1---) +- [2. 混合精度训练功能开发](#2---) +- [3. FAQ](#3---) diff --git a/tutorials/tipc/train_amp_infer_python/test_train_amp_infer_python.md b/tutorials/tipc/train_amp_infer_python/test_train_amp_infer_python.md new file mode 100644 index 0000000000000000000000000000000000000000..4c8213dcc2a6f6b95a3f79424b4218ce2984454a --- /dev/null +++ b/tutorials/tipc/train_amp_infer_python/test_train_amp_infer_python.md @@ -0,0 +1,8 @@ +# Linux GPU 混合精度训练推理测试开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 混合精度训练推理功能测试开发](#2---) +- [3. FAQ](#3) + diff --git a/tutorials/tipc/train_fleet_infer_python/README.md b/tutorials/tipc/train_fleet_infer_python/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f960d9d4a614b5d981e6f323f058eb1bef405f82 --- /dev/null +++ b/tutorials/tipc/train_fleet_infer_python/README.md @@ -0,0 +1,11 @@ +# Linux GPU 多机多卡训练推理开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 多机多卡训练功能开发与规范](#2) + - [2.1 开发流程](#2.1) + - [2.2 核验点](#2.2) +- [3. 多机多卡训练推理测试开发与规范](#3) + - [3.1 开发流程](#3.1) + - [3.2 核验点](#3.2) diff --git a/tutorials/tipc/train_fleet_infer_python/fleet.md b/tutorials/tipc/train_fleet_infer_python/fleet.md new file mode 100644 index 0000000000000000000000000000000000000000..04d6fef094805f93bf498797207dde94cf1edc7e --- /dev/null +++ b/tutorials/tipc/train_fleet_infer_python/fleet.md @@ -0,0 +1,8 @@ +# Linux GPU 多机多卡训练功能开发文档 + +# 目录 + +- [1. 简介](#1---) +- [2. 基本多机多卡训练功能开发](#2---) +- [3. 高级多机多卡训练功能开发](#3---) +- [4. FAQ](#4---) diff --git a/tutorials/tipc/train_fleet_infer_python/test_train_fleet_infer_python.md b/tutorials/tipc/train_fleet_infer_python/test_train_fleet_infer_python.md new file mode 100644 index 0000000000000000000000000000000000000000..505c449d438d86790a223797fa09abc60b8cf9ff --- /dev/null +++ b/tutorials/tipc/train_fleet_infer_python/test_train_fleet_infer_python.md @@ -0,0 +1,9 @@ +# Linux GPU 多机多卡训练推理测试开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 基本多机多卡训练推理功能测试开发](#2---) +- [3. 高级多机多卡训练推理功能测试开发](#3---) +- [4. FAQ](#4) + diff --git a/tutorials/tipc/train_infer_python/README.md b/tutorials/tipc/train_infer_python/README.md new file mode 100644 index 0000000000000000000000000000000000000000..bc2c650a0356065f7e467b7651a45383c93d7895 --- /dev/null +++ b/tutorials/tipc/train_infer_python/README.md @@ -0,0 +1,179 @@ +# Linux GPU/CPU 基础训练推理开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 模型复现流程与规范](#2) + - [2.1 复现流程](#2.1) + - [2.2 核验点](#2.2) +- [3. 模型推理开发与规范](#3) + - [3.1 开发流程](#3.1) + - [3.2 核验点](#3.2) +- [4. 基础训练推理测试开发与规范](4) + - [4.1 开发流程](#4.1) + - [4.2 核验点](#4.2) + + + +## 1. 简介 + +该系列文档主要介绍飞桨模型基于 Linux GPU/CPU 基础训练推理开发过程，主要包含三个步骤。 + +- 步骤一：参考 [《模型复现指南》](../../lwfx/ArticleReproduction_CV.md)，完成模型的训练与基于训练引擎的预测程序开发。 + +- 步骤二：参考[《Linux GPU/CPU 模型推理开发文档》](./infer_python.md)，在基于训练引擎预测的基础上，完成基于Paddle Inference的推理程序开发。 + +- 步骤三：参考[《Linux GPU/CPU 基础训练推理测试开发文档》](./test_train_infer_python.md)，完成Linux GPU/CPU 训练、推理测试功能开发。 + + + +## 2. 模型复现流程与规范 + + + +### 2.1 复现流程 + +如果您对于模型复现过程已经非常熟悉，在复现过程中可以按照自己的复现方法进行复现。但是需要注意训练日志与文档内容符合规范。可以参考`2.2章节`。 + +如果您在模型复现方面经验较少，或者复现过程中遇到问题，希望快速排查问题，强烈建议您按照模型复现指南进行操作。以CV任务为例，复现指南将模型复现分为13个步骤，如下所示。 + +
+ +
+ +更多内容请参考：[模型复现指南](../../lwfx/ArticleReproduction_CV.md)。 + + + +### 2.2 核验点 + +在模型复现过程中，至少需要产出下面的内容。 + +#### 2.2.1 小数据集 + +**【参考】** + +* [模型复现指南](../../lwfx/ArticleReproduction_CV.md)中`3.2`章节。 + +**【要求】** + +repo中包含`lite_data`小数据集压缩包，解压之后可以获取`lite_data`小数据集文件夹。该数据集可以便于快速验证训练过程的能否跑通，其中包含的数据也可以用于验证推理部署过程。 + + +#### 2.2.2 代码与精度 + +**【参考】** + +* [模型复现指南](../../lwfx/ArticleReproduction_CV.md)中第`3`章节。 + +**【要求】** + +* 代码中包含训练(`train.py`)、评估(`eval.py`)、预测(`predict.py`)的脚本，分别作为模型训练、评估、预测的入口。 + +* 模型结构、数据预处理/后处理、优化器、预训练模型与参考代码保持一致。 + +#### 2.2.3 训练日志 + +**【参考】** + +[模型复现指南](../../lwfx/ArticleReproduction_CV.md)中`3.12`章节。 + +**【要求】** + +* 日志文件中，每个迭代过程的输出信息至少包含`loss`, `avg_reader_cost`, `avg_batch_cost`, `avg_ips`关键字段。含义如下所示。 + * `loss`: 过去若干个iter的loss值 + * `avg_reader_cost`: 过去若干个iter的平均reader耗时 (单位: sec) + * `avg_batch_cost`: 过去若干个iter的平均训练耗时 (单位: sec) + * `avg_ips`: 过段若干个iter个训练速度（单位: images/sec） + +#### 2.2.4 基于训练引擎的预测程序 + +**【参考】** + +* [模型复现指南](../../lwfx/ArticleReproduction_CV.md)中`3.13`章节。 + +**【要求】** + +提供基于训练引擎的预测脚本与命令，文档需要提供示例图片，并根据示例图片，可视化出使用提供的预测命令运行得到的结果。 + +#### 2.2.5 文档 + +**【参考】** + +* [repo模板首页文档](../../../community/repo_template/README.md)。 + +**【要求】** + +* 按照参考`repo模板首页文档`的内容，添加对应的信息。 + + + +## 3. 模型推理开发规范 + + + +### 3.1 开发流程 + +基于Paddle Inference的预测过程分为下面9个步骤。 + +
+ +
+ +更多的介绍可以参考：[模型推理开发规范](./inference.md)。 + + + +### 3.2 核验点 + +#### 3.2.1 代码与预测结果 + +* 项目中需要包含`模型动转静`脚本(`export_model.py`)以及`模型基于 Paddle Inference 的`预测脚本(`infer.py`)。 + +#### 3.2.2 文档 + +* 说明文档中，需要包含`模型动转静`和`模型基于预测引擎`的使用命令说明。 + + + +## 4. 基础训练推理测试开发规范 + + + +### 4.1 开发流程 + +基础训练推理测试开发的流程如下所示。 + +
+ +
+ +更多的介绍可以参考：[Linux GPU/CPU 基础训练推理测试开发规范](./test_linux_train_infer_python.md)。 + + + + +### 4.2 核验点 + +#### 4.2.1 目录结构 + +在repo根目录下面新建`test_tipc`文件夹，目录结构如下所示。 + +``` +test_tipc + |--configs # 配置目录 + | |--model_name # 您的模型名称 + | |--train_infer_python.txt # 基础训练推理测试配置文件 + |--docs # 文档目录 + | |--test_train_inference_python.md # 基础训练推理测试说明文档 + |----README.md # TIPC说明文档 + |----test_train_inference_python.sh # TIPC基础训练推理测试解析脚本，无需改动 + |----common_func.sh # TIPC基础训练推理测试常用函数，无需改动 +``` + + +#### 4.2.2 配置文件和测试文档 + +* `test_tipc/README.md` 文档中对该模型支持的的功能进行总体介绍。 +* `test_tipc/docs/test_train_inference_python.md` 文档中对**Linux GPU/CPU 基础训练推理**的功能支持情况进行介绍。 +* 根据测试文档，基于配置文件，跑通训练推理全流程测试。 diff --git a/tutorials/tipc/train_infer_python/infer_python.md b/tutorials/tipc/train_infer_python/infer_python.md new file mode 100644 index 0000000000000000000000000000000000000000..c64b3e78d4f8e0d5e91481eb39ca4b828b525963 --- /dev/null +++ b/tutorials/tipc/train_infer_python/infer_python.md @@ -0,0 +1,9 @@ +# Linux GPU/CPU 模型推理开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 基本推理功能开发](#2) +- [3. 高级推理功能开发](#3) +- [4. FAQ](#4) + diff --git a/tutorials/tipc/train_infer_python/test_train_infer_python.md b/tutorials/tipc/train_infer_python/test_train_infer_python.md new file mode 100644 index 0000000000000000000000000000000000000000..9feb016adbd09b72c9eafdd8781099568b89ec65 --- /dev/null +++ b/tutorials/tipc/train_infer_python/test_train_infer_python.md @@ -0,0 +1,9 @@ +# Linux GPU/CPU 基础训练推理测试开发文档 + +# 目录 + +- [1. 简介](#1) +- [2. 基本训练推理功能测试开发](#2) +- [3. 高级训练推理功能测试开发](#3) +- [4. FAQ](#4) + diff --git a/tutorials/tipc/windows_train_infer_python/README.md b/tutorials/tipc/windows_train_infer_python/README.md new file mode 100644 index 0000000000000000000000000000000000000000..9edf23c1585eca22ebd395db639c367a0820c696 --- /dev/null +++ b/tutorials/tipc/windows_train_infer_python/README.md @@ -0,0 +1 @@ +coming soon!