#
Loading methods

Methods for listing and loading datasets and metrics:

##
Datasets

####
datasets.list_datasets

< source >

( with_community_datasets = True with_details = False )

Parameters

- with_community_datasets (`bool`, optional, defaults to `True`) — Include the community provided datasets.
- with_details (`bool`, optional, defaults to `False`) — Return the full details on the datasets instead of only the short name.

List all the datasets scripts available on the Hugging Face Hub.

Example:

    >>> from datasets import list_datasets
    >>> list_datasets()
    ['acronym_identification',
     'ade_corpus_v2',
     'adversarial_qa',
     'aeslc',
     'afrikaans_ner_corpus',
     'ag_news',
     ...
    ]

####
datasets.load_dataset

< source >

( path: str name: Optional = None data_dir: Optional = None data_files: Union = None split: Union = None cache_dir: Optional = None features: Optional = None download_config: Optional = None download_mode: Union = None verification_mode: Union = None ignore_verifications = 'deprecated' keep_in_memory: Optional = None save_infos: bool = False revision: Union = None token: Union = None use_auth_token = 'deprecated' task = 'deprecated' streaming: bool = False num_proc: Optional = None storage_options: Optional = None trust_remote_code: bool = None **config_kwargs ) →
Dataset or DatasetDict

Parameters

- path (`str`) — Path or name of the dataset. Depending on `path`, the dataset builder that is used comes from a generic dataset script (JSON, CSV, Parquet, text etc.) or from the dataset script (a python file) inside the dataset directory.

  For local datasets:

  - if `path` is a local directory (containing data files only) -> load a generic dataset builder (csv, json, text etc.) based on the content of the directory e.g. `'./path/to/directory/with/my/csv/data'`.
  - if `path` is a local dataset script or a directory containing a local dataset script (if the script has the same name as the directory) -> load the dataset builder from the dataset script e.g. `'./dataset/squad'` or `'./dataset/squad/squad.py'`.

  For datasets on the Hugging Face Hub (list all available datasets with `huggingface_hub.list_datasets`)

  - if `path` is a dataset repository on the HF hub (containing data files only) -> load a generic dataset builder (csv, text etc.) based on the content of the repository e.g. `'username/dataset_name'`, a dataset repository on the HF hub containing your data files.
  - if `path` is a dataset repository on the HF hub with a dataset script (if the script has the same name as the directory) -> load the dataset builder from the dataset script in the dataset repository e.g. `glue`, `squad`, `'username/dataset_name'`, a dataset repository on the HF hub containing a dataset script `'dataset_name.py'`.
- name (`str`, optional) — Defining the name of the dataset configuration.
- data_dir (`str`, optional) — Defining the `data_dir` of the dataset configuration. If specified for the generic builders (csv, text etc.) or the Hub datasets and `data_files` is `None`, the behavior is equal to passing `os.path.join(data_dir, **)` as `data_files` to reference all the files in a directory.
- data_files (`str` or `Sequence` or `Mapping`, optional) — Path(s) to source data file(s).
- split (`Split` or `str`) — Which split of the data to load. If `None`, will return a `dict` with all splits (typically `datasets.Split.TRAIN` and `datasets.Split.TEST`). If given, will return a single Dataset. Splits can be combined and specified like in tensorflow-datasets.
- cache_dir (`str`, optional) — Directory to read/write data. Defaults to `"~/.cache/huggingface/datasets"`.
- features (`Features`, optional) — Set the features type to use for this dataset.
- download_config (DownloadConfig, optional) — Specific download configuration parameters.
- download_mode (DownloadMode or `str`, defaults to `REUSE_DATASET_IF_EXISTS`) — Download/generate mode.
- verification_mode (VerificationMode or `str`, defaults to `BASIC_CHECKS`) — Verification mode determining the checks to run on the downloaded/processed dataset information (checksums/size/splits/…).

  Added in 2.9.1

- ignore_verifications (`bool`, defaults to `False`) — Ignore the verifications of the downloaded/processed dataset information (checksums/size/splits/…).

  Deprecated in 2.9.1

  `ignore_verifications` was deprecated in version 2.9.1 and will be removed in 3.0.0. Please use `verification_mode` instead.

- keep_in_memory (`bool`, defaults to `None`) — Whether to copy the dataset in-memory. If `None`, the dataset will not be copied in-memory unless explicitly enabled by setting `datasets.config.IN_MEMORY_MAX_SIZE` to nonzero. See more details in the improve performance section.
- save_infos (`bool`, defaults to `False`) — Save the dataset information (checksums/size/splits/…).
- revision (Version or `str`, optional) — Version of the dataset script to load. As datasets have their own git repository on the Datasets Hub, the default version “main” corresponds to their “main” branch. You can specify a different version than the default “main” by using a commit SHA or a git tag of the dataset repository.
- token (`str` or `bool`, optional) — Optional string or boolean to use as Bearer token for remote files on the Datasets Hub. If `True`, or not specified, will get token from `"~/.huggingface"`.
- use_auth_token (`str` or `bool`, optional) — Optional string or boolean to use as Bearer token for remote files on the Datasets Hub. If `True`, or not specified, will get token from `"~/.huggingface"`.

  Deprecated in 2.14.0

  `use_auth_token` was deprecated in favor of `token` in version 2.14.0 and will be removed in 3.0.0.

- task (`str`) — The task to prepare the dataset for during training and evaluation. Casts the dataset’s Features to standardized column names and types as detailed in `datasets.tasks`.

  Deprecated in 2.13.0

  `task` was deprecated in version 2.13.0 and will be removed in 3.0.0.

- streaming (`bool`, defaults to `False`) — If set to `True`, don’t download the data files. Instead, it streams the data progressively while iterating on the dataset. An IterableDataset or IterableDatasetDict is returned instead in this case.

  Note that streaming works for datasets that use data formats that support being iterated over like txt, csv, jsonl for example. Json files may be downloaded completely. Also streaming from remote zip or gzip files is supported but other compressed formats like rar and xz are not yet supported. The tgz format doesn’t allow streaming.

- num_proc (`int`, optional, defaults to `None`) — Number of processes when downloading and generating the dataset locally. Multiprocessing is disabled by default.

  Added in 2.7.0

- storage_options (`dict`, optional, defaults to `None`) — Experimental. Key/value pairs to be passed on to the dataset file-system backend, if any.

  Added in 2.11.0

- trust_remote_code (`bool`, defaults to `True`) — Whether or not to allow for datasets defined on the Hub using a dataset script. This option should only be set to `True` for repositories you trust and in which you have read the code, as it will execute code present on the Hub on your local machine.

  `trust_remote_code` will default to False in the next major release.

  Added in 2.16.0

- **config_kwargs (additional keyword arguments) — Keyword arguments to be passed to the `BuilderConfig` and used in the DatasetBuilder.

Returns

Dataset or DatasetDict

- if `split` is not `None`: the dataset requested,
- if `split` is `None`, a DatasetDict with each split.

or IterableDataset or IterableDatasetDict: if `streaming=True`

- if `split` is not `None`, the dataset is requested
- if `split` is `None`, a `~datasets.streaming.IterableDatasetDict` with each split.

Load a dataset from the Hugging Face Hub, or a local dataset.

You can find the list of datasets on the Hub or with `huggingface_hub.list_datasets`.

A dataset is a directory that contains:

- some data files in generic formats (JSON, CSV, Parquet, text, etc.).
- and optionally a dataset script, if it requires some code to read the data files. This is used to load any kind of formats or structures.

Note that dataset scripts can also download and read data files from anywhere - in case your data files already exist online.

This function does the following under the hood:

1. Download and import in the library the dataset script from `path` if it’s not already cached inside the library.

   If the dataset has no dataset script, then a generic dataset script is imported instead (JSON, CSV, Parquet, text, etc.)

   Dataset scripts are small python scripts that define dataset builders. They define the citation, info and format of the dataset, contain the path or URL to the original data files and the code to load examples from the original data files.

   You can find the complete list of datasets in the Datasets Hub.

2. Run the dataset script which will:

   - Download the dataset file from the original URL (see the script) if it’s not already available locally or cached.

   - Process and cache the dataset in typed Arrow tables for caching.

     Arrow table are arbitrarily long, typed tables which can store nested objects and be mapped to numpy/pandas/python generic types. They can be directly accessed from disk, loaded in RAM or even streamed over the web.

3. Return a dataset built from the requested splits in `split` (default: all).

It also allows to load a dataset from a local directory or a dataset repository on the Hugging Face Hub without dataset script. In this case, it automatically loads all the data files from the directory or the dataset repository.

Example:

Load a dataset from the Hugging Face Hub:

    >>> from datasets import load_dataset
    >>> ds = load_dataset('rotten_tomatoes', split='train')

    # Map data files to splits
    >>> data_files = {'train': 'train.csv', 'test': 'test.csv'}
    >>> ds = load_dataset('namespace/your_dataset_name', data_files=data_files)

Load a local dataset:

    # Load a CSV file
    >>> from datasets import load_dataset
    >>> ds = load_dataset('csv', data_files='path/to/local/my_dataset.csv')

    # Load a JSON file
    >>> from datasets import load_dataset
    >>> ds = load_dataset('json', data_files='path/to/local/my_dataset.json')

    # Load from a local loading script
    >>> from datasets import load_dataset
    >>> ds = load_dataset('path/to/local/loading_script/loading_script.py', split='train')

Load an IterableDataset:

    >>> from datasets import load_dataset
    >>> ds = load_dataset('rotten_tomatoes', split='train', streaming=True)

Load an image dataset with the `ImageFolder` dataset builder:

    >>> from datasets import load_dataset
    >>> ds = load_dataset('imagefolder', data_dir='/path/to/images', split='train')

####
datasets.load_from_disk

< source >

( dataset_path: str fs = 'deprecated' keep_in_memory: Optional = None storage_options: Optional = None ) →
Dataset or DatasetDict

Parameters

- dataset_path (`str`) — Path (e.g. `"dataset/train"`) or remote URI (e.g. `"s3://my-bucket/dataset/train"`) of the Dataset or DatasetDict directory where the dataset will be loaded from.
- fs (`~filesystems.S3FileSystem` or `fsspec.spec.AbstractFileSystem`, optional) — Instance of the remote filesystem used to download the files from.

  Deprecated in 2.9.0

  `fs` was deprecated in version 2.9.0 and will be removed in 3.0.0. Please use `storage_options` instead, e.g. `storage_options=fs.storage_options`.

- keep_in_memory (`bool`, defaults to `None`) — Whether to copy the dataset in-memory. If `None`, the dataset will not be copied in-memory unless explicitly enabled by setting `datasets.config.IN_MEMORY_MAX_SIZE` to nonzero. See more details in the improve performance section.
- storage_options (`dict`, optional) — Key/value pairs to be passed on to the file-system backend, if any.

  Added in 2.9.0

Returns

Dataset or DatasetDict

- If `dataset_path` is a path of a dataset directory: the dataset requested.
- If `dataset_path` is a path of a dataset dict directory, a DatasetDict with each split.

Loads a dataset that was previously saved using save_to_disk() from a dataset directory, or from a filesystem using any implementation of `fsspec.spec.AbstractFileSystem`.

Example:

    >>> from datasets import load_from_disk
    >>> ds = load_from_disk('path/to/dataset/directory')

####
datasets.load_dataset_builder

< source >

( path: str name: Optional = None data_dir: Optional = None data_files: Union = None cache_dir: Optional = None features: Optional = None download_config: Optional = None download_mode: Union = None revision: Union = None token: Union = None use_auth_token = 'deprecated' storage_options: Optional = None trust_remote_code: Optional = None _require_default_config_name = True **config_kwargs )

Parameters

- path (`str`) — Path or name of the dataset. Depending on `path`, the dataset builder that is used comes from a generic dataset script (JSON, CSV, Parquet, text etc.) or from the dataset script (a python file) inside the dataset directory.

  For local datasets:

  - if `path` is a local directory (containing data files only) -> load a generic dataset builder (csv, json, text etc.) based on the content of the directory e.g. `'./path/to/directory/with/my/csv/data'`.
  - if `path` is a local dataset script or a directory containing a local dataset script (if the script has the same name as the directory) -> load the dataset builder from the dataset script e.g. `'./dataset/squad'` or `'./dataset/squad/squad.py'`.

  For datasets on the Hugging Face Hub (list all available datasets with `huggingface_hub.list_datasets`)

  - if `path` is a dataset repository on the HF hub (containing data files only) -> load a generic dataset builder (csv, text etc.) based on the content of the repository e.g. `'username/dataset_name'`, a dataset repository on the HF hub containing your data files.
  - if `path` is a dataset repository on the HF hub with a dataset script (if the script has the same name as the directory) -> load the dataset builder from the dataset script in the dataset repository e.g. `glue`, `squad`, `'username/dataset_name'`, a dataset repository on the HF hub containing a dataset script `'dataset_name.py'`.
- name (`str`, optional) — Defining the name of the dataset configuration.
- data_dir (`str`, optional) — Defining the `data_dir` of the dataset configuration. If specified for the generic builders (csv, text etc.) or the Hub datasets and `data_files` is `None`, the behavior is equal to passing `os.path.join(data_dir, **)` as `data_files` to reference all the files in a directory.
- data_files (`str` or `Sequence` or `Mapping`, optional) — Path(s) to source data file(s).
- cache_dir (`str`, optional) — Directory to read/write data. Defaults to `"~/.cache/huggingface/datasets"`.
- features (Features, optional) — Set the features type to use for this dataset.
- download_config (DownloadConfig, optional) — Specific download configuration parameters.
- download_mode (DownloadMode or `str`, defaults to `REUSE_DATASET_IF_EXISTS`) — Download/generate mode.
- revision (Version or `str`, optional) — Version of the dataset script to load. As datasets have their own git repository on the Datasets Hub, the default version “main” corresponds to their “main” branch. You can specify a different version than the default “main” by using a commit SHA or a git tag of the dataset repository.
- token (`str` or `bool`, optional) — Optional string or boolean to use as Bearer token for remote files on the Datasets Hub. If `True`, or not specified, will get token from `"~/.huggingface"`.
- use_auth_token (`str` or `bool`, optional) — Optional string or boolean to use as Bearer token for remote files on the Datasets Hub. If `True`, or not specified, will get token from `"~/.huggingface"`.

  Deprecated in 2.14.0

  `use_auth_token` was deprecated in favor of `token` in version 2.14.0 and will be removed in 3.0.0.

- storage_options (`dict`, optional, defaults to `None`) — Experimental. Key/value pairs to be passed on to the dataset file-system backend, if any.

  Added in 2.11.0

- trust_remote_code (`bool`, defaults to `True`) — Whether or not to allow for datasets defined on the Hub using a dataset script. This option should only be set to `True` for repositories you trust and in which you have read the code, as it will execute code present on the Hub on your local machine.

  `trust_remote_code` will default to False in the next major release.

  Added in 2.16.0

- **config_kwargs (additional keyword arguments) — Keyword arguments to be passed to the BuilderConfig and used in the DatasetBuilder.

Load a dataset builder from the Hugging Face Hub, or a local dataset. A dataset builder can be used to inspect general information that is required to build a dataset (cache directory, config, dataset info, etc.) without downloading the dataset itself.

You can find the list of datasets on the Hub or with `huggingface_hub.list_datasets`.

A dataset is a directory that contains:

- some data files in generic formats (JSON, CSV, Parquet, text, etc.)
- and optionally a dataset script, if it requires some code to read the data files. This is used to load any kind of formats or structures.

Note that dataset scripts can also download and read data files from anywhere - in case your data files already exist online.

Example:

    >>> from datasets import load_dataset_builder
    >>> ds_builder = load_dataset_builder('rotten_tomatoes')
    >>> ds_builder.info.features
    {'label': ClassLabel(num_classes=2, names=['neg', 'pos'], id=None),
     'text': Value(dtype='string', id=None)}

####
datasets.get_dataset_config_names

< source >

( path: str revision: Union = None download_config: Optional = None download_mode: Union = None dynamic_modules_path: Optional = None data_files: Union = None **download_kwargs )

Parameters

- path (`str`) — path to the dataset processing script with the dataset builder. Can be either:
  - a local path to processing script or the directory containing the script (if the script has the same name as the directory), e.g. `'./dataset/squad'` or `'./dataset/squad/squad.py'`
  - a dataset identifier on the Hugging Face Hub (list all available datasets and ids with datasets.list_datasets()) e.g. `'squad'`, `'glue'` or `'openai/webtext'`
- revision (`Union[str, datasets.Version]`, optional) — If specified, the dataset module will be loaded from the datasets repository at this version. By default:
  - it is set to the local version of the lib.
  - it will also try to load it from the main branch if it’s not available at the local version of the lib. Specifying a version that is different from your local version of the lib might cause compatibility issues.
- download_config (DownloadConfig, optional) — Specific download configuration parameters.
- download_mode (DownloadMode or `str`, defaults to `REUSE_DATASET_IF_EXISTS`) — Download/generate mode.
- dynamic_modules_path (`str`, defaults to `~/.cache/huggingface/modules/datasets_modules`) — Optional path to the directory in which the dynamic modules are saved. It must have been initialized with `init_dynamic_modules`. By default the datasets and metrics are stored inside the `datasets_modules` module.
- data_files (`Union[Dict, List, str]`, optional) — Defining the data_files of the dataset configuration.
- **download_kwargs (additional keyword arguments) — Optional attributes for DownloadConfig which will override the attributes in `download_config` if supplied, for example `token`.

Get the list of available config names for a particular dataset.

Example:

    >>> from datasets import get_dataset_config_names
    >>> get_dataset_config_names("glue")
    ['cola',
     'sst2',
     'mrpc',
     'qqp',
     'stsb',
     'mnli',
     'mnli_mismatched',
     'mnli_matched',
     'qnli',
     'rte',
     'wnli',
     'ax']

####
datasets.get_dataset_infos

< source >

( path: str data_files: Union = None download_config: Optional = None download_mode: Union = None revision: Union = None token: Union = None use_auth_token = 'deprecated' **config_kwargs )

Parameters

- path (`str`) — path to the dataset processing script with the dataset builder. Can be either:
  - a local path to processing script or the directory containing the script (if the script has the same name as the directory), e.g. `'./dataset/squad'` or `'./dataset/squad/squad.py'`
  - a dataset identifier on the Hugging Face Hub (list all available datasets and ids with datasets.list_datasets()) e.g. `'squad'`, `'glue'` or``'openai/webtext'`
- revision (`Union[str, datasets.Version]`, optional) — If specified, the dataset module will be loaded from the datasets repository at this version. By default:
  - it is set to the local version of the lib.
  - it will also try to load it from the main branch if it’s not available at the local version of the lib. Specifying a version that is different from your local version of the lib might cause compatibility issues.
- download_config (DownloadConfig, optional) — Specific download configuration parameters.
- download_mode (DownloadMode or `str`, defaults to `REUSE_DATASET_IF_EXISTS`) — Download/generate mode.
- data_files (`Union[Dict, List, str]`, optional) — Defining the data_files of the dataset configuration.
- token (`str` or `bool`, optional) — Optional string or boolean to use as Bearer token for remote files on the Datasets Hub. If `True`, or not specified, will get token from `"~/.huggingface"`.
- use_auth_token (`str` or `bool`, optional) — Optional string or boolean to use as Bearer token for remote files on the Datasets Hub. If `True`, or not specified, will get token from `"~/.huggingface"`.

  Deprecated in 2.14.0

  `use_auth_token` was deprecated in favor of `token` in version 2.14.0 and will be removed in 3.0.0.

- **config_kwargs (additional keyword arguments) — Optional attributes for builder class which will override the attributes if supplied.

Get the meta information about a dataset, returned as a dict mapping config name to DatasetInfoDict.

Example:

    >>> from datasets import get_dataset_infos
    >>> get_dataset_infos('rotten_tomatoes')
    {'default': DatasetInfo(description="Movie Review Dataset.
     is a dataset of containing 5,331 positive and 5,331 negative processed
    ences from Rotten Tomatoes movie reviews...), ...}

####
datasets.get_dataset_split_names

< source >

( path: str config_name: Optional = None data_files: Union = None download_config: Optional = None download_mode: Union = None revision: Union = None token: Union = None use_auth_token = 'deprecated' **config_kwargs )

Parameters

- path (`str`) — path to the dataset processing script with the dataset builder. Can be either:
  - a local path to processing script or the directory containing the script (if the script has the same name as the directory), e.g. `'./dataset/squad'` or `'./dataset/squad/squad.py'`
  - a dataset identifier on the Hugging Face Hub (list all available datasets and ids with datasets.list_datasets()) e.g. `'squad'`, `'glue'` or `'openai/webtext'`
- config_name (`str`, optional) — Defining the name of the dataset configuration.
- data_files (`str` or `Sequence` or `Mapping`, optional) — Path(s) to source data file(s).
- download_config (DownloadConfig, optional) — Specific download configuration parameters.
- download_mode (DownloadMode or `str`, defaults to `REUSE_DATASET_IF_EXISTS`) — Download/generate mode.
- revision (Version or `str`, optional) — Version of the dataset script to load. As datasets have their own git repository on the Datasets Hub, the default version “main” corresponds to their “main” branch. You can specify a different version than the default “main” by using a commit SHA or a git tag of the dataset repository.
- token (`str` or `bool`, optional) — Optional string or boolean to use as Bearer token for remote files on the Datasets Hub. If `True`, or not specified, will get token from `"~/.huggingface"`.
- use_auth_token (`str` or `bool`, optional) — Optional string or boolean to use as Bearer token for remote files on the Datasets Hub. If `True`, or not specified, will get token from `"~/.huggingface"`.

  Deprecated in 2.14.0

  `use_auth_token` was deprecated in favor of `token` in version 2.14.0 and will be removed in 3.0.0.

- **config_kwargs (additional keyword arguments) — Optional attributes for builder class which will override the attributes if supplied.

Get the list of available splits for a particular config and dataset.

Example:

    >>> from datasets import get_dataset_split_names
    >>> get_dataset_split_names('rotten_tomatoes')
    ['train', 'validation', 'test']

####
datasets.inspect_dataset

< source >

( path: str local_path: str download_config: Optional = None **download_kwargs )

Parameters

- path (`str`) — Path to the dataset processing script with the dataset builder. Can be either:
  - a local path to processing script or the directory containing the script (if the script has the same name as the directory), e.g. `'./dataset/squad'` or `'./dataset/squad/squad.py'`.
  - a dataset identifier on the Hugging Face Hub (list all available datasets and ids with list_datasets()) e.g. `'squad'`, `'glue'` or `'openai/webtext'`.
- local_path (`str`) — Path to the local folder to copy the dataset script to.
- download_config (DownloadConfig, optional) — Specific download configuration parameters.
- **download_kwargs (additional keyword arguments) — Optional arguments for DownloadConfig which will override the attributes of `download_config` if supplied.

Allow inspection/modification of a dataset script by copying on local drive at local_path.

##
Metrics

Metrics is deprecated in 🤗 Datasets. To learn more about how to use metrics, take a look at the library 🤗 Evaluate! In addition to metrics, you can find more tools for evaluating models and datasets.

####
datasets.list_metrics

< source >

( with_community_metrics = True with_details = False )

Parameters

- with_community_metrics (`bool`, optional, default `True`) — Include the community provided metrics.
- with_details (`bool`, optional, default `False`) — Return the full details on the metrics instead of only the short name.

List all the metrics script available on the Hugging Face Hub.

Deprecated in 2.5.0

Use evaluate.list_evaluation_modules instead, from the new library 🤗 Evaluate: https://huggingface.co/docs/evaluate

Example:

    >>> from datasets import list_metrics
    >>> list_metrics()
    ['accuracy',
     'bertscore',
     'bleu',
     'bleurt',
     'cer',
     'chrf',
     ...
    ]

####
datasets.load_metric

< source >

( path: str config_name: Optional = None process_id: int = 0 num_process: int = 1 cache_dir: Optional = None experiment_id: Optional = None keep_in_memory: bool = False download_config: Optional = None download_mode: Union = None revision: Union = None trust_remote_code: Optional = None **metric_init_kwargs )

Parameters

- path (`str`) — path to the metric processing script with the metric builder. Can be either:
  - a local path to processing script or the directory containing the script (if the script has the same name as the directory), e.g. `'./metrics/rouge'` or `'./metrics/rogue/rouge.py'`
  - a metric identifier on the HuggingFace datasets repo (list all available metrics with `datasets.list_metrics()`) e.g. `'rouge'` or `'bleu'`
- config_name (`str`, optional) — selecting a configuration for the metric (e.g. the GLUE metric has a configuration for each subset)
- process_id (`int`, optional) — for distributed evaluation: id of the process
- num_process (`int`, optional) — for distributed evaluation: total number of processes
- cache_dir (Optional str) — path to store the temporary predictions and references (default to ~/.cache/huggingface/metrics/)
- experiment_id (`str`) — A specific experiment id. This is used if several distributed evaluations share the same file system. This is useful to compute metrics in distributed setups (in particular non-additive metrics like F1).
- keep_in_memory (bool) — Whether to store the temporary results in memory (defaults to False)
- download_config (Optional `datasets.DownloadConfig` — specific download configuration parameters.
- download_mode (DownloadMode or `str`, default `REUSE_DATASET_IF_EXISTS`) — Download/generate mode.
- revision (Optional `Union[str, datasets.Version]`) — if specified, the module will be loaded from the datasets repository at this version. By default, it is set to the local version of the lib. Specifying a version that is different from your local version of the lib might cause compatibility issues.
- trust_remote_code (bool, defaults to True) — Whether or not to allow for datasets defined on the Hub using a dataset script. This option should only be set to True for repositories you trust and in which you have read the code, as it will execute code present on the Hub on your local machine.

  trust_remote_code will default to False in the next major release.

  Added in 2.16.0

Load a datasets.Metric.

Deprecated in 2.5.0

Use evaluate.load instead, from the new library 🤗 Evaluate: https://huggingface.co/docs/evaluate

Example:

    >>> from datasets import load_metric
    >>> accuracy = load_metric('accuracy')
    >>> accuracy.compute(references=[1, 0], predictions=[1, 1])
    {'accuracy': 0.5}

####
datasets.inspect_metric

< source >

( path: str local_path: str download_config: Optional = None **download_kwargs )

Parameters

- path (`str`) — path to the dataset processing script with the dataset builder. Can be either:
  - a local path to processing script or the directory containing the script (if the script has the same name as the directory), e.g. `'./dataset/squad'` or `'./dataset/squad/squad.py'`
  - a dataset identifier on the Hugging Face Hub (list all available datasets and ids with `datasets.list_datasets()`) e.g. `'squad'`, `'glue'` or `'openai/webtext'`
- local_path (`str`) — path to the local folder to copy the datset script to.
- download_config (Optional `datasets.DownloadConfig`) — specific download configuration parameters.
- **download_kwargs (additional keyword arguments) — optional attributes for DownloadConfig() which will override the attributes in download_config if supplied.

Allow inspection/modification of a metric script by copying it on local drive at local_path.

Deprecated in 2.5.0

Use evaluate.inspect_evaluation_module instead, from the new library 🤗 Evaluate instead: https://huggingface.co/docs/evaluate

##
From files

Configurations used to load data files. They are used when loading local files or a dataset repository:

- local files: `load_dataset("parquet", data_dir="path/to/data/dir")`
- dataset repository: `load_dataset("allenai/c4")`

You can pass arguments to `load_dataset` to configure data loading. For example you can specify the `sep` parameter to define the CsvConfig that is used to load the data:

    load_dataset("csv", data_dir="path/to/data/dir", sep="\t")

###
Text

###
class datasets.packaged_modules.text.TextConfig

< source >

( name: str = 'default' version: Union = 0.0.0 data_dir: Optional = None data_files: Union = None description: Optional = None features: Optional = None encoding: str = 'utf-8' errors: dataclasses.InitVar[typing.Optional[str]] = 'deprecated' encoding_errors: Optional = None chunksize: int = 10485760 keep_linebreaks: bool = False sample_by: str = 'line' )

BuilderConfig for text files.

###
class datasets.packaged_modules.text.Text

< source >

( cache_dir: Optional = None dataset_name: Optional = None config_name: Optional = None hash: Optional = None base_path: Optional = None info: Optional = None features: Optional = None token: Union = None use_auth_token = 'deprecated' repo_id: Optional = None data_files: Union = None data_dir: Optional = None storage_options: Optional = None writer_batch_size: Optional = None name = 'deprecated' **config_kwargs )

###
CSV

###
class datasets.packaged_modules.csv.CsvConfig

< source >

( name: str = 'default' version: Union = 0.0.0 data_dir: Optional = None data_files: Union = None description: Optional = None sep: str = ',' delimiter: Optional = None header: Union = 'infer' names: Optional = None column_names: Optional = None index_col: Union = None usecols: Union = None prefix: Optional = None mangle_dupe_cols: bool = True engine: Optional = None converters: Dict = None true_values: Optional = None false_values: Optional = None skipinitialspace: bool = False skiprows: Union = None nrows: Optional = None na_values: Union = None keep_default_na: bool = True na_filter: bool = True verbose: bool = False skip_blank_lines: bool = True thousands: Optional = None decimal: str = '.' lineterminator: Optional = None quotechar: str = '"' quoting: int = 0 escapechar: Optional = None comment: Optional = None encoding: Optional = None dialect: Optional = None error_bad_lines: bool = True warn_bad_lines: bool = True skipfooter: int = 0 doublequote: bool = True memory_map: bool = False float_precision: Optional = None chunksize: int = 10000 features: Optional = None encoding_errors: Optional = 'strict' on_bad_lines: Literal = 'error' date_format: Optional = None )

BuilderConfig for CSV.

###
class datasets.packaged_modules.csv.Csv

< source >

( cache_dir: Optional = None dataset_name: Optional = None config_name: Optional = None hash: Optional = None base_path: Optional = None info: Optional = None features: Optional = None token: Union = None use_auth_token = 'deprecated' repo_id: Optional = None data_files: Union = None data_dir: Optional = None storage_options: Optional = None writer_batch_size: Optional = None name = 'deprecated' **config_kwargs )

###
JSON

###
class datasets.packaged_modules.json.JsonConfig

< source >

( name: str = 'default' version: Union = 0.0.0 data_dir: Optional = None data_files: Union = None description: Optional = None features: Optional = None encoding: str = 'utf-8' encoding_errors: Optional = None field: Optional = None use_threads: bool = True block_size: Optional = None chunksize: int = 10485760 newlines_in_values: Optional = None )

BuilderConfig for JSON.

###
class datasets.packaged_modules.json.Json

< source >

( cache_dir: Optional = None dataset_name: Optional = None config_name: Optional = None hash: Optional = None base_path: Optional = None info: Optional = None features: Optional = None token: Union = None use_auth_token = 'deprecated' repo_id: Optional = None data_files: Union = None data_dir: Optional = None storage_options: Optional = None writer_batch_size: Optional = None name = 'deprecated' **config_kwargs )

###
Parquet

###
class datasets.packaged_modules.parquet.ParquetConfig

< source >

( name: str = 'default' version: Union = 0.0.0 data_dir: Optional = None data_files: Union = None description: Optional = None batch_size: Optional = None columns: Optional = None features: Optional = None )

BuilderConfig for Parquet.

###
class datasets.packaged_modules.parquet.Parquet

< source >

( cache_dir: Optional = None dataset_name: Optional = None config_name: Optional = None hash: Optional = None base_path: Optional = None info: Optional = None features: Optional = None token: Union = None use_auth_token = 'deprecated' repo_id: Optional = None data_files: Union = None data_dir: Optional = None storage_options: Optional = None writer_batch_size: Optional = None name = 'deprecated' **config_kwargs )

###
Arrow

###
class datasets.packaged_modules.arrow.ArrowConfig

< source >

( name: str = 'default' version: Union = 0.0.0 data_dir: Optional = None data_files: Union = None description: Optional = None features: Optional = None )

BuilderConfig for Arrow.

###
class datasets.packaged_modules.arrow.Arrow

< source >

( cache_dir: Optional = None dataset_name: Optional = None config_name: Optional = None hash: Optional = None base_path: Optional = None info: Optional = None features: Optional = None token: Union = None use_auth_token = 'deprecated' repo_id: Optional = None data_files: Union = None data_dir: Optional = None storage_options: Optional = None writer_batch_size: Optional = None name = 'deprecated' **config_kwargs )

###
SQL

###
class datasets.packaged_modules.sql.SqlConfig

< source >

( name: str = 'default' version: Union = 0.0.0 data_dir: Optional = None data_files: Union = None description: Optional = None sql: Union = None con: Union = None index_col: Union = None coerce_float: bool = True params: Union = None parse_dates: Union = None columns: Optional = None chunksize: Optional = 10000 features: Optional = None )

BuilderConfig for SQL.

###
class datasets.packaged_modules.sql.Sql

< source >

( cache_dir: Optional = None dataset_name: Optional = None config_name: Optional = None hash: Optional = None base_path: Optional = None info: Optional = None features: Optional = None token: Union = None use_auth_token = 'deprecated' repo_id: Optional = None data_files: Union = None data_dir: Optional = None storage_options: Optional = None writer_batch_size: Optional = None name = 'deprecated' **config_kwargs )

###
Images

###
class datasets.packaged_modules.imagefolder.ImageFolderConfig

< source >

( name: str = 'default' version: Union = 0.0.0 data_dir: Optional = None data_files: Union = None description: Optional = None features: Optional = None drop_labels: bool = None drop_metadata: bool = None )

BuilderConfig for ImageFolder.

###
class datasets.packaged_modules.imagefolder.ImageFolder

< source >

( cache_dir: Optional = None dataset_name: Optional = None config_name: Optional = None hash: Optional = None base_path: Optional = None info: Optional = None features: Optional = None token: Union = None use_auth_token = 'deprecated' repo_id: Optional = None data_files: Union = None data_dir: Optional = None storage_options: Optional = None writer_batch_size: Optional = None name = 'deprecated' **config_kwargs )

###
Audio

###
class datasets.packaged_modules.audiofolder.AudioFolderConfig

< source >

( name: str = 'default' version: Union = 0.0.0 data_dir: Optional = None data_files: Union = None description: Optional = None features: Optional = None drop_labels: bool = None drop_metadata: bool = None )

Builder Config for AudioFolder.

###
class datasets.packaged_modules.audiofolder.AudioFolder

< source >

( cache_dir: Optional = None dataset_name: Optional = None config_name: Optional = None hash: Optional = None base_path: Optional = None info: Optional = None features: Optional = None token: Union = None use_auth_token = 'deprecated' repo_id: Optional = None data_files: Union = None data_dir: Optional = None storage_options: Optional = None writer_batch_size: Optional = None name = 'deprecated' **config_kwargs )

###
WebDataset

###
class datasets.packaged_modules.webdataset.WebDataset

< source >

( cache_dir: Optional = None dataset_name: Optional = None config_name: Optional = None hash: Optional = None base_path: Optional = None info: Optional = None features: Optional = None token: Union = None use_auth_token = 'deprecated' repo_id: Optional = None data_files: Union = None data_dir: Optional = None storage_options: Optional = None writer_batch_size: Optional = None name = 'deprecated' **config_kwargs )