Accelerate documentation

Logging with Accelerate

You are viewing v0.27.2 version. A newer version v0.30.1 is available.
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Logging with Accelerate

Refer to the Troubleshooting guide or to the example below to learn how to use 🤗 Accelerate’s logger.


< >

( name: str log_level: str = None )


  • name (str) — The name for the logger, such as __file__
  • log_level (str, optional) — The log level to use. If not passed, will default to the LOG_LEVEL environment variable, or INFO if not

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


>>> from accelerate.logging import get_logger
>>> from accelerate import Accelerator

>>> logger = get_logger(__name__)

>>> accelerator = Accelerator()
>>>"My log", main_process_only=False)
>>> logger.debug("My log", main_process_only=True)

>>> logger = get_logger(__name__, log_level="DEBUG")
>>>"My log")
>>> logger.debug("My second log")

>>> array = ["a", "b", "c", "d"]
>>> letter_at_rank = array[accelerator.process_index]
>>>, in_order=True)