diff --git a/doc/howto/capi/index_cn.rst b/doc/howto/capi/index_cn.rst index e589a6d346a1e23a4eed9801e02727c80782ae8b..6981c7ce380a28423f7ce50f47765c0897087aeb 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 0000000000000000000000000000000000000000..cb696b6959502b77e48e1ae6784a4f793a1cbede --- /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)