API 文档书写规范

  1. 至关重要API 文档对该 API 的描述,一定要与 API 的行为保持一致。中英文文档的内容要严格一致

  2. API 文档的字段:API 名称、API 功能描述、API 参数、API 返回、API 代码示例、API 属性(class)、API 方法(methods)等。API 抛出异常的情况,不需要在文档中体现;

  3. API 功能描述:请注意,看文档的用户没有和开发同学一样的知识背景。因此,请提示用户在什么场景下使用该 API。请使用深度学习领域通用的词汇和说法。(深度学习常用术语表);

  4. API 参数:写清楚对输入参数的要求,写清楚在不同情况下的行为区别(例默认值时的行为)。同类性质的参数(如:输入 Tensor x,每个 API 中的 name 参数),可以直接从这里复制内容:常用文档写法

  5. API 代码示例:中英文文档当中的代码示例完全一致(注释可不用翻译),中文文档建议使用 COPY-FROM 的方式与英文文档做同步。代码示例使用 2.0 版本中的 API,可运行。尽量不用随机输入,注释形式给出输出值。构造输入数据时,尽量使用 paddle 提供的 API,如: paddle.zerospaddle.onespaddle.fullpaddle.arangepaddle.randpaddle.randnpaddle.randintpaddle.normalpaddle.uniform,尽量不要引入第三方库(如 NumPy);

  6. 其他:2.0 中的 API,对于 VariableLodTensorTensor,统一使用 Tensorto_variable 也统一改为 to_tensor

  7. 对于 LinearConv2DL1Loss 这些 class 形式的 API,需要写清楚当这个 callable 被调用时的输入输出的形状(如 forward 方法的参数)。位置放在现在的 Parameters / 参数这个 block 后面,具体为:

中文时:

形状:
      - **input** (Tensor):形状为(批大小,通道数,高度,宽度),即,NCHW 格式的 4-D Tensor。
      - **output** (Tensor):形状为(批大小,卷积核个数,输出图像的高度,输出图像的高度)的 4-D Tensor。

英文时:

Shape:
      - input: 4-D tensor with shape: (batch, num_channels, height, width), i.e.: NCHW.
      - output: 4-D tensor with shape: (batch, num_filters, new_height, new_width).

英文模板

def add(x, y, name=None):
    """

    Add two tensors element-wise. The equation is:

    .. math::
        out = x + y

    Note:
        ``paddle.add`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting`.

    Args:
        x (Tensor): The input tensor, it's data type should be float32, float64, int32, int64.
        y (Tensor): The input tensor, it's data type should be float32, float64, int32, int64.
        name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.

    Returns:
        N-D Tensor. A location into which the result is stored. It’s dimension equals with :attr:`x`.

    Examples:
        .. code-block:: python

            import paddle

            x = paddle.to_tensor([2, 3, 4], 'float64')
            y = paddle.to_tensor([1, 5, 2], 'float64')
            z = paddle.add(x, y)
            print(z)  # [3., 8., 6. ]

    """

中文模板

.. _cn_api_tensor_add:
add
-------------------------------

.. py:function:: paddle.add(x, y, name=None)

输入 :attr:`x` 与输入 :attr:`y` 逐元素相加,并将各个位置的输出元素保存到返回结果中。计算公式为:

.. math::
    out = x + y

.. note::
   ``paddle.add`` 遵守广播机制,如您想了解更多,请参见 :ref:`cn_user_guide_broadcasting`。
..
  说明:以上为 API 描述部分,只需要尽可能简单的描述出 API 的功能作用即可,要让用户能快速看懂。这个 case 可以拆解为 3 个部分,功能作用 + 计算公式 + 注解部分。

参数
:::::::::
    - **x** (Tensor) - 输入的 Tensor,数据类型为 float32、float64、int32 或 int64。
    - **y** (Tensor) - 输入的 Tensor,数据类型为 float32、float64、int32 或 int64。
    - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
..
  说明:API 参数可优先复制常用文档写法中的参数,参数的描述要准确,还要重点描述参数的功能作用及使用场景。

返回
:::::::::
``Tensor``,维度和数据类型都与 :attr:`x` 相同,存储运算后的结果。
..
  返回为 返回类型 + 描述的格式即可。

代码示例
::::::::::

COPY-FROM: paddle.add

..
  尽量不使用随机的输入,尽量不引入第三方库(如 NumPy);
  优先使用动态图,在一个代码示例中给出多个使用场景;
  中文文档优先使用 COPY-FROM 的方式与英文文档做同步。

API 文档各模块写作说明

API 名称

API 名称直接写 API 的名字即可,不需要写全完整路径;

如 paddle.add

add
---------

API 声明

API 的声明部分,要给出 API 的声明信息;

function:如 paddle.add

.. py:function:: paddle.add(x, y, name=None)

class:如 paddle.nn.Conv2D

.. py:class:: paddle.nn.Conv2D(in_channels, out_channels, kernel_size, stride=1, padding=0, dilation=1, groups=1, padding_mode='zeros', weight_attr=None, bias_attr=None, data_format='NCHW')

API 功能描述

API 功能描述部分只需要尽可能简单的描述出 API 的功能作用即可,要让用户能快速看懂。如 paddle.add

可以拆解为 3 个部分,功能作用 + 计算公式 + 注解部分,其中:

  • 功能作用:描述该 API 文档的功能作用;由于用户没有对应的背景,所以需要补充必要的细节,比如是不是逐元素的,如 paddle.add

    输入 :attr:`x` 与输入 :attr:`y` 逐元素相加,并将各个位置的输出元素保存到返回结果中。
    
  • 计算公式:给出该 API 的计算公式,由于公式中每个变量都对应 API 的参数,所以不需要做额外的说明,如 paddle.add

    计算公式为:
    
    .. math::
        out = x + y
    
  • 注解部分:加入 API 有需要特殊说明的部分,可以在注解部分给出,比如: API 与其他 API 功能相似,需要给出该 API 与另一个 API 的使用上的区别

注意事项

  1. 写作 API 文档中,请使用深度学习领域通用的词汇和说法。(深度学习常用术语表);

  2. 文档中的前后说明要一致,比如维度的说明,统一使用 4-D Tensor 的格式,不确定的写“多维”;

  3. 文档相互引用的方式:如何让文档相互引用

  4. 功能描述中涉及到的专有数据结构如 TensorLoDTensorVariable,中英文都统一使用 Tensor,无需翻译;

  5. 如果涉及到一些通用的知识,如广播机制,可以用注解的方式写出来,示例如下:

中文:

.. note::
    ``paddle.add`` 遵守广播机制,如您想了解更多,请参见 :ref:`cn_user_guide_broadcasting`。

英文:

Note:
    ``paddle.add`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting`.

总结:paddle.add 的描述如下

输入 :attr:`x` 与输入 :attr:`y` 逐元素相加,并将各个位置的输出元素保存到返回结果中。计算公式为:

.. math::
    out = x + y
.. note::
    ``paddle.add`` 遵守广播机制,如您想了解更多,请参见 :ref:`cn_user_guide_broadcasting`。

API 参数(重要)

注意:一些通用的参数说明,直接复制 常用文档写法 中的描述即可。

API 参数部分,要解释清楚每个参数的意义和使用场景。需要注意以下两点:

1、对于有默认值的参数,至少要讲清楚在默认值下的逻辑,而不仅仅是介绍这个参数是什么以及默认值是什么;

stop_gradient 的对比,要添加默认值为 True 的行为,即表示停止计算梯度

stop_gradient (bool,可选) - 提示是否应该停止计算梯度,默认值为 True。
# 错误写法

stop_gradient (bool,可选) - 提示是否应该停止计算梯度,默认值为 True,表示停止计算梯度。
# 正确写法

或者如 return_numpy 的对比:

return_numpy (bool) – 该变量表示是否将 fetched tensor 转换为 NumPy 数据。默认值为 True。
# 错误写法

return_numpy (bool) – 该参数表示是否将返回的计算结果(fetch list 中指定的变量)转化为 NumPy 数据;如果为 False,则每个变量返回的类型为 Tensor,否则返回变量的类型为 numpy.ndarray。默认为:True。
# 正确写法

可以看出,第二行的 return_numpy 的描述更为清晰,分别描述了 True 和 False 的两种情况。而第一行的说明过于简单。

2、 在讲清楚每个 API 参数是什么的同时,还需要描述清楚每个参数的具体作用是什么。如再如 feeded_var_names

feeded_var_names (list[str]) – 字符串列表,包含着 Inference Program 预测时所需提供数据的所有变量名称(即所有输入变量的名称)。
target_vars (list[Variable]) – Variable (详见 基础概念 )类型列表,包含着模型的所有输出变量。通过这些输出变量即可得到模型的预测结果。

用户看了描述以后,完全不知道这两个参数可以用来做网络裁剪,所以需要将一些参数的功能作用描述出来。

总结:paddle.add:

参数
:::::::::
    - **x** (Tensor) - 输入的 Tensor,数据类型为 float32、float64、int32 或 int64。
    - **y** (Tensor) - 输入的 Tensor,数据类型为 float32、float64、int32 或 int64。
    - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

API 返回

先描述 API 返回值的类型,然后描述 API 的返回值及其含义。

如 paddle.add

返回
:::::::::

``Tensor``,维度和数据类型都与 :attr:`x` 相同,存储运算后的结果。

API 抛出异常

API 抛出异常部分,由于历史原因写在文档中,建议在源码的 warning 中做提示,不在文档中展开。

API 代码示例(重要)

代码示例是 API 文档的核心部分之一,毕竟 talk is cheap,show me the code。所以,在 API 代码示例中,应该对前文描述的 API 使用中的各种场景,尽可能的在一个示例中给出,并用注释给出对应的结果。 如

注意事项

  • 示例代码需要与当前版本及推荐用法保持一致:develop 分支下 fluid namespace 以外的 API,不能再有 fluid 关键字,只需要提供动态图的示例代码

  • 尽量不用随机输入,需要以注释形式给出输出值;

  • 中英文示例代码,不做任何翻译,保持完全一致,中文文档建议使用 COPY-FROM 的方式与英文文档做同步;

  • 原则上,所有提供的 API 都需要提供示例代码,对于 class member methodsabstract APIcallback 等情况,可以在提交 PR 时说明相应的使用方法的文档的位置或文档计划后,通过白名单审核机制通过 CI 检查;

  • 对于仅为 GPU 环境提供的 API,当该示例代码在 CPU 上运行时,运行后给出含有 “Not compiled with CUDA” 的错误提示,也可认为该 API 行为正确。

英文 API 代码示例格式规范如下:

def api():
  """
  Examples:
    .. code-block:: python

        示例代码位置

    .. code-block:: python

        示例代码位置 (存在多个示例代码)
  """

英文格式如 paddle.multiply

def multiply(x, y, axis=-1, name=None):
  """
  Examples:
    .. code-block:: python

            import paddle

            x = paddle.to_tensor([[1, 2], [3, 4]])
            y = paddle.to_tensor([[5, 6], [7, 8]])
            res = paddle.multiply(x, y)
            print(res) # [[5, 12], [21, 32]]

            x = paddle.to_tensor([[[1, 2, 3], [1, 2, 3]]])
            y = paddle.to_tensor([2])
            res = paddle.multiply(x, y)
            print(res) # [[2, 4, 6], [2, 4, 6]]]

中文格式如 paddle.add

代码示例
::::::::::

COPY-FROM: paddle.add

API 属性

API 的属性用来描述 API 所包含的属性。如果 API 有属性,每个属性需要分为四个部分描述:

  • 名称:属性名称直接写属性的名字即可,不需要将全路径写全;

  • 注意:列举出使用该属性时应注意的一些问题,如果没有可以不填;如不同的版本、是否是只读属性、使用的一些 tricks 等等,如 Programrand_seed

      .. note::
          必须在相关 OP 被添加之前设置。
    
  • 描述:API 功能描述部分要求一致;

  • 返回:API 返回部分要求一致;

  • 代码示例:与 API 代码示例部分要求一致。

总结:paddle.Program.random_seed

random_seed
''''''''''''

..note:
    必须在相关 OP 被添加之前设置。

程序中随机运算符的默认随机种子。0 意味着随机生成随机种子。

**返回**

int64,返回该 Program 中当前正在使用的 random seed。

**代码示例**

COPY-FROM: paddle.Program.random_seed

API 方法

API 的方法用来描述 API 所包含的方法,一些类的 API 会有这个内容,没有方法的 API 可以不写此模块。如果有,每个方法需要分为六个部分描述:

  • 名称:方法名称直接写方法的名字即可,不需要将全路径写全;

  • 声明:与 API 声明的要求一致;

  • 参数:与 API 参数的要求一致;

  • 描述:与 API 功能描述的要求一致;

  • 返回:与 API 返回的要求一致;

  • 代码示例:与 API 代码示例的要求一致。

总结:paddle.Program.parse_from_string

parse_from_string
''''''''''''

.. py:function:: paddle.Program.parse_from_string(binary_str_type)

通过对 protobuf 的反序列化,转换成 ``Program``

**参数**

- **binary_str_type** (str) – protobuf 二进制字符串

**返回**

``Program``,反序列化后的 ``Program``

**代码示例**

COPY_FROM: paddle.Program.parse_from_string

注解

注解部分描述一些用户使用该 API 时需要额外注意的一些注意事项,可以出现在任意需要提示用户的地方;可以是当前版本存在的一些问题,如例 1;也可以是该 API 使用上的一些注意事项,如例 2;

例 1 paddle.fluid.cuda.cuda_places

中文:

.. note::
    多卡任务请先使用 FLAGS_selected_gpus 环境变量设置可见的 GPU 设备,下个版本将会修正 CUDA_VISIBLE_DEVICES 环境变量无效的问题。

英文:

Note:
    For multi-card tasks, please use `FLAGS_selected_gpus` environment variable to set the visible GPU device.
    The next version will fix the problem with `CUDA_VISIBLE_DEVICES` environment variable.

例 2 paddle.sqrt

中文:

.. note::
    请确保输入中的数值是非负数。

英文:

Note:
    Input value must be greater than or equal to zero.

警告

警告部分需要慎重使用,一般是不推荐用户使用的 API 方法(例 1),或者是已经有计划要废弃的 API(例 2),需要用警告来说明。

例 1 paddle.fluid.layers.DynamicRNN

中文:

.. warning::
    目前不支持在 DynamicRNN 的 block 中任何层上配置 is_sparse = True。

英文:

Warning:
    Currently it is not supported to set :code:`is_sparse = True` of any
    layers defined within DynamicRNN's :code:`block` function.

例 2 paddle.fluid.clip.set_gradient_clip

中文:

.. warning::
    此 API 对位置使用的要求较高,其必须位于组建网络之后,``minimize`` 之前,因此在未来版本中可能被删除,故不推荐使用。推荐在 ``optimizer`` 初始化时设置梯度裁剪。有三种裁剪策略:``GradientClipByGlobalNorm``、``GradientClipByNorm``、``GradientClipByValue``。如果在 ``optimizer`` 中设置过梯度裁剪,又使用了 ``set_gradient_clip``,``set_gradient_clip`` 将不会生效。

英文:

Warning:
    This API must be used after building network, and before ``minimize``,
    and it may be removed in future releases, so it is not recommended.
    It is recommended to set ``grad_clip`` when initializing the ``optimizer``,
    this is a better method to clip gradient. There are three clipping strategies:
    :ref:`api_fluid_clip_GradientClipByGlobalNorm`, :ref:`api_fluid_clip_GradientClipByNorm`,
    :ref:`api_fluid_clip_GradientClipByValue`.

文档测试

  • 中文文档、英文文档齐全,内容一一对应;

  • 文档清晰可读,易于用户使用;

  • 给出易于理解的 API 介绍,文字描述,公式描述;

  • 参数命名通俗易懂无歧义,明确给出传参类型,对参数含义以及使用方法进行详细说明,对返回值进行详细说明;

  • 异常类型和含义进行详细说明;

  • 示例代码需要做到复制粘贴即可运行,并且需要明确给出预期运行结果(如果可以);

  • 阅读无障碍:无错别字、上下文连贯、内容清晰易懂、链接可正常跳转、图片公式显示正常。