[CustomOp] Add cpp_extension zh doc #3292
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
|
Thanks for your contribution! |
Polish doc polish doc fix sample code
Aurelius84
force-pushed
the
custom_op
branch
from
0713221
to
4ba7c37
Compare
Aurelius84
requested review from
TCChenlong,
chenwhql,
zhhsplendid and
zhwesky2010
chenwhql
reviewed
Feb 24, 2021
zhwesky2010
reviewed
Feb 24, 2021
TCChenlong
reviewed
Feb 24, 2021
| - **extra_include_paths** (list[str], 可选): 用于指定编译 cpp 或 cuda 源文件时，额外的头文件搜索目录。默认情况下，Paddle 框架相关头文件所在目录 ``site-packages/paddle/include`` 已被隐式地包含。 | ||
| - **build_directory** (str, 可选): 用于指定存放生成动态链接库的目录。若为 None， 则会使用环境变量 ``PADDLE_EXTENSION_DIR`` 的值作为默认的存放目录。可使用 :ref:`cn_api_paddle_utils_cpp_extension_get_build_directory` 接口查看当前的目录设置。 | ||
| - **interpreter** (str, 可选): 用于指定执行即时编译所需要的解释器的路径，支持别名和完整路径，默认值为 ``python`` 。若用户本地包含多个版本的 python 环境，需要确保默认的 ``python`` 命令与当前解释器一致，否则需要指定此参数。如当前为 python3.7 环境，可设置此参数为 ``'python3.7'`` 。 | ||
| - **verbose** (str, 可选): 用于指定是否需要输出编译过程中的日志信息 |
TCChenlong
reviewed
Feb 24, 2021
| @@ -18,6 +18,11 @@ paddle.utils 目录下包含飞桨框架工具类的API。具体如下： | |||
| :header: "API名称", "API功能" | |||
| :widths: 10, 30 | |||
|
|
|||
| " :ref:`load <cn_api_paddle_utils_cpp_extension_load>` ", "飞桨框架一键编译自定义OP、自动生成和返回Python API的接口" | |||
There was a problem hiding this comment.
在第8行前加一列吧 叫 自定义OP相关API，然后把这5个API归为一类，这样会好一点，写法可以参考工具类相关API
Aurelius84
added a commit
to Aurelius84/docs
that referenced
this pull request
Apr 6, 2021
* add cpp_extension doc
TCChenlong
pushed a commit
that referenced
this pull request
Apr 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
新增自定义OP的 cpp_extension目录的中文文档， en doc: PaddlePaddle/Paddle#31187