Skip to content

Rename sharding_names to out_sharding in NNX Variable metadata#5215

Open
copybara-service[bot] wants to merge 1 commit intomainfrom
test_859745972
Open

Rename sharding_names to out_sharding in NNX Variable metadata#5215
copybara-service[bot] wants to merge 1 commit intomainfrom
test_859745972

Conversation

@copybara-service
Copy link

Rename sharding_names to out_sharding in NNX Variable metadata

This CL renames the sharding_names attribute to out_sharding for better
consistency with the sharding API. The new name more clearly indicates
the purpose of this metadata field.

Changes

  • Bump Flax version to 0.12.4
  • Core changes in variablelib.py:
    • Add sharding_names to out_sharding metadata remapping for backward compatibility
    • Add deprecated sharding_names property that returns out_sharding with a warning
  • Update nnx/spmd.py, core/spmd.py, core/meta.py, linen/spmd.py to use out_sharding
  • Update all NNX tests to use the new attribute name
  • Update qwix flax_util.py to check for out_sharding first, with fallback to sharding_names
  • Update maxtext initializers.py to check for out_sharding first
  • Update documentation and examples to use out_sharding

Backward Compatibility

Existing code using sharding_names will continue to work via:

  • Metadata remapping during Variable creation
  • Deprecated Variable.sharding_names property

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@copybara-service copybara-service bot force-pushed the test_859745972 branch 2 times, most recently from ab7fc84 to 0cb4f03 Compare February 4, 2026 17:14
This CL renames the sharding_names attribute to out_sharding for better
consistency with the sharding API. The new name more clearly indicates
the purpose of this metadata field.
## Changes
- Bump Flax version to 0.12.4
- Core changes in variablelib.py:
  - Add sharding_names to out_sharding metadata remapping for backward compatibility
  - Add deprecated sharding_names property that returns out_sharding with a warning
- Update nnx/spmd.py, core/spmd.py, core/meta.py, linen/spmd.py to use out_sharding
- Update all NNX tests to use the new attribute name
- Update qwix flax_util.py to check for out_sharding first, with fallback to sharding_names
- Update maxtext initializers.py to check for out_sharding first
- Update documentation and examples to use out_sharding
## Backward Compatibility
Existing code using sharding_names will continue to work via:
- Metadata remapping during Variable creation
- Deprecated Variable.sharding_names property

PiperOrigin-RevId: 859745972
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.

0 participants