From 0bfc28b78b09d4256cbb2d39c0089a0991370ca6 Mon Sep 17 00:00:00 2001 From: MKhalusova Date: Tue, 7 Nov 2023 13:12:51 -0500 Subject: [PATCH] logging moved to the troubleshooting guide --- docs/source/package_reference/logging.md | 20 ++------------------ docs/source/usage_guides/troubleshooting.md | 4 ++-- 2 files changed, 4 insertions(+), 20 deletions(-) diff --git a/docs/source/package_reference/logging.md b/docs/source/package_reference/logging.md index 5cea06f2558..588913016e1 100644 --- a/docs/source/package_reference/logging.md +++ b/docs/source/package_reference/logging.md @@ -15,23 +15,7 @@ rendered properly in your Markdown viewer. # Logging with Accelerate -Accelerate has its own logging utility to handle logging while in a distributed system. -To utilize this replace cases of `logging` with `accelerate.logging`: -```diff -- import logging -+ from accelerate.logging import get_logger -- logger = logging.getLogger(__name__) -+ logger = get_logger(__name__) -``` - -## Setting the log level - -The log level can be set with the `ACCELERATE_LOG_LEVEL` environment variable or by passing -`log_level` to `get_logger`: -```python -from accelerate.logging import get_logger - -logger = get_logger(__name__, log_level="INFO") -``` +Refer to the [Troubleshooting guide](../usage_guides/troubleshooting#logging) or to the example below to learn +how to use 🤗 Accelerate's logger. [[autodoc]] logging.get_logger \ No newline at end of file diff --git a/docs/source/usage_guides/troubleshooting.md b/docs/source/usage_guides/troubleshooting.md index 05a1f1817e4..29b29779f1e 100644 --- a/docs/source/usage_guides/troubleshooting.md +++ b/docs/source/usage_guides/troubleshooting.md @@ -15,8 +15,8 @@ rendered properly in your Markdown viewer. # Troubleshooting guide -This guide aims to provide you with the tools and knowledge required to navigate some common issues. However, -as 🤗 Accelerate continuously evolves and the use cases are diverse, you might encounter an issue not covered in this +This guide aims to provide you the tools and knowledge required to navigate some common issues. However, +as 🤗 Accelerate continuously evolves and the use cases and setups are diverse, you might encounter an issue not covered in this guide. If the suggestions listed in this guide do not cover your such situation, please refer to the final section of the guide, [Asking for Help](#ask-for-help), to learn where to find help with your specific issue.