mindspore/docs/api/api_python/dataset/mindspore.dataset.TextFileDataset.rst

mindspore.dataset.TextFileDataset
==================================

.. py:class:: mindspore.dataset.TextFileDataset(dataset_files, num_samples=None, num_parallel_workers=None, shuffle=<Shuffle.GLOBAL: 'global'>, num_shards=None, shard_id=None, cache=None)

    用于读取和解析文本格式的文件作为源数据集。生成的数据集有一个数据列: `[text]` ，类型为string。

    **参数：**

    - **dataset_files** (Union[str, list[str]])：数据集文件路径，支持单文件路径字符串、多文件路径字符串列表或可被glob库模式匹配的字符串，文件列表将在内部进行字典排序。
    - **num_samples** (int，可选)：指定从数据集中读取的样本数（默认为None，即读取所有样本）。
    - **num_parallel_workers** (int，可选)：指定读取数据的工作线程数(默认值None，即使用mindspore.dataset.config中配置的线程数）。
    - **shuffle** (Union[bool, Shuffle level], 可选)：每个epoch中数据混洗的模式（默认为为mindspore.dataset.Shuffle.GLOBAL）。如果为False，则不混洗；如果为True，等同于将 `shuffle` 设置为mindspore.dataset.Shuffle.GLOBAL。另外也可以传入枚举变量设置shuffle级别：
        
        - Shuffle.GLOBAL：混洗文件和样本。
        - Shuffle.FILES：仅混洗文件。

    - **num_shards** (int, 可选)：指定分布式训练时将数据集进行划分的分片数（默认值None）。指定此参数后, `num_samples` 表示每个分片的最大样本数。
    - **shard_id** (int, 可选)：指定分布式训练时使用的分片ID号（默认值None）。只有当指定了 `num_shards` 时才能指定此参数。
    - **cache** (DatasetCache, 可选)：数据缓存客户端实例，用于加快数据集处理速度（默认为None，不使用缓存）。

    **异常：**

    - **RuntimeError**： `dataset_files` 所指的文件无效或不存在。
    - **RuntimeError**： `num_parallel_workers` 超过系统最大线程数。
    - **RuntimeError**：指定了 `num_shards` 参数，但是未指定 `shard_id` 参数。
    - **RuntimeError**：指定了 `shard_id` 参数，但是未指定 `num_shards` 参数。

    **样例：**

    >>> text_file_dataset_dir = ["/path/to/text_file_dataset_file"] # # 此列表可以包含1个或多个文本文件
    >>> dataset = ds.TextFileDataset(dataset_files=text_file_dataset_dir)

    .. include:: mindspore.dataset.Dataset.rst

    .. include:: mindspore.dataset.Dataset.zip.rst