# 数据资产说明文档建议规范
#### 数据资产说明文档简介
数据资产说明文档是资产文件中的README.md文件，用于描述数据资产的详情内容，主要由头部的 YAML 元数据 和 Markdown 正文共两个部分组成，帮助用户能快速了解和使用。
一份完善的资产说明文档，建议包括但不限于以下内容：
- 数据集名称与简介：介绍该数据集的基础信息、使用场景、子数据集、用途、数据量等。
- 支持的模型：明确该数据集支持的模型信息。
- 数据集的格式和结构：包含数据的schema信息，并提供必要的数据样本示范。
- 数据集使用方式：可以给出简单示例介绍用户如何使用该数据集，包括所使用的框架、运行环境要求等。若给出代码范例供效果更佳。
 
#### YAML头部元数据
数据资产说明文档的元数据由 README.md 文件头部的 YAML 小节维护，并使用 --- 将其与 Markdown 正文分节区隔。一份完整的YAML部分的内容参考如下：
```
---
version: v0.0.1
license: Apache License 2.0
# 用户自定义标签
tags:
  - Manipulation
  - Navigation
---
```
#### 数据资产Markdown正文模板
```
## 数据集描述
数据集整体描述。
### 数据集简介
提供对于数据集的介绍，支持的使用场景（包括支持的语言等）。
### 数据集支持的任务
该数据集支持的训练任务，以及相关benchmark结果。
## 数据集的格式和结构
### 数据格式
对数据的格式进行描述，包括数据的schema，以及提供必要的数据样本示范。
### 数据集加载方式
通过代码范例等方式，提供数据集通过SDK进行加载和使用的详细说明。
## 数据集版权信息
数据集相关的版权信息，授权使用的场景和用户。是否开源，以及采用哪个开源协议等等。
## 引用方式
数据集是否有相关联的文章，以及如果在研究论文中要引用该数据集是否有推荐的引用格式等等。
## 其他相关信息
该数据集可能包含的个人和敏感信息，使用数据集需要考虑的相关背景；
数据集可能包含的社会意义以及其中可能包含的bias信息和可能的局限性等等。
```