Skip to content

Fix logging logic when in_order is set to True#3280

Merged
SunMarc merged 5 commits into
huggingface:mainfrom
yuxinyuan:fix_logging
Mar 2, 2026
Merged

Fix logging logic when in_order is set to True#3280
SunMarc merged 5 commits into
huggingface:mainfrom
yuxinyuan:fix_logging

Conversation

@yuxinyuan
Copy link
Copy Markdown
Contributor

What does this PR do?

This PR fix the logging logic when in_order is set to True. Right now, the in_order flag either hangs the program when main_process_only is also set to True, or does nothing when main_process_only is set to False.

A simple code snippet to test (run with accelerate launch --num_processes=2 test.py):

from accelerate import PartialState
from accelerate.logging import get_logger


s = PartialState()

logger = get_logger("accelerate")
in_order = True
main_process_only = False  # True

logger.info(f"[{s.process_index}] Hello, world!", in_order=in_order, main_process_only=main_process_only)
logger.warning(f"[{s.process_index}] Hello, world!", in_order=in_order, main_process_only=main_process_only)
logger.error(f"[{s.process_index}] Hello, world!", in_order=in_order, main_process_only=main_process_only)

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@BenjaminBossan
Copy link
Copy Markdown
Member

CI is failing because of the str | None type annotation. This syntax has only been added in Python 3.10 but 3.9 is tested. Either you have to use Optional or from __future__ import annotations.

@yuxinyuan
Copy link
Copy Markdown
Contributor Author

@BenjaminBossan
Done.

@SunMarc SunMarc requested a review from muellerzr December 13, 2024 15:01
Copy link
Copy Markdown
Contributor

@muellerzr muellerzr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Overall this looks good to me, however there's logger-related tests which are now failing. Can you modify those tests since our logs differ a bit now?

@yuxinyuan
Copy link
Copy Markdown
Contributor Author

@muellerzr I've tried to fix the tests. Would you please take a look. Thanks!

@github-actions
Copy link
Copy Markdown
Contributor

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

@SunMarc SunMarc self-requested a review March 2, 2026 15:11
Copy link
Copy Markdown
Member

@SunMarc SunMarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks ! Sorry that this didn't get merged in time

@SunMarc
Copy link
Copy Markdown
Member

SunMarc commented Mar 2, 2026

@bot /style

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 2, 2026

Style bot fixed some files and pushed the changes.

@SunMarc SunMarc merged commit 23f2ab3 into huggingface:main Mar 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants