Skip to content

Conversation

buildwithsuhana
Copy link
Contributor

@buildwithsuhana buildwithsuhana commented Oct 2, 2025

This PR introduces support for tensor parallelism autosharding in Keras, enabling users to shard large model layers across multiple devices. This is a crucial feature for training models that are too large to fit into the memory of a single accelerator.

The implementation is centered around two new components:

autoconfig.py: This module contains the logic to analyze a Keras model, identify sharding candidates (e.g., Dense, EinsumDense layers), and generate a sharding plan.

coordinated_optimizer.py: This is an optimizer wrapper that consumes the sharding plan. During training, it intercepts gradients for sharded variables and performs a collective AllReduce to ensure weight updates are correctly synchronized across all devices.

Example usage: https://colab.research.google.com/drive/1UAINIcstDuO0aeA9lxCF5LaIj5ne5X5z?resourcekey=0-pPF4COO19KRoqS5cpWNILA&usp=sharing

This is the 2nd (out of 4) PR for AutoSharding Keras.

Copy link
Contributor

Summary of Changes

Hello @buildwithsuhana, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances Keras's capabilities for large-scale model training by introducing foundational support for tensor parallelism autosharding. It provides mechanisms to automatically determine how model layers should be split across multiple devices and a specialized optimizer to manage the distributed training process, including sharding optimizer states and synchronizing gradients. This enables users to train models that exceed the memory capacity of a single accelerator, making distributed training more accessible and efficient within the Keras ecosystem.

Highlights

  • Automatic Sharding Configuration: Introduced "autoconfig.py" to intelligently analyze Keras models (e.g., Dense, EinsumDense, Embedding layers) and generate a tensor parallelism sharding plan, classifying Dense layers as "up-projection" or "down-projection" for optimal splitting.
  • Coordinated Optimizer for Distributed Training: Added "coordinated_optimizer.py" which provides "CoordinatedOptimizer" for managing sharded optimizer states and synchronizing gradients across devices, and "TensorParallelOptimizer" as a Keras-compatible wrapper.
  • Gradient Synchronization Logic: The "CoordinatedOptimizer" includes logic to perform "all-reduce" operations on gradients of column-parallel sharded weights, ensuring correct updates in a distributed setting.
  • Optimizer State Sharding: Implemented functionality to partition optimizer state variables (like momentum and velocity) across multiple devices, reducing memory footprint per device.
  • Comprehensive Testing: New test files ("autoconfig_test.py", "coordinated_optimizer_test.py") were added to validate the automatic sharding configuration and the distributed optimizer's behavior, including handling of replicated and sharded states, and serialization.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces significant new functionality for tensor parallelism autosharding in Keras, including modules for automatic configuration and a coordinated optimizer. The implementation is well-structured, with new logic for analyzing models, generating sharding plans, and synchronizing gradients. However, I've identified a few issues that need attention. There is a critical bug in the CoordinatedOptimizer where a method for applying gradients with sharded states is called but not defined. I also found a couple of high-severity issues related to incorrect logic for matching optimizer states and gathering sharded parameters, which could lead to runtime errors or incorrect behavior. Additionally, there are some medium-severity issues regarding code clarity, such as unused parameters. The accompanying tests are a good start but do not cover the code path with the critical bug.

@buildwithsuhana buildwithsuhana marked this pull request as draft October 2, 2025 17:28
@codecov-commenter
Copy link

codecov-commenter commented Oct 15, 2025

Codecov Report

❌ Patch coverage is 59.32642% with 157 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.49%. Comparing base (a62a4a3) to head (3a4af33).
⚠️ Report is 19 commits behind head on master.

Files with missing lines Patch % Lines
...tribution/tensor_parallel/coordinated_optimizer.py 55.50% 87 Missing and 14 partials ⚠️
...ras/src/distribution/tensor_parallel/autoconfig.py 76.53% 11 Missing and 12 partials ⚠️
.../src/distribution/tensor_parallel/tensor_layout.py 46.15% 20 Missing and 1 partial ⚠️
keras/src/backend/jax/distributed_backend.py 29.41% 12 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master   #21707      +/-   ##
==========================================
- Coverage   82.59%   82.49%   -0.11%     
==========================================
  Files         572      576       +4     
  Lines       58322    58923     +601     
  Branches     9130     9236     +106     
==========================================
+ Hits        48173    48606     +433     
- Misses       7818     7965     +147     
- Partials     2331     2352      +21     
Flag Coverage Δ
keras 82.29% <59.32%> (-0.11%) ⬇️
keras-jax 63.17% <58.29%> (-0.14%) ⬇️
keras-numpy 57.44% <36.01%> (-0.22%) ⬇️
keras-openvino 34.61% <36.01%> (+0.29%) ⬆️
keras-tensorflow 63.78% <36.01%> (-0.27%) ⬇️
keras-torch 63.33% <36.01%> (-0.31%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@buildwithsuhana buildwithsuhana marked this pull request as ready for review October 15, 2025 20:30
Comment on lines +110 to +112
if id(current_layer) in processed_layers:
return
processed_layers.add(id(current_layer))
Copy link
Collaborator

Choose a reason for hiding this comment

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

Per my comment below about not needing a recursion, this is not needed

processed_layers.add(id(current_layer))

name = current_layer.name
full_name = f"{prefix}.{name}" if prefix else name
Copy link
Collaborator

Choose a reason for hiding this comment

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

Because you will never really recurse, the prefix won't work.

self._variable_to_slot_name = {}
opt_name = self.base_optimizer.name

normalized_params = sorted(
Copy link
Collaborator

Choose a reason for hiding this comment

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

I have a hard time following what the code in this method is doing. I think it's try to re-pair the optimizer variables with the corresponding model variables.

I think it would be easier to capture that information in BaseOptimizer.add_variable_from_reference. Today we have _get_variable_index, but we need something more specific.

Also what do you call a slot?

Comment on lines +369 to +371
numpy_grad = ops.convert_to_numpy(gradients[0])
synced_numpy = all_reduce_fn(numpy_grad, op="mean")
synced_tensor = ops.convert_to_tensor(synced_numpy)
Copy link
Collaborator

Choose a reason for hiding this comment

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

numpy_grad = ops.convert_to_numpy(gradients[0])

This is going to copy the gradient tensor from GPU/TPU to CPU memory. At that point, there is no sharding anymore because it's going to gather all shards from all GPUs into one single recombined tensor on CPU.

synced_numpy = all_reduce_fn(numpy_grad, op="mean")

There is no all_reduce needed here, this is a CPU NumPy array, you might as well do np.mean.

However, what JAX will do is copy the full tensor (unsharded) from CPU to device 0 and perform the mean on that one device.

synced_tensor = ops.convert_to_tensor(synced_numpy)

synced_numpy is already a JAX array per my comment above, so this is a no-op.

So overall, I'm not sure what the intent is, but it look like this is not doing what you think it's doing. In particular, it's moving gradient back and forth to CPU, which will reduce the throughput.

Comment on lines +374 to +377
stacked_grads = keras.ops.stack(
[ops.convert_to_tensor(g) for g in gradients], axis=0
)
mean_grad = ops.mean(stacked_grads, axis=0)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why would there be more than 1 gradient in this case?

mean_grad = ops.mean(stacked_grads, axis=0)
return [mean_grad for _ in range(len(gradients))]

def get_weights(self):
Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh weird, I wonder why get_weights is missing in BaseOptimizer.

self._initialize_sharded_states()


class TensorParallelOptimizer(optimizers.Optimizer):
Copy link
Collaborator

Choose a reason for hiding this comment

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

It appears that TensorParallelOptimizer is mostly a wrapper around CoordinatedOptimizer.

Any reason to have both separate?

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants