Datasets 文档
构建类 (Builder classes)
并获得增强的文档体验
开始使用
构建器类
构建器
🤗 Datasets 在数据集构建过程中依赖两个主要类:DatasetBuilder 和 BuilderConfig。
class datasets.DatasetBuilder
< 源码 >( cache_dir: typing.Optional[str] = None dataset_name: typing.Optional[str] = None config_name: typing.Optional[str] = None hash: typing.Optional[str] = None base_path: typing.Optional[str] = None info: typing.Optional[datasets.info.DatasetInfo] = None features: typing.Optional[datasets.features.features.Features] = None token: typing.Union[bool, str, NoneType] = None repo_id: typing.Optional[str] = None data_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = None data_dir: typing.Optional[str] = None storage_options: typing.Optional[dict] = None writer_batch_size: typing.Optional[int] = None config_id: typing.Optional[str] = None **config_kwargs )
参数
- cache_dir (
str, 可选) — 用于缓存数据的目录。默认值为"~/.cache/huggingface/datasets"。 - dataset_name (
str, 可选) — 数据集的名称(如果与构建器名称不同)。这对于像 csv、imagefolder、audiofolder 等封装构建器非常有用,可以体现使用同一封装构建器的不同数据集之间的区别。 - config_name (
str, 可选) — 数据集配置的名称。它会影响磁盘上生成的数据。不同的配置会有各自的子目录和版本。如果未提供,则使用默认配置(如果存在)。添加于 2.3.0 版本
参数
name已重命名为config_name。 - hash (
str, 可选) — 数据集构建器代码特有的哈希值。用于在数据集构建器代码更新时更新缓存目录(以避免重复使用旧数据)。典型的缓存目录(定义在self._relative_data_dir中)为name/version/hash/。 - base_path (
str, 可选) — 用于下载文件的相对路径的基础路径。这可以是一个远程 URL。 - features (Features, 可选) — 用于此数据集的特征类型。例如,它可以用于更改数据集的 Features 类型。
- token (
str或bool, 可选) — 用作 Datasets Hub 上远程文件 Bearer 令牌的字符串或布尔值。如果为True,将从"~/.huggingface"获取令牌。 - repo_id (
str, 可选) — 数据集仓库的 ID。用于区分名称相同但来源不同命名空间(例如 "rajpurkar/squad" 和 "lhoestq/squad")的构建器。在后者中,构建器名称将为 "lhoestq___squad"。 - data_files (
str或Sequence或Mapping, 可选) — 源数据文件的路径。对于像“csv”或“json”这样需要用户指定数据文件的构建器。它们可以是本地或远程文件。为了方便起见,可以使用DataFilesDict。 - data_dir (
str, 可选) — 包含源数据文件的目录路径。仅在未传递data_files时使用,在这种情况下,它等同于将os.path.join(data_dir, "**")作为data_files传递。对于需要手动下载的构建器,它必须是包含手动下载数据的本地目录路径。 - storage_options (
dict, 可选) — 传递给数据集文件系统后端的键/值对(如果有)。 - writer_batch_size (
int, 可选) — ArrowWriter 使用的批处理大小。它定义了在写入之前保存在内存中的样本数量,也定义了 Arrow 分块的长度。None 表示 ArrowWriter 将使用其默认值。 - **config_kwargs (额外的关键字参数) — 传递给相应构建器配置类的关键字参数,设置在类属性 DatasetBuilder.BUILDER_CONFIG_CLASS 上。构建器配置类是 BuilderConfig 或其子类。
所有数据集的抽象基类。
DatasetBuilder 有 3 个关键方法
DatasetBuilder.info:记录数据集信息,包括特征名称、类型、形状、版本、拆分、引文等。- DatasetBuilder.download_and_prepare():下载源数据并将其写入磁盘。
- DatasetBuilder.as_dataset():生成一个 Dataset。
一些 DatasetBuilder 通过定义 BuilderConfig 子类并在构建时接受配置对象(或名称)来公开数据集的多个变体。可配置数据集在 DatasetBuilder.builder_configs() 中公开了一组预定义的配置。
as_dataset
< 源码 >( split: typing.Union[str, datasets.splits.Split, list[str], list[datasets.splits.Split], NoneType] = None run_post_process = True verification_mode: typing.Union[datasets.utils.info_utils.VerificationMode, str, NoneType] = None in_memory = False )
参数
- split (
datasets.Split) — 返回数据的哪个子集。 - run_post_process (
bool, 默认为True) — 是否运行数据集后处理转换和/或添加索引。 - verification_mode (VerificationMode 或
str, 默认为BASIC_CHECKS) — 验证模式,确定对已下载/处理的数据集信息(校验和/大小/拆分等)运行的检查。添加于 2.9.1 版本
- in_memory (
bool, 默认为False) — 是否将数据复制到内存中。
返回指定拆分的数据集。
download_and_prepare
< 源码 >( output_dir: typing.Optional[str] = None download_config: typing.Optional[datasets.download.download_config.DownloadConfig] = None download_mode: typing.Union[datasets.download.download_manager.DownloadMode, str, NoneType] = None verification_mode: typing.Union[datasets.utils.info_utils.VerificationMode, str, NoneType] = None dl_manager: typing.Optional[datasets.download.download_manager.DownloadManager] = None base_path: typing.Optional[str] = None file_format: str = 'arrow' max_shard_size: typing.Union[str, int, NoneType] = None num_proc: typing.Optional[int] = None storage_options: typing.Optional[dict] = None **download_and_prepare_kwargs )
参数
- output_dir (
str, 可选) — 数据集的输出目录。默认为该构建器的cache_dir,默认位于~/.cache/huggingface/datasets内部。添加于 2.5.0 版本
- download_config (
DownloadConfig, 可选) — 特定的下载配置参数。 - download_mode (DownloadMode 或
str, 可选) — 选择下载/生成模式,默认为REUSE_DATASET_IF_EXISTS。 - verification_mode (VerificationMode 或
str,默认为BASIC_CHECKS) — 验证模式,确定对已下载/处理的数据集信息(校验和/大小/切分等)执行哪些检查。2.9.1 新增
- dl_manager (
DownloadManager, 可选) — 要使用的特定DownloadManger。 - base_path (
str, 可选) — 用于下载文件的相对路径的基路径。这可以是一个远程 URL。如果不指定,则使用base_path属性 (self.base_path) 的值。 - file_format (
str, 可选) — 写入数据集时使用的数据文件格式。支持的格式:“arrow”、“parquet”。默认为“arrow”格式。如果格式为“parquet”,则图像和音频数据将嵌入到 Parquet 文件中,而不是指向本地文件。2.5.0 新增
- max_shard_size (
Union[str, int], 可选) — 每个分片写入的最大字节数,默认为“500MB”。该大小基于未压缩的数据大小,因此由于 Parquet 压缩等原因,实际上你的分片文件可能小于max_shard_size。2.5.0 新增
- num_proc (
int, 可选,默认为None) — 在本地下载和生成数据集时使用的进程数。默认情况下禁用多进程。2.7.0 新增
- storage_options (
dict, 可选) — 传递给缓存文件系统后端(如果有)的键值对。2.5.0 新增
- **download_and_prepare_kwargs (额外的关键字参数) — 关键字参数。
下载并准备用于读取的数据集。
示例
下载并准备数据集作为 Arrow 文件,可以使用 builder.as_dataset() 加载为 Dataset。
>>> from datasets import load_dataset_builder
>>> builder = load_dataset_builder("cornell-movie-review-data/rotten_tomatoes")
>>> builder.download_and_prepare()在本地下载并准备数据集为分片 Parquet 文件。
>>> from datasets import load_dataset_builder
>>> builder = load_dataset_builder("cornell-movie-review-data/rotten_tomatoes")
>>> builder.download_and_prepare("./output_dir", file_format="parquet")在云存储中下载并准备数据集为分片 Parquet 文件。
>>> from datasets import load_dataset_builder
>>> storage_options = {"key": aws_access_key_id, "secret": aws_secret_access_key}
>>> builder = load_dataset_builder("cornell-movie-review-data/rotten_tomatoes")
>>> builder.download_and_prepare("s3://my-bucket/my_rotten_tomatoes", storage_options=storage_options, file_format="parquet")返回此类或子类的模块路径。
class datasets.GeneratorBasedBuilder
< 源码 >( cache_dir: typing.Optional[str] = None dataset_name: typing.Optional[str] = None config_name: typing.Optional[str] = None hash: typing.Optional[str] = None base_path: typing.Optional[str] = None info: typing.Optional[datasets.info.DatasetInfo] = None features: typing.Optional[datasets.features.features.Features] = None token: typing.Union[bool, str, NoneType] = None repo_id: typing.Optional[str] = None data_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = None data_dir: typing.Optional[str] = None storage_options: typing.Optional[dict] = None writer_batch_size: typing.Optional[int] = None config_id: typing.Optional[str] = None **config_kwargs )
基于字典生成器进行数据生成的数据集的基类。
GeneratorBasedBuilder 是一个便利类,它抽象了 DatasetBuilder 的大部分数据写入和读取逻辑。它要求子类实现跨数据集切分的特征字典生成器 (_split_generators)。详情请参阅方法文档字符串。
class datasets.ArrowBasedBuilder
< 源码 >( cache_dir: typing.Optional[str] = None dataset_name: typing.Optional[str] = None config_name: typing.Optional[str] = None hash: typing.Optional[str] = None base_path: typing.Optional[str] = None info: typing.Optional[datasets.info.DatasetInfo] = None features: typing.Optional[datasets.features.features.Features] = None token: typing.Union[bool, str, NoneType] = None repo_id: typing.Optional[str] = None data_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = None data_dir: typing.Optional[str] = None storage_options: typing.Optional[dict] = None writer_batch_size: typing.Optional[int] = None config_id: typing.Optional[str] = None **config_kwargs )
基于 Arrow 加载函数 (CSV/JSON/Parquet) 进行数据生成的数据集的基类。
class datasets.BuilderConfig
< 源码 >( name: str = 'default' version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0 data_dir: typing.Optional[str] = None data_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = None description: typing.Optional[str] = None )
DatasetBuilder 数据配置的基类。
具有数据配置选项的 DatasetBuilder 子类应继承 BuilderConfig 并添加它们自己的属性。
create_config_id
< 源码 >( config_kwargs: dict custom_features: typing.Optional[datasets.features.features.Features] = None )
配置 ID 用于构建缓存目录。默认情况下,它等于配置名称。然而,配置名称不足以作为正在生成的数据集的唯一标识符,因为它没有考虑:
- 可用于覆盖属性的 config kwargs
- 用于写入数据集的自定义 features
- json/text/csv/pandas 数据集的 data_files
因此,配置 ID 仅是带有基于上述内容的可选后缀的配置名称。
下载
class datasets.DownloadManager
< 源码 >( dataset_name: typing.Optional[str] = None data_dir: typing.Optional[str] = None download_config: typing.Optional[datasets.download.download_config.DownloadConfig] = None base_path: typing.Optional[str] = None record_checksums = True )
下载
< 源码 >( url_or_urls ) → str 或 list 或 dict
下载给定 URL。
默认情况下,仅使用一个进程进行下载。传递自定义的 download_config.num_proc 以更改此行为。
download_and_extract
< 源码 >( url_or_urls ) → extracted_path(s)
下载并解压给定的 url_or_urls。
extract
< 源码 >( path_or_paths ) → extracted_path(s)
解压给定的路径。
iter_archive
< 源码 >( path_or_buf: typing.Union[str, _io.BufferedReader] ) → tuple[str, io.BufferedReader]
遍历归档中的文件。
iter_files
< 源码 >( paths: typing.Union[str, list[str]] ) → str
遍历文件路径。
class datasets.StreamingDownloadManager
< 源码 >( dataset_name: typing.Optional[str] = None data_dir: typing.Optional[str] = None download_config: typing.Optional[datasets.download.download_config.DownloadConfig] = None base_path: typing.Optional[str] = None )
下载管理器,使用 “::” 分隔符来导航(可能的远程)压缩归档文件。与常规的 DownloadManager 不同,download 和 extract 方法实际上并不下载或解压数据,而是返回可以使用 xopen 函数打开的路径或 URL,xopen 函数扩展了内置的 open 函数,用于从远程文件流式传输数据。
下载
< 源码 >( url_or_urls ) → url(s)
规范化用于流式传输数据的文件 URL(s)。这是 DownloadManager.download 的惰性版本,用于流式传输。
download_and_extract
< 源码 >( url_or_urls ) → url(s)
为流式传输准备给定的 url_or_urls(添加解压协议)。
这是 DownloadManager.download_and_extract 的惰性版本,用于流式传输。
extract
< 源码 >( url_or_urls ) → url(s)
为流式传输添加给定 URL(s) 的解压协议。
这是 DownloadManager.extract 的惰性版本,用于流式传输。
iter_archive
< 源码 >( urlpath_or_buf: typing.Union[str, _io.BufferedReader] ) → tuple[str, io.BufferedReader]
遍历归档中的文件。
iter_files
< 源码 >( urlpaths: typing.Union[str, list[str]] ) → str
遍历文件。
class datasets.DownloadConfig
< 源码 >( cache_dir: typing.Union[str, pathlib.Path, NoneType] = None force_download: bool = False resume_download: bool = False local_files_only: bool = False proxies: typing.Optional[dict] = None user_agent: typing.Optional[str] = None extract_compressed_file: bool = False force_extract: bool = False delete_extracted: bool = False extract_on_the_fly: bool = False use_etag: bool = True num_proc: typing.Optional[int] = None max_retries: int = 1 token: typing.Union[str, bool, NoneType] = None storage_options: dict = <factory> download_desc: typing.Optional[str] = None disable_tqdm: bool = False )
参数
- cache_dir (
str或Path,可选) — 指定保存文件的缓存目录(覆盖默认的缓存目录)。 - force_download (
bool,默认为False) — 如果为True,即使文件已缓存在缓存目录中,也重新下载。 - resume_download (
bool,默认为False) — 如果为True,在找到未完成的文件时恢复下载。 - proxies (
dict, 可选) — - user_agent (
str, 可选) — 可选的字符串或字典,将附加到远程请求的用户代理(user-agent)中。 - extract_compressed_file (
bool, 默认为False) — 如果为True且路径指向 zip 或 tar 文件,则将压缩文件解压到归档文件所在的文件夹中。 - force_extract (
bool, 默认为False) — 如果extract_compressed_file为True且归档文件已解压,若该参数为True,则重新解压归档文件并覆盖之前的解压目录。 - delete_extracted (
bool, 默认为False) — 是否删除(或保留)解压后的文件。 - extract_on_the_fly (
bool, 默认为False) — 如果为True,则在读取压缩文件时实时解压。 - use_etag (
bool, 默认为True) — 是否使用 ETag HTTP 响应头来验证缓存文件。 - num_proc (
int, 可选) — 用于并行下载文件的进程数。 - max_retries (
int, 默认为1) — HTTP 请求失败时的重试次数。 - token (
str或bool, 可选) — 用于 Datasets Hub 远程文件的 Bearer 令牌(可选字符串或布尔值)。如果为True或未指定,将从~/.huggingface获取令牌。 - storage_options (
dict, 可选) — 如有需要,传递给数据集文件系统后端的键值对。 - download_desc (
str, 可选) — 下载文件时与进度条一起显示的描述信息。 - disable_tqdm (
bool, 默认为False) — 是否禁用单个文件下载的进度条。
用于缓存路径管理器的配置。
class datasets.DownloadMode
< 源代码 >( value names = None module = None qualname = None type = None start = 1 )
用于处理预先存在的下载和数据的 Enum。
默认模式为 REUSE_DATASET_IF_EXISTS,它会在原始下载和已准备好的数据集存在时重用它们。
生成模式
| 下载 | 数据集 | |
|---|---|---|
REUSE_DATASET_IF_EXISTS (默认) | 重用 | 重用 |
REUSE_CACHE_IF_EXISTS | 重用 | 全新 |
FORCE_REDOWNLOAD | 全新 | 全新 |
验证
class datasets.VerificationMode
< 源代码 >( value names = None module = None qualname = None type = None start = 1 )
用于指定执行哪些验证检查的 Enum。
默认模式为 BASIC_CHECKS,它仅执行基础检查,以避免在首次生成/下载数据集时产生延迟。
验证模式
| 验证检查 | |
|---|---|
ALL_CHECKS | 分割检查和已下载文件的有效性(文件数量、校验和) |
BASIC_CHECKS (默认) | 与 ALL_CHECKS 相同,但不检查已下载的文件 |
NO_CHECKS | 无 |
数据集分割 (Splits)
class datasets.SplitGenerator
< 源代码 >( name: str gen_kwargs: dict = <factory> )
定义生成器的分割信息。
这应该作为 GeneratorBasedBuilder._split_generators 的返回值使用。有关更多信息和使用示例,请参见 GeneratorBasedBuilder._split_generators。
用于数据集分割的 Enum。
数据集通常被划分为不同的子集,用于训练和评估的各个阶段。
TRAIN:训练数据。VALIDATION:验证数据。如果存在,它通常用于在迭代模型时(例如更改超参数、模型架构等)作为评估数据。TEST:测试数据。这是用于报告指标的数据。通常不建议在模型迭代期间使用它,以避免过拟合。ALL:所有定义的数据集分割的并集。
所有分割(包括组合)均继承自 datasets.SplitBase。
有关更多信息,请参阅关于分割的指南。
示例
>>> datasets.SplitGenerator(
... name=datasets.Split.TRAIN,
... gen_kwargs={"split_key": "train", "files": dl_manager.download_and extract(url)},
... ),
... datasets.SplitGenerator(
... name=datasets.Split.VALIDATION,
... gen_kwargs={"split_key": "validation", "files": dl_manager.download_and extract(url)},
... ),
... datasets.SplitGenerator(
... name=datasets.Split.TEST,
... gen_kwargs={"split_key": "test", "files": dl_manager.download_and extract(url)},
... )对应于命名分割(训练、测试等)的描述符。
示例
每个描述符可以通过加法或切片与其他描述符组合。
split = datasets.Split.TRAIN.subsplit(datasets.percent[0:25]) + datasets.Split.TEST生成的分割将对应于训练分割的 25% 与测试分割的 100% 的合并。
一个分割不能被添加两次,因此以下操作将失败:
split = (
datasets.Split.TRAIN.subsplit(datasets.percent[:25]) +
datasets.Split.TRAIN.subsplit(datasets.percent[75:])
) # Error
split = datasets.Split.TEST + datasets.Split.ALL # Error对应于所有定义的数据集分割的并集的分割。
class datasets.ReadInstruction
< 源代码 >( split_name rounding = None from_ = None to = None unit = None )
数据集的读取指令。
示例
# The following lines are equivalent:
ds = datasets.load_dataset('ylecun/mnist', split='test[:33%]')
ds = datasets.load_dataset('ylecun/mnist', split=datasets.ReadInstruction.from_spec('test[:33%]'))
ds = datasets.load_dataset('ylecun/mnist', split=datasets.ReadInstruction('test', to=33, unit='%'))
ds = datasets.load_dataset('ylecun/mnist', split=datasets.ReadInstruction(
'test', from_=0, to=33, unit='%'))
# The following lines are equivalent:
ds = datasets.load_dataset('ylecun/mnist', split='test[:33%]+train[1:-1]')
ds = datasets.load_dataset('ylecun/mnist', split=datasets.ReadInstruction.from_spec(
'test[:33%]+train[1:-1]'))
ds = datasets.load_dataset('ylecun/mnist', split=(
datasets.ReadInstruction('test', to=33, unit='%') +
datasets.ReadInstruction('train', from_=1, to=-1, unit='abs')))
# The following lines are equivalent:
ds = datasets.load_dataset('ylecun/mnist', split='test[:33%](pct1_dropremainder)')
ds = datasets.load_dataset('ylecun/mnist', split=datasets.ReadInstruction.from_spec(
'test[:33%](pct1_dropremainder)'))
ds = datasets.load_dataset('ylecun/mnist', split=datasets.ReadInstruction(
'test', from_=0, to=33, unit='%', rounding="pct1_dropremainder"))
# 10-fold validation:
tests = datasets.load_dataset(
'ylecun/mnist',
[datasets.ReadInstruction('train', from_=k, to=k+10, unit='%')
for k in range(0, 100, 10)])
trains = datasets.load_dataset(
'ylecun/mnist',
[datasets.ReadInstruction('train', to=k, unit='%') + datasets.ReadInstruction('train', from_=k+10, unit='%')
for k in range(0, 100, 10)])from_spec
< 源代码 >( spec )
根据字符串规范创建 ReadInstruction 实例。
示例
test: test split.
test + validation: test split + validation split.
test[10:]: test split, minus its first 10 records.
test[:10%]: first 10% records of test split.
test[:20%](pct1_dropremainder): first 10% records, rounded with the pct1_dropremainder rounding.
test[:-5%]+train[40%:60%]: first 95% of test + middle 20% of train.Version
class datasets.Version
< 源代码 >( version_str: str description: typing.Optional[str] = None major: typing.Union[str, int, NoneType] = None minor: typing.Union[str, int, NoneType] = None patch: typing.Union[str, int, NoneType] = None )
数据集版本 MAJOR.MINOR.PATCH。