Skip to content

bugfix: add support for global_ordinal, local_ordinal, world_size in xla #20872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

bugfix: add support for global_ordinal, local_ordinal, world_size in xla #20872

wants to merge 14 commits into from

Conversation

AlexandrByzov
Copy link

@AlexandrByzov AlexandrByzov commented Jun 3, 2025 •
edited by github-actions bot
Loading

What does this PR do?

PyTorch XLA has deprecated several methods in PyTorch 2.7:

  • Remove torch_xla.core.xla_model.xrt_world_size, replace with torch_xla.runtime.world_size
  • Remove torch_xla.core.xla_model.get_ordinal, replace with torch_xla.runtime.global_ordinal

See here

Fixes #20852

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs): No
  • 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): Tests were already written
  • 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--20872.org.readthedocs.build/en/20872/

@github-actions github-actions bot added the fabric lightning.fabric.Fabric label Jun 3, 2025
@codecov Codecov
Copy link

codecov bot commented Jun 3, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87%. Comparing base (ce038e8) to head (81ac311).

Additional details and impacted files 
@@            Coverage Diff            @@
##           master   #20872     +/-   ##
=========================================
+ Coverage      49%      87%    +38%     
=========================================
  Files         265      268      +3     
  Lines       23255    23320     +65     
=========================================
+ Hits        11317    20318   +9001     
+ Misses      11938     3002   -8936

@Borda Borda changed the title bugfix: add support for global_ordinal, local_ordinal, world_size in xla bugfix: add support for global_ordinal, local_ordinal, world_size in xla Jun 6, 2025
Borda
Borda reviewed Jun 6, 2025
View reviewed changes
Copy link
Member

@Borda Borda left a comment

Choose a reason for hiding this comment

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

thank you for this finding!
could you pls add test to cover this new behaviour?
can this XLA be also run without TPU?

@Borda Borda added the bug Something isn't working label Jun 6, 2025
This was referenced Jun 13, 2025
Open
Open
@AlexandrByzov
Copy link
Author

thank you for this finding! could you pls add test to cover this new behaviour? can this XLA be also run without TPU?

Thank you for taking the time to review. I implemented a test with mocks, because as far as I understand torch_xla is not used in tests without TPU. Generally, it is very much possible to use XLA with CPU or even GPU, but this will require a large change in tests and probably a separate issue/s

bhimrazy
bhimrazy reviewed Jun 20, 2025
View reviewed changes
bhimrazy
bhimrazy reviewed Jun 20, 2025
View reviewed changes
bhimrazy
bhimrazy reviewed Jun 20, 2025
View reviewed changes
@AlexandrByzov AlexandrByzov requested a review from Borda June 29, 2025 20:20
@stale Stale
Copy link

stale bot commented Jul 19, 2025

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you need further help see our docs: https://lightning.ai/docs/pytorch/latest/generated/CONTRIBUTING.html#pull-request or ask the assistance of a core contributor here or on Discord. Thank you for your contributions.

@stale stale bot added the won't fix This will not be worked on label Jul 19, 2025
@AlexandrByzov
Copy link
Author

AlexandrByzov commented Jul 19, 2025 •
edited
Loading

Is there anything else that can be done for this MR @Borda ? I will be glad to work on it further

@stale stale bot removed the won't fix This will not be worked on label Aug 4, 2025
Borda
Borda reviewed Aug 5, 2025
View reviewed changes
tests/tests_fabric/plugins/environments/test_xla.py
Comment on lines +102 to +127
@mock.patch.dict(os.environ, {}, clear=True)
@mock.patch("lightning.fabric.accelerators.xla._XLA_GREATER_EQUAL_2_1", True)
@mock.patch("lightning.fabric.plugins.environments.xla._XLA_GREATER_EQUAL_2_1", True)
def test_attributes_from_xla_greater_21_used(xla_available, monkeypatch):
"""Test XLA environment attributes when using XLA runtime >= 2.1."""

env = XLAEnvironment()

with (
mock.patch("torch_xla.runtime.world_size", return_value=4),
mock.patch("torch_xla.runtime.global_ordinal", return_value=2),
mock.patch("torch_xla.runtime.local_ordinal", return_value=1),
):
env.world_size.cache_clear()
env.global_rank.cache_clear()
env.local_rank.cache_clear()

assert env.world_size() == 4
assert env.global_rank() == 2
assert env.local_rank() == 1

env.set_world_size(100)
assert env.world_size() == 4

env.set_global_rank(100)
assert env.global_rank() == 2
Copy link
Member

Choose a reason for hiding this comment

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

can we pls split it into smaller tests

Copy link
Collaborator

Choose a reason for hiding this comment

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

cc: @AlexandrByzov

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Borda Borda Borda left review comments

@bhimrazy bhimrazy bhimrazy approved these changes

@deependujha deependujha deependujha approved these changes

@lantiga lantiga Awaiting requested review from lantiga lantiga is a code owner

@tchaton tchaton Awaiting requested review from tchaton tchaton is a code owner

@justusschock justusschock Awaiting requested review from justusschock justusschock is a code owner

@ethanwharris ethanwharris Awaiting requested review from ethanwharris ethanwharris is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
bug Something isn't working fabric lightning.fabric.Fabric
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support PyTorch/XLA 2.7
4 participants
@AlexandrByzov @Borda @bhimrazy @deependujha