From b87c044c79a408c0a1e7f7b046b5b4ce999c2d0e Mon Sep 17 00:00:00 2001 From: Francesco Saverio Zuppichini Date: Wed, 16 Feb 2022 10:15:13 +0100 Subject: [PATCH] Usage examples for logger (#15657) * logger * Update docs/source/main_classes/logging.mdx Co-authored-by: Stas Bekman * Update docs/source/main_classes/logging.mdx Co-authored-by: Stas Bekman Co-authored-by: Stas Bekman --- docs/source/main_classes/logging.mdx | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/docs/source/main_classes/logging.mdx b/docs/source/main_classes/logging.mdx index ac0717443da..3137be805ca 100644 --- a/docs/source/main_classes/logging.mdx +++ b/docs/source/main_classes/logging.mdx @@ -36,11 +36,34 @@ Additionally, some `warnings` can be disabled by setting the environment variabl `TRANSFORMERS_NO_ADVISORY_WARNINGS` to a true value, like *1*. This will disable any warning that is logged using [`logger.warning_advice`]. For example: - ```bash TRANSFORMERS_NO_ADVISORY_WARNINGS=1 ./myprogram.py ``` +Here is an example of how to use `logging` in a module: + +```python +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: + +```python +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 @@ -54,7 +77,7 @@ verbose to the most verbose), those levels (with their corresponding int values - `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. +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