Datasets documentation

Utilities

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v2.17.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Utilities

Configure logging

🤗 Datasets strives to be transparent and explicit about how it works, but this can be quite verbose at times. We have included a series of logging methods which allow you to easily adjust the level of verbosity of the entire library. Currently the default verbosity of the library is set to WARNING.

To change the level of verbosity, use one of the direct setters. For instance, here is how to change the verbosity to the INFO level:

import datasets
datasets.logging.set_verbosity_info()

You can also use the environment variable DATASETS_VERBOSITY to override the default verbosity, and set it to one of the following: debug, info, warning, error, critical:

DATASETS_VERBOSITY=error ./myprogram.py

All the methods of this logging module are documented below. The main ones are:

In order from the least to the most verbose (with their corresponding int values):

  1. logging.CRITICAL or logging.FATAL (int value, 50): only report the most critical errors.
  2. logging.ERROR (int value, 40): only report errors.
  3. logging.WARNING or logging.WARN (int value, 30): only reports error and warnings. This the default level used by the library.
  4. logging.INFO (int value, 20): reports error, warnings and basic information.
  5. logging.DEBUG (int value, 10): report all information.

datasets.utils.logging.get_verbosity

< >

( )

Return the current level for the HuggingFace datasets library’s root logger.

HuggingFace datasets library has following logging levels:

  • datasets.logging.CRITICAL, datasets.logging.FATAL
  • datasets.logging.ERROR
  • datasets.logging.WARNING, datasets.logging.WARN
  • datasets.logging.INFO
  • datasets.logging.DEBUG

datasets.utils.logging.set_verbosity

< >

( verbosity: int )

Set the level for the Hugging Face Datasets library’s root logger.

datasets.utils.logging.set_verbosity_info

< >

( )

Set the level for the Hugging Face datasets library’s root logger to INFO.

This will display most of the logging information and tqdm bars.

Shortcut to datasets.logging.set_verbosity(datasets.logging.INFO).

datasets.utils.logging.set_verbosity_warning

< >

( )

Set the level for the Hugging Face datasets library’s root logger to WARNING.

This will display only the warning and errors logging information and tqdm bars.

Shortcut to datasets.logging.set_verbosity(datasets.logging.WARNING).

datasets.utils.logging.set_verbosity_debug

< >

( )

Set the level for the Hugging Face datasets library’s root logger to DEBUG.

This will display all the logging information and tqdm bars.

Shortcut to datasets.logging.set_verbosity(datasets.logging.DEBUG).

datasets.utils.logging.set_verbosity_error

< >

( )

Set the level for the Hugging Face datasets library’s root logger to ERROR.

This will display only the errors logging information and tqdm bars.

Shortcut to datasets.logging.set_verbosity(datasets.logging.ERROR).

datasets.utils.logging.disable_propagation

< >

( )

Disable propagation of the library log outputs. Note that log propagation is disabled by default.

datasets.utils.logging.enable_propagation

< >

( )

Enable propagation of the library log outputs. Please disable the Hugging Face datasets library’s default handler to prevent double logging if the root logger has been configured.

Configure progress bars

By default, tqdm progress bars will be displayed during dataset download and preprocessing. You can disable them globally by setting HF_DATASETS_DISABLE_PROGRESS_BARS environment variable. You can also enable/disable them using enable_progress_bars() and disable_progress_bars(). If set, the environment variable has priority on the helpers.

datasets.enable_progress_bars

< >

( )

Enable globally progress bars used in datasets except if HF_DATASETS_DISABLE_PROGRESS_BAR environment variable has been set.

Use disable_progress_bars() to disable them.

datasets.disable_progress_bars

< >

( )

Disable globally progress bars used in datasets except if HF_DATASETS_DISABLE_PROGRESS_BAR environment variable has been set.

Use enable_progress_bars() to re-enable them.

datasets.are_progress_bars_disabled

< >

( )

Return whether progress bars are globally disabled or not.

Progress bars used in datasets can be enable or disabled globally using enable_progress_bars() and disable_progress_bars() or by setting HF_DATASETS_DISABLE_PROGRESS_BAR as environment variable.