本文档给出了包含文档内的书写约定。 请作者与贡献者参考以下约定检查格式，内容一致性与正确性。
这个风格指南随着时间的推移而演变，因为额外的约定被识别出来，并且过去的约定因语言本身的变化而变得过时。规范大多数来自于常见错误的总结。
许多项目都有自己的风格指南。如果发生任何冲突，此类特定于项目的指南优先于该项目。
参考章节-第7章。
- n-前沿.md
- n.m-章节名.md
- ...
-
添加各个章节和小节序号。
-
提那家章节目录，例如可以通过Markdown All in One插件自动化。
# 7.1 小节名
xxx
小节目录
...
本章我们xx。
请读者思考，xx？
## 1.3 文字
1. 保持中文，中文（英文）。
例如：
Figure改为图片
2. 英文，数字，长序号两侧加空格，标点符号两侧不需要添加
例如：
使用 MindSpore 框架
使用 MindSpore，
批尺寸（Batch Size），
图 1.3.2，
例如 1 中所示
为 $ x $ 字节
## 1.4 链接
Http链接不直接暴露。放于语法[文字](链接中)。
## 1.5 图片
1. 注意追加图序号。
-
代码放于 ``` ```中。
# 启动脚本 python train.py --batch_size=256 --model_name=resnet50
-
追加适当注释解释文字。
-
追加表序号。
-
使用Markdown语法保持格式一致。
-
通过语法让表格居中。
表 1.2.1 不同图像分类问题数据集的数据量
| MNIST | ImageNet | Web Images |
|---|---|---|
| 6万样本 | 1600万样本 | 10亿量级图像样本 |
| 10分类 | 1000分类 | 开放分类 |
- 表格要有对应文字解释。
- 如果表格需要用到公式，可以参考下面语法以公式呈现表格。
- 正文中概念，相关工作，或者文献需要追加引用链接。
- 英文概念能用中文解释的尽量用中文解释。
- 如果为某文献创造的概念，一定需要加概念引用。
例如： 单指令流多数据流（SIMD）
向Markdown中添加参考文献引用，并且在点击参考文献引用标记时，能够自动跳转到“参考文献”一节中参考文献的详细条目，需要以下两步：
-
增加锚点 “参考文献”是Markdown文件末尾独立的一节，向这一节中添加具体的参考文献条目信息和锚点，如下所示：
# 参考文献 <div id="ref1"></div> 1. [参考文献](链接)注：参考文献条目信息可以使用Google Scholar或是其他文献检索工具导出ACM Ref格式的参考文献信息。
-
增加引用 在引用改参考文献的正文部分增加对锚点的引用，使用
<sup>标注引用，如下所示：这里是引用了参考文献1的正文[<sup>[1]</sup>](#ref1)。
请校验预览正文
例如： **文字 ** 多空格则无法呈现 文字
- ASCII字符两侧可以加空格保持美观。例如 x 初值为 100 情况下。
- （）和，和。和“”等使用中文输入法中的标点符号。
- 原则能用中文就用中文
- 首次提到需要
- 人工智能（Artificial Intelligence），简称 AI
- 前面提到后，后面可以使用简称 AI
- 例外：
- 如果 Netron，TensorFlow 这类特定工具名字，可以用英文
- 动词要尽量用中文
- 专有通用名词尽量用中文。例如，编译器
术语是约束内容一致性重要的方法。
- 正文中英文 中文术语（英文术语-首字母大写），如果需要引用加引用链接。
例如：
部署（Deployment）
注意：中文和括号之间不加空格。
- 追加到 术语表.md
| 英文 | 中文 | 缩写 | 首次提交人 |
|---|---|---|---|
| Deployment | 部署 | xx |