-
Notifications
You must be signed in to change notification settings - Fork 6.3k
[docs] Parallel loading of shards #12135
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b0dd3b7
initial
stevhliu e06b21f
feedback
stevhliu 9a9fd95
Merge branch 'main' into parallel-loading
sayakpaul 2f42f08
Merge branch 'main' into parallel-loading
sayakpaul ca661ef
Update docs/source/en/using-diffusers/loading.md
sayakpaul 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 |
---|---|---|
|
@@ -112,6 +112,30 @@ print(pipe.transformer.dtype, pipe.vae.dtype) # (torch.bfloat16, torch.float16) | |
|
||
If a component is not explicitly specified in the dictionary and no `default` is provided, it will be loaded with `torch.float32`. | ||
|
||
### Parallel loading | ||
|
||
Large models are often [sharded](../training/distributed_inference#model-sharding) into smaller files so that they are easier to load. Diffusers supports loading shards in parallel to speed up the loading process. | ||
|
||
Set the environment variables below to enable parallel loading. | ||
|
||
- Set `HF_ENABLE_PARALLEL_LOADING` to `"YES"` to enable parallel loading of shards. | ||
- Set `HF_PARALLEL_LOADING_WORKERS` to configure the number of parallel threads to use when loading shards. More workers loads a model faster but uses more memory. | ||
|
||
The `device_map` argument should be set to `"cuda"` to pre-allocate a large chunk of memory based on the model size. This substantially reduces model load time because warming up the memory allocator now avoids many smaller calls to the allocator later. | ||
|
||
```py | ||
import os | ||
import torch | ||
from diffusers import DiffusionPipeline | ||
|
||
os.environ["HF_ENABLE_PARALLEL_LOADING"] = "YES" | ||
pipeline = DiffusionPipeline.from_pretrained( | ||
"Wan-AI/Wan2.2-I2V-A14B-Diffusers", | ||
torch_dtype=torch.bfloat16, | ||
device_map="cuda" | ||
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. Do we want to talk a bit about |
||
) | ||
``` | ||
|
||
### Local pipeline | ||
|
||
To load a pipeline locally, use [git-lfs](https://git-lfs.github.com/) to manually download a checkpoint to your local disk. | ||
|
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.