setup¶

paddle.utils.cpp_extension. setup ( **attr ) [源代码] ¶

此接口用于配置如何编译自定义 OP 源文件，包括编译动态库，自动地生成 Python API 并以 Module 的形式安装到 site-packages 目录等过程。编译完成后，支持通过 import 语句导入使用。

此接口是对 Python 内建库中的 setuptools.setup 接口的进一步封装，支持的参数类型，以及使用方式均与原生接口保持一致。接口隐藏了 Paddle 框架内部概念，如默认需要指定的编译选项，头文件搜索目录，链接选项等；此接口会自动搜索和检查本地的 cc 和 nvcc 编译命令和版本环境，根据用户指定的 Extension 类型，完成支持 CPU 或 GPU 设备的算子编译。

同时，编译前会执行 ABI 兼容性检查 ，即检查编译器版本是否与本地安装的 Paddle 一致。如在 Linux 下，对于 CUDA 10.1 以上的 Paddle 默认使用 GCC 8.2 编译，则本地 cc 对应的编译器版本也需为 8.2，在 Windows 下，Paddle 使用 Visualt Studio 2017 编译，则本地也需安装 大于 2017 的 Visual Studio，如果不满足，则可能由于 ABI 兼容性原因引发自定义 OP 编译或执行报错。Mac 下默认使用 clang 进行编译，无 ABI 兼容性问题。

相对于即时编译的 load 接口，此接口仅需执行一次 python setup.py install 命令，即可像其他 python 库一样 import 导入使用。如下是一个 setup.py 文件的简单样例：

# setup.py

# 方式一：编译支持 CPU 和 GPU 的算子
from paddle.utils.cpp_extension import CUDAExtension, setup

setup(
    name='custom_op',  # package 的名称，用于 import
    ext_modules=CUDAExtension(
        sources=['relu_op.cc', 'relu_op.cu', 'tanh_op.cc', 'tanh_op.cu']  # 支持同时编译多个 OP
    )
)

# 方式二：编译支持仅 CPU 的算子
from paddle.utils.cpp_extension import CppExtension, setup

setup(
    name='custom_op',  # package 的名称，用于 import
    ext_modules=CppExtension(
        sources=['relu_op.cc', 'tanh_op.cc']  # 支持同时编译多个 OP
    )
)

在源文件所在目录下执行 python setup.py install 即可完成自定义 OP 编译和 custom_op 库的安装。在组网时，可以通过如下方式使用：

import paddle
from custom_op import relu, tanh

x = paddle.randn([4, 10], dtype='float32')
relu_out = relu(x)
tanh_out = tanh(x)