diff --git a/doc/howto/index_cn.rst b/doc/howto/index_cn.rst index 678a00c9d34325f222add0ba57bf1a98185507a4..e0c69f7a6a4043abe999af6c8dd2555178b68424 100644 --- a/doc/howto/index_cn.rst +++ b/doc/howto/index_cn.rst @@ -9,7 +9,7 @@ usage/cmd_parameter/index_cn.rst usage/cluster/cluster_train_cn.md - usage/capi/overview.md + usage/capi/index_cn.rst 开发标准 -------- diff --git a/doc/howto/usage/capi/a_simple_example.md b/doc/howto/usage/capi/a_simple_example.md index 847d8ef1e0cbb82faa762e680029c15461b08ba1..d9f0a1d12807c860a7ba35dfcdf1d77b7d2ac3fa 100644 --- a/doc/howto/usage/capi/a_simple_example.md +++ b/doc/howto/usage/capi/a_simple_example.md @@ -1,4 +1,4 @@ -## 使用 C-API 开发预测程序 +## C-API CPU 单线程预测示例 这篇文档通过一个最简单的例子:手写数字识别,来介绍 CPU 下单线程使用 PaddlePaddle C-API 开发预测服务,完整代码见[此目录](https://github.com/PaddlePaddle/Paddle/blob/develop/paddle/capi/examples/model_inference/dense/)。 @@ -115,7 +115,7 @@ - `Argument` 并不真正“存储”数据,而是将输入/输出数据有机地组织在一起。 - 在`Argument`内部由:1. `Matrix`(二维矩阵,存储浮点类型输入/输出);2. `IVector`(一维数组,**仅用于存储整型值**,多用于自然语言处理任务)来实际存储数据。 -注:本文使用的示例任务手写数字识别不涉及一维整型数组作为输入,因此,本文档仅限于讨论二维稠密矩阵作为输入的情形。更多输入数据格式请参考输入/输出数据一节的内容。 +*注:本文档使用的示例任务手写数字识别不涉及一维整型数组作为输入,因此,本文档仅讨论二维稠密矩阵作为输入的情形。更多输入数据格式请参考输入/输出数据一节的内容。* 这篇文档的之后部分会使用`argument`来**特指** PaddlePaddle C-API中神经网的一个输入/输出,使用`paddle_matrix`**特指**`argument`中用于存储数据的`Matrix`类的对象。 diff --git a/doc/howto/usage/capi/compile_paddle_lib.md b/doc/howto/usage/capi/compile_paddle_lib.md index 1ad5b9068129d092fcbeaaad67f3ab9eb86daf9c..d4ac4f27711a8df64cb4c5f9206a6abfed4cba10 100644 --- a/doc/howto/usage/capi/compile_paddle_lib.md +++ b/doc/howto/usage/capi/compile_paddle_lib.md @@ -1,5 +1,7 @@ ## 编译 PaddlePaddle 链接库 +### 概述 + 使用 C-API 进行预测依赖于将 PaddlePaddle 核心代码编译成链接库,只需在编译时指定编译选项:`-DWITH_C_API=ON`。同时,**建议将:`DWITH_PYTHON`,`DWITH_SWIG_PY`,`DWITH_GOLANG`,均设置为`OFF`**,以避免链接不必要的库。其它编译选项按需进行设定。 ```shell @@ -42,7 +44,7 @@ cmake $PADDLE_ROOT -DCMAKE_INSTALL_PREFIX=$INSTALL_PREFIX \ ├── ...... ``` -## 链接方式说明 +### 链接方式说明 目前提供三种链接方式: diff --git a/doc/howto/usage/capi/index_cn.rst b/doc/howto/usage/capi/index_cn.rst new file mode 100644 index 0000000000000000000000000000000000000000..3b36f31bfd0da37f4a812ab59e96981c4c35a86b --- /dev/null +++ b/doc/howto/usage/capi/index_cn.rst @@ -0,0 +1,9 @@ +PaddlePaddle C-API +================== + +.. toctree:: + :maxdepth: 1 + + compile_paddle_lib.md + organization_of_the_inputs.md + a_simple_example.md diff --git a/doc/howto/usage/capi/overview.md b/doc/howto/usage/capi/overview.md deleted file mode 100644 index c55d39bac697c3ff734f33ba3307a6bf965b4000..0000000000000000000000000000000000000000 --- a/doc/howto/usage/capi/overview.md +++ /dev/null @@ -1,3 +0,0 @@ -- [编译 PaddlePaddle 链接库](compile_paddle_lib.md) -- [输入/输出数据组织](organization_of_the_inputs.md) -- [C-API 使用示例](a_simple_example.md)