-
Notifications
You must be signed in to change notification settings - Fork 7.4k
[core] Shard tensor-parallel checkpoints on load and save #14544
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.
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
Open
JingyaHuang
wants to merge
31
commits into
huggingface:main
Choose a base branch
from
JingyaHuang:add-shard-ckpt-loading
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
31 commits
Select commit
Hold shift + click to select a range
acdf4bf
[core] Shard tensor-parallel checkpoints on load and save
JingyaHuang 0b9686b
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang 40ddb53
Raise when tensor parallelism is combined with quantization, offloadi…
JingyaHuang 0760934
Merge branch 'add-shard-ckpt-loading' of github.com:JingyaHuang/diffu…
JingyaHuang 842c643
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang 949cbdc
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang eb3f7f3
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang a754bbe
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang 6055292
Merge branch 'add-shard-ckpt-loading' of github.com:JingyaHuang/diffu…
JingyaHuang fd31c34
Merge branch 'main' into add-shard-ckpt-loading
sayakpaul 9511143
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang 53fd823
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang 4112d18
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang f741782
review: remove tp save/ dcp related
JingyaHuang 1b4d1d7
review: add a new helper .
JingyaHuang 4e9a927
review: moved the TP checks into enable_parallelism
JingyaHuang 0cca9a3
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang 7ea8b97
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang a89e7e4
review: move the warning under caution block
JingyaHuang e3fdafd
review: add loading time numbers
JingyaHuang 8a6ff80
review: move tp size dividende check
JingyaHuang 64c9e86
review: delete test
JingyaHuang b52a272
review: consolidate tp checks
JingyaHuang 068d7ab
review: consolidate the tp checks, all in tensor_parallel.py
JingyaHuang 6a56929
review: improve conditionals
JingyaHuang 85dc21b
review: debug info
JingyaHuang aad9e9e
review: check weights format before instantiating the model
JingyaHuang fc76c2c
review: restore duplicated _find_mismatched_keys since irrelevant
JingyaHuang cb01688
Merge branch 'main' into add-shard-ckpt-loading
JingyaHuang 30d4184
revert: delete duplicated helper
JingyaHuang 8f577c6
review: remove the dead duplicate _find_mismatched_keys again
JingyaHuang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -436,43 +436,51 @@ pipeline = DiffusionPipeline.from_pretrained( | |
|
|
||
| [Tensor parallelism](https://huggingface.co/spaces/nanotron/ultrascale-playbook?section=tensor_parallelism) shards the weight matrices of a model across devices. Each device holds a column-wise (`"colwise"`) or row-wise (`"rowwise"`) slice of each layer, computes a partial result, and an `AllReduce`/`AllGather` at the layer boundary reconstructs the full output. Unlike context parallelism, it reduces the per-device *weight* memory, which is useful for models that do not fit on a single device. | ||
|
|
||
| Pass a [`TensorParallelConfig`] to [`~ModelMixin.enable_parallelism`]. `tp_degree` is the number of devices to shard across and must divide the model's number of attention heads. The model must define a `_tp_plan` (a flat mapping of module-name globs to a `"colwise"`/`"rowwise"` style). | ||
| Pass a [`TensorParallelConfig`] to the `parallel_config` argument of the model's [`~ModelMixin.from_pretrained`]. `tp_degree` is the number of devices to shard across and must divide the model's number of attention heads. The model must define a `_tp_plan` (a flat mapping of module-name globs to a `"colwise"`/`"rowwise"` style). | ||
|
|
||
| Loading this way shards the checkpoint *while reading it*: each rank reads only its own slice of each sharded weight and places it straight onto its own device. Nothing full-size is ever materialized, so per-rank memory falls as `tp_degree` rises. | ||
|
|
||
| Compared to loading the full model and then calling [`~ModelMixin.enable_parallelism`], it loads faster and uses less CPU memory per rank, with the gap growing as `tp_degree` rises. Numbers below are for a FLUX.1-shaped synthetic checkpoint (1.33B params, bf16). | ||
|
|
||
| | tp_degree | method | load time | peak CPU/rank | | ||
| |---|---|---|---| | ||
| | 2 | `from_pretrained(parallel_config=...)` | 1.92s | 2.70GB | | ||
| | 2 | `from_pretrained` + `enable_parallelism` | 3.06s | 4.08GB | | ||
| | 4 | `from_pretrained(parallel_config=...)` | 1.45s | 2.20GB | | ||
| | 4 | `from_pretrained` + `enable_parallelism` | 3.29s | 4.08GB | | ||
|
|
||
| ```py | ||
| import torch | ||
| from torch import distributed as dist | ||
| from diffusers import DiffusionPipeline, TensorParallelConfig | ||
| from diffusers import DiffusionPipeline, Flux2Transformer2DModel, TensorParallelConfig | ||
|
|
||
| def setup_distributed(): | ||
| if not dist.is_initialized(): | ||
| dist.init_process_group(backend="nccl") | ||
| rank = dist.get_rank() | ||
| def main(): | ||
| dist.init_process_group(backend="nccl") | ||
| rank, world_size = dist.get_rank(), dist.get_world_size() | ||
| device = torch.device(f"cuda:{rank}") | ||
| torch.cuda.set_device(device) | ||
| return device | ||
|
|
||
| def main(): | ||
| device = setup_distributed() | ||
| world_size = dist.get_world_size() | ||
| # Each rank reads only its own shard of every planned weight, straight onto `cuda:rank`. | ||
| transformer = Flux2Transformer2DModel.from_pretrained( | ||
| "black-forest-labs/FLUX.2-dev", | ||
| subfolder="transformer", | ||
| torch_dtype=torch.bfloat16, | ||
| parallel_config=TensorParallelConfig(tp_degree=world_size), | ||
| ) | ||
|
|
||
| pipeline = DiffusionPipeline.from_pretrained( | ||
| "black-forest-labs/FLUX.2-dev", torch_dtype=torch.bfloat16 | ||
| ) # weights stay on CPU | ||
|
|
||
| # Shard the transformer first, then move only each rank's slice onto the accelerator. | ||
| pipeline.transformer.enable_parallelism(config=TensorParallelConfig(tp_degree=world_size)) | ||
| pipeline.transformer.to(device) | ||
|
|
||
| # Move the remaining, non-sharded components onto the accelerator individually. | ||
| "black-forest-labs/FLUX.2-dev", transformer=transformer, torch_dtype=torch.bfloat16 | ||
| ) | ||
| # The transformer is already on its device; move the remaining components individually. Do not call | ||
| # `pipeline.to(device)` — that would move every rank's shards onto the same device. | ||
| pipeline.text_encoder.to(device) | ||
| pipeline.vae.to(device) | ||
|
|
||
| generator = torch.Generator().manual_seed(42) | ||
| image = pipeline(prompt="a cat holding a sign that says hello", generator=generator).images[0] | ||
| if dist.get_rank() == 0: | ||
| if rank == 0: | ||
| image.save("output.png") | ||
| if dist.is_initialized(): | ||
| dist.destroy_process_group() | ||
| dist.destroy_process_group() | ||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
|
|
@@ -484,6 +492,15 @@ torchrun --nproc-per-node 4 tensor_parallel_flux.py | |
|
|
||
| `tp_degree` is taken from `world_size` above, so `--nproc-per-node 4` shards the transformer across 4 devices. | ||
|
|
||
| > [!CAUTION] | ||
| > Loading with a tensor-parallel `parallel_config` isn't supported yet with `device_map`, `quantization_config`, `low_cpu_mem_usage=False`, `use_flashpack=True`, or non-safetensors weights; each raises rather than quietly falling back to loading the full checkpoint. | ||
| > | ||
| > Combining tensor parallelism with quantization, offloading, or LoRA adapters isn't supported yet either, so those raise however the model is sharded. | ||
| > | ||
| > To shard a model that is already in memory, call [`~ModelMixin.enable_parallelism`] with the same config instead — that loads everything first and reshards it, so it costs full checkpoint memory on every rank. | ||
|
|
||
| Saving a tensor-parallel model isn't supported yet, and [`~ModelMixin.save_pretrained`] raises on one. Save the model before sharding it. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Perfecto! |
||
|
|
||
| ### Writing a tensor parallelism plan | ||
|
|
||
| Tensor parallelism only works on models that define a `_tp_plan`, a flat class attribute mapping module-name globs to a sharding style. Writing one is mostly a matter of pairing each projection that *expands* the hidden dimension with the projection that *contracts* it back. | ||
|
|
@@ -536,9 +553,11 @@ Anything absent from the plan stays replicated on every rank, which is the right | |
|
|
||
| #### Constraints and verification | ||
|
|
||
| - `tp_degree` must divide `config.num_attention_heads`. This is validated in [`~ModelMixin.enable_parallelism`]. | ||
| - `tp_degree` must divide `config.num_attention_heads`. | ||
| - Every packed block must *individually* be divisible by `tp_degree`, not just their sum. | ||
|
|
||
| Both are validated by [`~ModelMixin.from_pretrained`] and [`~ModelMixin.enable_parallelism`] before any weight is loaded or sharded. | ||
|
|
||
| Validate a new plan numerically rather than by eye: generate with a fixed seed on a single device, then again under tensor parallelism, and compare the outputs. A misplaced `"colwise"`/`"rowwise"` usually still runs and produces a plausible but wrong image. | ||
|
|
||
| > [!TIP] | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.