"vscode:/vscode.git/clone" did not exist on "b0505eb7ab8af1986dabd97c23fae83a0539303d"
logging.rst 2.5 KB
Newer Older
Sylvain Gugger's avatar
Sylvain Gugger committed
1
Logging
Sylvain Gugger's avatar
Sylvain Gugger committed
2
-----------------------------------------------------------------------------------------------------------------------
Sylvain Gugger's avatar
Sylvain Gugger committed
3

4
5
6
7
馃 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``.

Sylvain Gugger's avatar
Sylvain Gugger committed
8
9
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.
Sylvain Gugger's avatar
Sylvain Gugger committed
10
11
12
13
14
15

.. code-block:: python

    import transformers
    transformers.logging.set_verbosity_info()

Sylvain Gugger's avatar
Sylvain Gugger committed
16
17
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:
18
19

.. code-block:: bash
Sylvain Gugger's avatar
Sylvain Gugger committed
20

21
22
    TRANSFORMERS_VERBOSITY=error ./myprogram.py

Sylvain Gugger's avatar
Sylvain Gugger committed
23
24
25
26
27
28
29
30
31
32
33
34
35
36
All the methods of this logging module are documented below, the main ones are
:func:`transformers.logging.get_verbosity` to get the current level of verbosity in the logger and
:func:`transformers.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:

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

Base setters
Sylvain Gugger's avatar
Sylvain Gugger committed
37
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sylvain Gugger's avatar
Sylvain Gugger committed
38
39
40
41
42
43
44
45
46
47

.. autofunction:: transformers.logging.set_verbosity_error

.. autofunction:: transformers.logging.set_verbosity_warning

.. autofunction:: transformers.logging.set_verbosity_info

.. autofunction:: transformers.logging.set_verbosity_debug

Other functions
Sylvain Gugger's avatar
Sylvain Gugger committed
48
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sylvain Gugger's avatar
Sylvain Gugger committed
49
50
51
52
53
54

.. autofunction:: transformers.logging.get_verbosity

.. autofunction:: transformers.logging.set_verbosity

.. autofunction:: transformers.logging.get_logger
Lysandre Debut's avatar
Lysandre Debut committed
55
56
57

.. autofunction:: transformers.logging.enable_explicit_format

Sylvain Gugger's avatar
Sylvain Gugger committed
58
.. autofunction:: transformers.logging.reset_format