Unverified Commit 053a80c6 authored by Sander Land's avatar Sander Land Committed by GitHub
Browse files

logging documentation update (#17174)



* logging documentation

* style
Co-authored-by: default avatarSander Land <sander@chatdesk.com>
parent 8600d770
...@@ -40,29 +40,17 @@ Additionally, some `warnings` can be disabled by setting the environment variabl ...@@ -40,29 +40,17 @@ Additionally, some `warnings` can be disabled by setting the environment variabl
TRANSFORMERS_NO_ADVISORY_WARNINGS=1 ./myprogram.py TRANSFORMERS_NO_ADVISORY_WARNINGS=1 ./myprogram.py
``` ```
Here is an example of how to use `logging` in a module: Here is an example of how to use the same logger as the library in your own module or script:
```python ```python
from transformers.utils import logging from transformers.utils import logging
logging.set_verbosity_info() logging.set_verbosity_info()
logger = logging.get_logger(__name__) logger = logging.get_logger("transformers")
logger.info("INFO") logger.info("INFO")
logger.warning("WARN") 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 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.get_verbosity`] to get the current level of verbosity in the logger and
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment