Logging
🤗 Transformers has a centralized logging system, so that you can setup the verbosity of the library easily.
Currently the default verbosity of the library is WARNING
.
To change the level of verbosity, just use one of the direct setters. For instance, here is how to change the verbosity to the INFO level.
import transformers
transformers.logging.set_verbosity_info()
You can also use the environment variable TRANSFORMERS_VERBOSITY
to override the default verbosity. You can set it
to one of the following: debug
, info
, warning
, error
, critical
. For example:
TRANSFORMERS_VERBOSITY=error ./myprogram.py
Additionally, some warnings
can be disabled by setting the environment variable
TRANSFORMERS_NO_ADVISORY_WARNINGS
to a true value, like 1. This will disable any warning that is logged using
logger.warning_advice()
For example:
TRANSFORMERS_NO_ADVISORY_WARNINGS=1 ./myprogram.py
Here is an example of how to use logging
in a module:
from transformers.utils import logging
logging.set_verbosity_info()
logger = logging.get_logger(__name__)
logger.info("INFO")
logger.warning("WARN")
Above, a logger
instance is created from logging.get_logger(__name__)
. If you want to use logging
in a script, you shouldn’t pass __name__
to logging.get_logger
. For example:
from transformers.utils import logging
if __name__ == "__main__":
logging.set_verbosity_info()
# leave it empy or use a string
logger = logging.get_logger()
logger.info("INFO")
logger.warning("WARN")
All the methods of this logging module are documented below, the main ones are logging.get_verbosity() to get the current level of verbosity in the logger and logging.set_verbosity() to set the verbosity to the level of your choice. In order (from the least verbose to the most verbose), those levels (with their corresponding int values in parenthesis) are:
transformers.logging.CRITICAL
ortransformers.logging.FATAL
(int value, 50): only report the most critical errors.transformers.logging.ERROR
(int value, 40): only report errors.transformers.logging.WARNING
ortransformers.logging.WARN
(int value, 30): only reports error and warnings. This the default level used by the library.transformers.logging.INFO
(int value, 20): reports error, warnings and basic information.transformers.logging.DEBUG
(int value, 10): report all information.
By default, tqdm
progress bars will be displayed during model download. logging.disable_progress_bar() and logging.enable_progress_bar() can be used to suppress or unsuppress this behavior.
Base setters
Set the verbosity to the ERROR
level.
Set the verbosity to the WARNING
level.
Set the verbosity to the INFO
level.
Set the verbosity to the DEBUG
level.
Other functions
Return the current level for the 🤗 Transformers’s root logger as an int.
🤗 Transformers has following logging levels:
- 50:
transformers.logging.CRITICAL
ortransformers.logging.FATAL
- 40:
transformers.logging.ERROR
- 30:
transformers.logging.WARNING
ortransformers.logging.WARN
- 20:
transformers.logging.INFO
- 10:
transformers.logging.DEBUG
transformers.utils.logging.set_verbosity
< source >( verbosity: int )
Set the verbosity level for the 🤗 Transformers’s root logger.
Return a logger with the specified name.
This function is not supposed to be directly accessed unless you are writing a custom transformers module.
Enable the default handler of the HuggingFace Transformers’s root logger.
Disable the default handler of the HuggingFace Transformers’s root logger.
Enable explicit formatting for every HuggingFace Transformers’s logger. The explicit formatter is as follows:
[LEVELNAME|FILENAME|LINE NUMBER] TIME >> MESSAGE
All handlers currently bound to the root logger are affected by this method.
Resets the formatting for HuggingFace Transformers’s loggers.
All handlers currently bound to the root logger are affected by this method.
Enable tqdm progress bar.
Enable tqdm progress bar.