From 84b7b4b96d9b2ebb83fc6e96604bb85380a5abff Mon Sep 17 00:00:00 2001 From: qiaolongfei Date: Mon, 26 Feb 2018 14:25:38 +0800 Subject: [PATCH 1/4] add c-api quick start --- doc/howto/capi/index_cn.rst | 1 + doc/howto/capi/quick_start.md | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 doc/howto/capi/quick_start.md diff --git a/doc/howto/capi/index_cn.rst b/doc/howto/capi/index_cn.rst index e589a6d346..6981c7ce38 100644 --- a/doc/howto/capi/index_cn.rst +++ b/doc/howto/capi/index_cn.rst @@ -4,6 +4,7 @@ C-API预测库 .. toctree:: :maxdepth: 1 + quick_start.md compile_paddle_lib_cn.md organization_of_the_inputs_cn.md workflow_of_capi_cn.md diff --git a/doc/howto/capi/quick_start.md b/doc/howto/capi/quick_start.md new file mode 100644 index 0000000000..cb696b6959 --- /dev/null +++ b/doc/howto/capi/quick_start.md @@ -0,0 +1,23 @@ +## 开始使用 + +### 概述 +当我们训练完一个神经网络模型之后，下一步就是用模型来做预测。预测就是准备输入数据，经过模型处理之后，得到预测结果的过程。 + +相比于模型训练，预测有如下特点： + +1. 预测不需要训练过程中反向传播和参数更新的部分。 +1. 预测不需要标签(label)。 +1. 预测很多时候需要和用户系统整合在一起。 + +因为上述特点，模型预测SDK需要单独设计，并具备以下特点： + +1. 预测SDK不包含反向传播和参数更新部分，以减小SDK的体积。 +1. 预测SDK需要提供一个简洁的用户接口，方便使用。 +1. 因为输入数据可能有多种结构，对输入数据的格式做清晰简洁的封装。 +1. 为了和用户系统兼容，SDK的接口需要是满足C标准的接口。 + +PaddlePaddle提供了C-API，用于解决上述问题。关于C-API的使用，我们提供了如下指南： + +1. [C-API使用流程](./workflow_of_capi_cn.md) +1. [安装与编译C-API预测库](./compile_paddle_lib_cn.md) +1. [输入/输出数据组织](./organization_of_the_inputs_cn.md) From 28668ad06e5b895d0b777b300570900af99a3897 Mon Sep 17 00:00:00 2001 From: qiaolongfei Date: Mon, 26 Feb 2018 14:47:06 +0800 Subject: [PATCH 2/4] move quick start to index_cn.rst --- doc/howto/capi/index_cn.rst | 17 +++++++++++++++++ doc/howto/capi/quick_start.md | 23 ----------------------- 2 files changed, 17 insertions(+), 23 deletions(-) delete mode 100644 doc/howto/capi/quick_start.md diff --git a/doc/howto/capi/index_cn.rst b/doc/howto/capi/index_cn.rst index 6981c7ce38..e240a3e3dc 100644 --- a/doc/howto/capi/index_cn.rst +++ b/doc/howto/capi/index_cn.rst @@ -1,6 +1,23 @@ C-API预测库 ================== +当我们训练完一个神经网络模型之后，下一步就是用模型来做预测。预测就是准备输入数据，经过模型处理之后，得到预测结果的过程。 + +相比于模型训练，预测有如下特点： + +1. 预测不需要训练过程中反向传播和参数更新的部分。 +1. 预测不需要标签(label)。 +1. 预测很多时候需要和用户系统整合在一起。 + +因为上述特点，模型预测SDK需要单独设计，并具备以下特点： + +1. 预测SDK不包含反向传播和参数更新部分，以减小SDK的体积。 +1. 预测SDK需要提供一个简洁的用户接口，方便使用。 +1. 因为输入数据可能有多种结构，对输入数据的格式做清晰简洁的封装。 +1. 为了和用户系统兼容，SDK的接口需要是满足C标准的接口。 + +PaddlePaddle提供了C-API，用于解决上述问题。关于C-API的使用，我们提供了如下指南： + .. toctree:: :maxdepth: 1 diff --git a/doc/howto/capi/quick_start.md b/doc/howto/capi/quick_start.md deleted file mode 100644 index cb696b6959..0000000000 --- a/doc/howto/capi/quick_start.md +++ /dev/null @@ -1,23 +0,0 @@ -## 开始使用 - -### 概述 -当我们训练完一个神经网络模型之后，下一步就是用模型来做预测。预测就是准备输入数据，经过模型处理之后，得到预测结果的过程。 - -相比于模型训练，预测有如下特点： - -1. 预测不需要训练过程中反向传播和参数更新的部分。 -1. 预测不需要标签(label)。 -1. 预测很多时候需要和用户系统整合在一起。 - -因为上述特点，模型预测SDK需要单独设计，并具备以下特点： - -1. 预测SDK不包含反向传播和参数更新部分，以减小SDK的体积。 -1. 预测SDK需要提供一个简洁的用户接口，方便使用。 -1. 因为输入数据可能有多种结构，对输入数据的格式做清晰简洁的封装。 -1. 为了和用户系统兼容，SDK的接口需要是满足C标准的接口。 - -PaddlePaddle提供了C-API，用于解决上述问题。关于C-API的使用，我们提供了如下指南： - -1. [C-API使用流程](./workflow_of_capi_cn.md) -1. [安装与编译C-API预测库](./compile_paddle_lib_cn.md) -1. [输入/输出数据组织](./organization_of_the_inputs_cn.md) From 901dabc7f50e66d2efe18498acc8a9953f973150 Mon Sep 17 00:00:00 2001 From: qiaolongfei Date: Mon, 26 Feb 2018 14:48:01 +0800 Subject: [PATCH 3/4] clean --- doc/howto/capi/index_cn.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/howto/capi/index_cn.rst b/doc/howto/capi/index_cn.rst index e240a3e3dc..8197c4bc1c 100644 --- a/doc/howto/capi/index_cn.rst +++ b/doc/howto/capi/index_cn.rst @@ -21,7 +21,6 @@ PaddlePaddle提供了C-API，用于解决上述问题。关于C-API的使用， .. toctree:: :maxdepth: 1 - quick_start.md compile_paddle_lib_cn.md organization_of_the_inputs_cn.md workflow_of_capi_cn.md From 13922fb489dec953262a0b9e2dbe4c99c1c7296a Mon Sep 17 00:00:00 2001 From: qiaolongfei Date: Mon, 26 Feb 2018 15:13:07 +0800 Subject: [PATCH 4/4] fix rst format --- doc/howto/capi/index_cn.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/howto/capi/index_cn.rst b/doc/howto/capi/index_cn.rst index 8197c4bc1c..7f10071798 100644 --- a/doc/howto/capi/index_cn.rst +++ b/doc/howto/capi/index_cn.rst @@ -5,16 +5,16 @@ C-API预测库 相比于模型训练，预测有如下特点： -1. 预测不需要训练过程中反向传播和参数更新的部分。 -1. 预测不需要标签(label)。 -1. 预测很多时候需要和用户系统整合在一起。 +#. 预测不需要训练过程中反向传播和参数更新的部分。 +#. 预测不需要标签(label)。 +#. 预测很多时候需要和用户系统整合在一起。 因为上述特点，模型预测SDK需要单独设计，并具备以下特点： -1. 预测SDK不包含反向传播和参数更新部分，以减小SDK的体积。 -1. 预测SDK需要提供一个简洁的用户接口，方便使用。 -1. 因为输入数据可能有多种结构，对输入数据的格式做清晰简洁的封装。 -1. 为了和用户系统兼容，SDK的接口需要是满足C标准的接口。 +#. 预测SDK不包含反向传播和参数更新部分，以减小SDK的体积。 +#. 预测SDK需要提供一个简洁的用户接口，方便使用。 +#. 因为输入数据可能有多种结构，对输入数据的格式做清晰简洁的封装。 +#. 为了和用户系统兼容，SDK的接口需要是满足C标准的接口。 PaddlePaddle提供了C-API，用于解决上述问题。关于C-API的使用，我们提供了如下指南：