跳到主要内容
版本：0.6.5

dataset.yaml 使用指南

提示

dataset.yaml 对于 swcli dataset build 构建数据集的过程是非必要的。

Starwhale Dataset 构建的时候使用 dataset.yaml，若省略 dataset.yaml，则可以在 swcli dataset build 命令行参数中描述相关配置，可以认为 dataset.yaml 是 build 命令行的配置文件化表述。

YAML 字段描述​

字段描述是否必要类型默认值
nameStarwhale Dataset的名字是String
handler为一个函数，返回一个Generator或一个可迭代的对象或一个实现 __iter__ 方法的类，格式为 {module 路径}:{类名函数名}是String
desc数据集描述信息否String""
versiondataset.yaml格式版本，目前仅支持填写 1.0否String1.0
attr数据集构建参数否Dict
attr.volume_sizeswds-bin格式的数据集每个data文件的大小。当写数字时，单位bytes；也可以是数字+单位格式，如64M, 1GB等否Int或Str64MB
attr.alignment_sizeswds-bin格式的数据集每个数据块的数据alignment大小，如果设置alignment_size为4k，数据块大小为7.9K，则会补齐0.1K的空数据，让数据块为alignment_size的整数倍，提升page size等读取效率否Integer或String128

使用示例​

最简示例​

name: helloworld
handler: dataset:ExampleProcessExecutor

helloworld的数据集，使用dataset.yaml目录中dataset.py文件中的 ExampleProcessExecutor 类进行数据构建。

MNIST数据集构建示例​

name: mnist
handler: mnist.dataset:DatasetProcessExecutor

desc: MNIST data and label test dataset

attr:
  alignment_size: 1k
  volume_size: 4M

handler为generator function的例子​

dataset.yaml 内容：

name: helloworld
handler: dataset:iter_item

dataset.py 内容：

def iter_item():
    for i in range(10):
        yield {"img": f"image-{i}".encode(), "label": i}

本例中，handler为一个generator function，Starwhale SDK根据首个yield出来的元素为非Starwhale.Link类型，等同于继承 starwhale.SWDSBinBuildExecutor 类。