Spaces:
Sleeping
Sleeping
# coding=utf-8 | |
# Copyright 2020 Optuna, Hugging Face | |
# | |
# Licensed under the Apache License, Version 2.0 (the "License"); | |
# you may not use this file except in compliance with the License. | |
# You may obtain a copy of the License at | |
# | |
# http://www.apache.org/licenses/LICENSE-2.0 | |
# | |
# Unless required by applicable law or agreed to in writing, software | |
# distributed under the License is distributed on an "AS IS" BASIS, | |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
# See the License for the specific language governing permissions and | |
# limitations under the License. | |
""" Logging utilities.""" | |
import functools | |
import logging | |
import os | |
import sys | |
import threading | |
from logging import ( | |
CRITICAL, # NOQA | |
DEBUG, # NOQA | |
ERROR, # NOQA | |
FATAL, # NOQA | |
INFO, # NOQA | |
NOTSET, # NOQA | |
WARN, # NOQA | |
WARNING, # NOQA | |
) | |
from typing import Optional | |
import huggingface_hub.utils as hf_hub_utils | |
from tqdm import auto as tqdm_lib | |
_lock = threading.Lock() | |
_default_handler: Optional[logging.Handler] = None | |
log_levels = { | |
"detail": logging.DEBUG, # will also print filename and line number | |
"debug": logging.DEBUG, | |
"info": logging.INFO, | |
"warning": logging.WARNING, | |
"error": logging.ERROR, | |
"critical": logging.CRITICAL, | |
} | |
_default_log_level = logging.WARNING | |
_tqdm_active = True | |
def _get_default_logging_level(): | |
""" | |
If TRANSFORMERS_VERBOSITY env var is set to one of the valid choices return that as the new default level. If it is | |
not - fall back to `_default_log_level` | |
""" | |
env_level_str = os.getenv("TRANSFORMERS_VERBOSITY", None) | |
if env_level_str: | |
if env_level_str in log_levels: | |
return log_levels[env_level_str] | |
else: | |
logging.getLogger().warning( | |
f"Unknown option TRANSFORMERS_VERBOSITY={env_level_str}, " | |
f"has to be one of: { ', '.join(log_levels.keys()) }" | |
) | |
return _default_log_level | |
def _get_library_name() -> str: | |
return __name__.split(".")[0] | |
def _get_library_root_logger() -> logging.Logger: | |
return logging.getLogger(_get_library_name()) | |
def _configure_library_root_logger() -> None: | |
global _default_handler | |
with _lock: | |
if _default_handler: | |
# This library has already configured the library root logger. | |
return | |
_default_handler = logging.StreamHandler() # Set sys.stderr as stream. | |
# set defaults based on https://github.com/pyinstaller/pyinstaller/issues/7334#issuecomment-1357447176 | |
if sys.stderr is None: | |
sys.stderr = open(os.devnull, "w") | |
_default_handler.flush = sys.stderr.flush | |
# Apply our default configuration to the library root logger. | |
library_root_logger = _get_library_root_logger() | |
library_root_logger.addHandler(_default_handler) | |
library_root_logger.setLevel(_get_default_logging_level()) | |
# if logging level is debug, we add pathname and lineno to formatter for easy debugging | |
if os.getenv("TRANSFORMERS_VERBOSITY", None) == "detail": | |
formatter = logging.Formatter("[%(levelname)s|%(pathname)s:%(lineno)s] %(asctime)s >> %(message)s") | |
_default_handler.setFormatter(formatter) | |
library_root_logger.propagate = False | |
def _reset_library_root_logger() -> None: | |
global _default_handler | |
with _lock: | |
if not _default_handler: | |
return | |
library_root_logger = _get_library_root_logger() | |
library_root_logger.removeHandler(_default_handler) | |
library_root_logger.setLevel(logging.NOTSET) | |
_default_handler = None | |
def get_log_levels_dict(): | |
return log_levels | |
def get_logger(name: Optional[str] = None) -> logging.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. | |
""" | |
if name is None: | |
name = _get_library_name() | |
_configure_library_root_logger() | |
return logging.getLogger(name) | |
def get_verbosity() -> int: | |
""" | |
Return the current level for the 🤗 Transformers's root logger as an int. | |
Returns: | |
`int`: The logging level. | |
<Tip> | |
🤗 Transformers has following logging levels: | |
- 50: `transformers.logging.CRITICAL` or `transformers.logging.FATAL` | |
- 40: `transformers.logging.ERROR` | |
- 30: `transformers.logging.WARNING` or `transformers.logging.WARN` | |
- 20: `transformers.logging.INFO` | |
- 10: `transformers.logging.DEBUG` | |
</Tip>""" | |
_configure_library_root_logger() | |
return _get_library_root_logger().getEffectiveLevel() | |
def set_verbosity(verbosity: int) -> None: | |
""" | |
Set the verbosity level for the 🤗 Transformers's root logger. | |
Args: | |
verbosity (`int`): | |
Logging level, e.g., one of: | |
- `transformers.logging.CRITICAL` or `transformers.logging.FATAL` | |
- `transformers.logging.ERROR` | |
- `transformers.logging.WARNING` or `transformers.logging.WARN` | |
- `transformers.logging.INFO` | |
- `transformers.logging.DEBUG` | |
""" | |
_configure_library_root_logger() | |
_get_library_root_logger().setLevel(verbosity) | |
def set_verbosity_info(): | |
"""Set the verbosity to the `INFO` level.""" | |
return set_verbosity(INFO) | |
def set_verbosity_warning(): | |
"""Set the verbosity to the `WARNING` level.""" | |
return set_verbosity(WARNING) | |
def set_verbosity_debug(): | |
"""Set the verbosity to the `DEBUG` level.""" | |
return set_verbosity(DEBUG) | |
def set_verbosity_error(): | |
"""Set the verbosity to the `ERROR` level.""" | |
return set_verbosity(ERROR) | |
def disable_default_handler() -> None: | |
"""Disable the default handler of the HuggingFace Transformers's root logger.""" | |
_configure_library_root_logger() | |
assert _default_handler is not None | |
_get_library_root_logger().removeHandler(_default_handler) | |
def enable_default_handler() -> None: | |
"""Enable the default handler of the HuggingFace Transformers's root logger.""" | |
_configure_library_root_logger() | |
assert _default_handler is not None | |
_get_library_root_logger().addHandler(_default_handler) | |
def add_handler(handler: logging.Handler) -> None: | |
"""adds a handler to the HuggingFace Transformers's root logger.""" | |
_configure_library_root_logger() | |
assert handler is not None | |
_get_library_root_logger().addHandler(handler) | |
def remove_handler(handler: logging.Handler) -> None: | |
"""removes given handler from the HuggingFace Transformers's root logger.""" | |
_configure_library_root_logger() | |
assert handler is not None and handler not in _get_library_root_logger().handlers | |
_get_library_root_logger().removeHandler(handler) | |
def disable_propagation() -> None: | |
""" | |
Disable propagation of the library log outputs. Note that log propagation is disabled by default. | |
""" | |
_configure_library_root_logger() | |
_get_library_root_logger().propagate = False | |
def enable_propagation() -> None: | |
""" | |
Enable propagation of the library log outputs. Please disable the HuggingFace Transformers's default handler to | |
prevent double logging if the root logger has been configured. | |
""" | |
_configure_library_root_logger() | |
_get_library_root_logger().propagate = True | |
def enable_explicit_format() -> None: | |
""" | |
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. | |
""" | |
handlers = _get_library_root_logger().handlers | |
for handler in handlers: | |
formatter = logging.Formatter("[%(levelname)s|%(filename)s:%(lineno)s] %(asctime)s >> %(message)s") | |
handler.setFormatter(formatter) | |
def reset_format() -> None: | |
""" | |
Resets the formatting for HuggingFace Transformers's loggers. | |
All handlers currently bound to the root logger are affected by this method. | |
""" | |
handlers = _get_library_root_logger().handlers | |
for handler in handlers: | |
handler.setFormatter(None) | |
def warning_advice(self, *args, **kwargs): | |
""" | |
This method is identical to `logger.warning()`, but if env var TRANSFORMERS_NO_ADVISORY_WARNINGS=1 is set, this | |
warning will not be printed | |
""" | |
no_advisory_warnings = os.getenv("TRANSFORMERS_NO_ADVISORY_WARNINGS", False) | |
if no_advisory_warnings: | |
return | |
self.warning(*args, **kwargs) | |
logging.Logger.warning_advice = warning_advice | |
def warning_once(self, *args, **kwargs): | |
""" | |
This method is identical to `logger.warning()`, but will emit the warning with the same message only once | |
Note: The cache is for the function arguments, so 2 different callers using the same arguments will hit the cache. | |
The assumption here is that all warning messages are unique across the code. If they aren't then need to switch to | |
another type of cache that includes the caller frame information in the hashing function. | |
""" | |
self.warning(*args, **kwargs) | |
logging.Logger.warning_once = warning_once | |
class EmptyTqdm: | |
"""Dummy tqdm which doesn't do anything.""" | |
def __init__(self, *args, **kwargs): # pylint: disable=unused-argument | |
self._iterator = args[0] if args else None | |
def __iter__(self): | |
return iter(self._iterator) | |
def __getattr__(self, _): | |
"""Return empty function.""" | |
def empty_fn(*args, **kwargs): # pylint: disable=unused-argument | |
return | |
return empty_fn | |
def __enter__(self): | |
return self | |
def __exit__(self, type_, value, traceback): | |
return | |
class _tqdm_cls: | |
def __call__(self, *args, **kwargs): | |
if _tqdm_active: | |
return tqdm_lib.tqdm(*args, **kwargs) | |
else: | |
return EmptyTqdm(*args, **kwargs) | |
def set_lock(self, *args, **kwargs): | |
self._lock = None | |
if _tqdm_active: | |
return tqdm_lib.tqdm.set_lock(*args, **kwargs) | |
def get_lock(self): | |
if _tqdm_active: | |
return tqdm_lib.tqdm.get_lock() | |
tqdm = _tqdm_cls() | |
def is_progress_bar_enabled() -> bool: | |
"""Return a boolean indicating whether tqdm progress bars are enabled.""" | |
global _tqdm_active | |
return bool(_tqdm_active) | |
def enable_progress_bar(): | |
"""Enable tqdm progress bar.""" | |
global _tqdm_active | |
_tqdm_active = True | |
hf_hub_utils.enable_progress_bars() | |
def disable_progress_bar(): | |
"""Disable tqdm progress bar.""" | |
global _tqdm_active | |
_tqdm_active = False | |
hf_hub_utils.disable_progress_bars() | |