Accelerate documentation
Logging
Logging
Refer to the Troubleshooting guide or to the example below to learn how to use Accelerate’s logger.
Returns a logging.Logger for name that can handle multiprocessing.
If a log should be called on all processes, pass main_process_only=False If a log should be called on all
processes and in order, also pass in_order=True
Example:
>>> from accelerate.logging import get_logger
>>> from accelerate import Accelerator
>>> logger = get_logger(__name__)
>>> accelerator = Accelerator()
>>> logger.info("My log", main_process_only=False)
>>> logger.debug("My log", main_process_only=True)
>>> logger = get_logger(__name__, log_level="DEBUG")
>>> logger.info("My log")
>>> logger.debug("My second log")
>>> array = ["a", "b", "c", "d"]
>>> letter_at_rank = array[accelerator.process_index]
>>> logger.info(letter_at_rank, in_order=True)Library verbosity
Use logging.set_verbosity() to set the default level for Accelerate’s internal loggers:
from accelerate.logging import set_verbosity
set_verbosity("warning")Per-logger levels set through log_level or ACCELERATE_LOG_LEVEL take precedence.
Return the effective logging level of the Accelerate library logger as an integer.
accelerate.logging.set_verbosity
< source >( verbosity: int | str )
Set the logging level of the Accelerate library logger.
This affects existing and future loggers in the accelerate namespace that inherit their level. Loggers with a
level set explicitly, including through get_logger’s log_level argument or ACCELERATE_LOG_LEVEL, retain that
level. The Python root logger and loggers outside the accelerate namespace are not modified.
Set the Accelerate library’s verbosity to DEBUG.
Set the Accelerate library’s verbosity to INFO.
Set the Accelerate library’s verbosity to WARNING.
Set the Accelerate library’s verbosity to ERROR.