mindspore2022/docs/api/api_python/ops/mindspore.ops.Custom.rst

mindspore.ops.Custom
=====================

.. py:class:: mindspore.ops.Custom(func, bprop=None, out_dtype=None, func_type="hybrid", out_shape=None, reg_info=None)

    `Custom` 算子是MindSpore自定义算子的统一接口。用户可以利用该接口自行定义MindSpore内置算子库尚未包含的算子。
    根据输入函数的不用，你可以创建多个自定义算子，并且把它们用在神经网络中。
    关于自定义算子的详细说明和介绍，包括参数的正确书写，见编程指南 https://www.mindspore.cn/docs/programming_guide/zh-CN/master/custom_operator_custom.html 。

    .. warning::
        这是一个实验性接口，后续可能删除或修改。

    .. note::
        不同自定义算子的函数类型（func_type)支持的平台类型不同。每种类型支持的平台如下：

        - "hybrid": ["Ascend", "GPU"].
        - "akg": ["Ascend", "GPU"].
        - "tbe": ["Ascend"].
        - "aot": ["GPU", "CPU"].
        - "pyfunc": ["CPU"].
        - "julia": ["CPU"].
        - "aicpu": ["Ascend"].

    **参数：**

    - **func** (Union[function, str]) - 自定义算子的函数表达。
    - **out_shape** (Union[function, list, tuple]) - 自定义算子的输入的形状或者输出形状的推导函数。默认值：None。
    - **out_dtype** (Union[function, :class:`mindspore.dtype`, tuple[:class:`mindspore.dtype`]]) - 自定义算子的输入的数据类型或者输出数据类型的推导函数。默认值：None。
    - **func_type** (str) - 自定义算子的函数类型，必须是["hybrid", "akg", "tbe", "aot", "pyfunc", "julia", "aicpu"]中之一。默认值："hybrid"。
    - **bprop** (function) - 自定义算子的反向函数。默认值：None。
    - **reg_info** (Union[str, dict, list, tuple]) - 自定义算子的算子注册信息。默认值：None。

    **输入：**

    - **input** (Union(tuple, list)) - 输入要计算的Tensor。

    **输出：**

    Tensor。自定义算子的计算结果。

    **异常：**

    - **TypeError** - 如果输入 `func` 不合法，或者 `func` 对应的注册信息类型不对。
    - **ValueError** - `func_type` 的值不在列表内。
    - **ValueError** - 算子注册信息不合法，包括支持平台不匹配，算子输入和属性与函数不匹配。