MindSpore API Checklist

本文档为API接口文档的测试和开发提供检查依据，保证API接口功能描述的完备性、输入输出参数和示例代码的正确性。

API样例：mindspore.nn.Conv1d、mindspore.nn.Momentum、mindspore.nn.Dropout、mindspore.ops.Conv2D、mindspore.dataset.MnistDataset

类别	检查点	注意要点
接口名称	接口名称	接口是否缺失，即未在API页面展示。（教程中提到的接口都应在API文档中能查到）
接口描述	描述准确完整	普通接口要求： 1. 描述该接口功能、使用场景和约束（接口间的依赖关系）等。 2. 对于使用方式较复杂的接口，应该在文档中详细说明该接口的使用方法和约束。 3. 提及的变量能否在本接口或其他接口中找到说明：没有的需要补充或提供可以参考哪里。 算子补充要求： 1. 每个算子都要描述下这个算子的数学含义，包括做什么、怎么计算的等。如果无法描述清楚，需要使用公式说明。 2. 复杂的算子接口可在注释中提供多个例子。
	公式	数学运算相关算子给出对应的公式，注意公式的引用是否合理，显示是否有问题。
Parameters（算子不涉及）	参数个数	参数个数是否完全和源码中的所有参数对应。
	参数默认值/取值范围	1. 参数存在默认值/取值范围的话，是否给出描述，是否和源码中一致。 2. 默认值/取值范围的含义和可能的关联关系（参数间的依赖关系）是否清晰。
	参数数据类型是否链接到相应网址	基本数据类型：int、float、bool、str、list、dict、set、tuple。 其他数据类型：mindspore.dtype、numpy.dtype等。
Returns（算子不涉及）	返回值	返回值类型和含义是否正确。
Inputs（算子特有）	算子输入	描述算子的输入类型和shape。 注意输入类型是否正确。类型是Tensor时，需描述shape，并按:math:`(N, C, X)`格式写作。
Outputs（算子特有）	算子输出	描述算子的输出类型和shape。 注意输出类型是否正确。类型是Tensor时，需描述shape，并按:math:`(N, C, X)`格式写作。
Note	特殊说明	说明内容是否是用户需特别关注的点，是否准确，是否有遗漏，样式是否正确。
Warning	告警说明	1. 是否描述了使用该接口时需要警告的事项，以免造成负面影响。 2. 实验阶段的API是否有说明。
Raises	异常	建议描述关键异常的影响和处理方案（其他异常将在代码报错信息上指导用户）。
Examples	示例是否典型、完整、可运行	示例代码需要典型、完整而且正确运行，要展示输出结果或维度等信息。
展示效果	链接	引用的链接是否正常，如论文链接。
	专有术语	是否按照术语表书写。如：LeNet、Ascend等。

中文API补充Checklist：

1. 是否存在翻译不合适的词：判断是否需要翻译，如需翻译应翻译成什么。

2. 是否存在一致性问题。

   • 公式和参数不一致。
   • 中文和英文不一致。
   • 描述同一内容时，翻译词汇不一致。
   • 描述同一内容时，大小写、中划线、下划线、空格等不一致。
   • 同一类型内容使用的引号不一致（单引、双引或`）。

3. 标点是否有误用。

   • 所有变量或接口是否都使用`包裹。
   • 变量值是否都使用单引或双引包裹，且引号统一为英文符号。
   • 描述语句中是否存在英文的逗号、分号、句号等。
   • 并列关系时是否使用顿号隔开。

4. 中文、英文全称、英文缩写描述是否合理。

5. Tensor、Python、True、False、None等注意大小写。