Skip to content

Conversation

SkafteNicki
Copy link
Collaborator

@SkafteNicki SkafteNicki commented Jul 28, 2025

What does this PR do?

Fixes #20648
Clarify that if the user enables sync_dist=True in self.log then the values are averaged by default (instead of saying it is "reduced"). However, when I checked all the strategies, XLA by default does not average instead it takes the sum. For consistency, I propose that we change the default to be average also for this strategy.

The PR therefore introduce a breaking change in that default averaging for XLA is changed from sum to mean.

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

📚 Documentation preview 📚: https://pytorch-lightning--21012.org.readthedocs.build/en/21012/

@github-actions github-actions bot added docs Documentation related pl Generic label for PyTorch Lightning package labels Jul 28, 2025
@deependujha deependujha merged commit fb2e8d3 into Lightning-AI:master Aug 4, 2025
84 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related pl Generic label for PyTorch Lightning package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Logging sync_dist Documentation Clarification

4 participants