-
Notifications
You must be signed in to change notification settings - Fork 6.4k
Add Photon model and pipeline support #12456
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
52 commits
Select commit
Hold shift + click to select a range
c46a649
Add Photon model and pipeline support
8e78a99
just store the T5Gemma encoder
3aeada7
enhance_vae_properties if vae is provided only
d5c3272
remove autocast for text encoder forwad
234c5e3
BF16 example
david-PHR 49528a4
conditioned CFG
0a4183c
remove enhance vae and use vae.config directly when possible
7f1199b
move PhotonAttnProcessor2_0 in transformer_photon
cabde58
remove einops dependency and now inherits from AttentionMixin
bca1f7c
unify the structure of the forward block
cdfa636
update doc
03a7df3
update doc
c248835
fix T5Gemma loading from hub
94f469a
fix timestep shift
ec2381e
remove lora support from doc
b445016
Rename EmbedND for PhotoEmbedND
DavidBert 7ae1af9
remove modulation dataclass
DavidBert a8216f7
put _attn_forward and _ffn_forward logic in PhotonBlock's forward
DavidBert 73261c8
renam LastLayer for FinalLayer
DavidBert f8f45fd
remove lora related code
DavidBert e65de5f
rename vae_spatial_compression_ratio for vae_scale_factor
DavidBert b765031
support prompt_embeds in call
DavidBert 87cd6d2
move xattention conditionning out computation out of the denoising loop
DavidBert 1b61bb2
add negative prompts
DavidBert 9ca25fa
Use _import_structure for lazy loading
DavidBert 98ed747
make quality + style
DavidBert 9819ff1
add pipeline test + corresponding fixes
DavidBert 77b4f8f
utility function that determines the default resolution given the VAE
DavidBert 19f9c47
Refactor PhotonAttention to match Flux pattern
DavidBert cd78032
built-in RMSNorm
DavidBert 6987240
Revert accidental .gitignore change
DavidBert c92ee55
parameter names match the standard diffusers conventions
DavidBert 4f74d94
renaming and remove unecessary attributes setting
DavidBert d219e8c
Update docs/source/en/api/pipelines/photon.md
DavidBert 5d57f44
quantization example
DavidBert 5270316
added doc to toctree
DavidBert f7f516f
Update docs/source/en/api/pipelines/photon.md
DavidBert fb98a3a
Update docs/source/en/api/pipelines/photon.md
DavidBert f891323
Update docs/source/en/api/pipelines/photon.md
DavidBert 5fcb8e6
use dispatch_attention_fn for multiple attention backend support
DavidBert 23392b0
naming changes
DavidBert 1f88313
make fix copy
DavidBert 167030c
Update docs/source/en/api/pipelines/photon.md
DavidBert 8b551d2
Add PhotonTransformer2DModel to TYPE_CHECKING imports
DavidBert 7f6bb8a
make fix-copies
DavidBert 4264606
Use Tuple instead of tuple
DavidBert 756fe95
restrict the version of transformers
DavidBert 4402b41
Update tests/pipelines/photon/test_pipeline_photon.py
DavidBert 3b953ff
Update tests/pipelines/photon/test_pipeline_photon.py
DavidBert fda1f78
change | for Optional
DavidBert 3e2d292
fix nits.
sayakpaul 803d0d1
use typing Dict
DavidBert 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
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 |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| <!-- Copyright 2025 The HuggingFace Team. All rights reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. --> | ||
|
|
||
| # Photon | ||
|
|
||
|
|
||
| Photon generates high-quality images from text using a simplified MMDIT architecture where text tokens don't update through transformer blocks. It employs flow matching with discrete scheduling for efficient sampling and uses Google's T5Gemma-2B-2B-UL2 model for multi-language text encoding. The ~1.3B parameter transformer delivers fast inference without sacrificing quality. You can choose between Flux VAE (8x compression, 16 latent channels) for balanced quality and speed or DC-AE (32x compression, 32 latent channels) for latent compression and faster processing. | ||
|
|
||
| ## Available models | ||
|
|
||
| Photon offers multiple variants with different VAE configurations, each optimized for specific resolutions. Base models excel with detailed prompts, capturing complex compositions and subtle details. Fine-tuned models trained on the [Alchemist dataset](https://huggingface.co/datasets/yandex/alchemist) improve aesthetic quality, especially with simpler prompts. | ||
|
|
||
|
|
||
| | Model | Resolution | Fine-tuned | Distilled | Description | Suggested prompts | Suggested parameters | Recommended dtype | | ||
| |:-----:|:-----------------:|:----------:|:----------:|:----------:|:----------:|:----------:|:----------:| | ||
| | [`Photoroom/photon-256-t2i`](https://huggingface.co/Photoroom/photon-256-t2i)| 256 | No | No | Base model pre-trained at 256 with Flux VAE|Works best with detailed prompts in natural language|28 steps, cfg=5.0| `torch.bfloat16` | | ||
| | [`Photoroom/photon-256-t2i-sft`](https://huggingface.co/Photoroom/photon-256-t2i-sft)| 512 | Yes | No | Fine-tuned on the [Alchemist dataset](https://huggingface.co/datasets/yandex/alchemist) dataset with Flux VAE | Can handle less detailed prompts|28 steps, cfg=5.0| `torch.bfloat16` | | ||
| | [`Photoroom/photon-512-t2i`](https://huggingface.co/Photoroom/photon-512-t2i)| 512 | No | No | Base model pre-trained at 512 with Flux VAE |Works best with detailed prompts in natural language|28 steps, cfg=5.0| `torch.bfloat16` | | ||
| | [`Photoroom/photon-512-t2i-sft`](https://huggingface.co/Photoroom/photon-512-t2i-sft)| 512 | Yes | No | Fine-tuned on the [Alchemist dataset](https://huggingface.co/datasets/yandex/alchemist) dataset with Flux VAE | Can handle less detailed prompts in natural language|28 steps, cfg=5.0| `torch.bfloat16` | | ||
| | [`Photoroom/photon-512-t2i-sft-distilled`](https://huggingface.co/Photoroom/photon-512-t2i-sft-distilled)| 512 | Yes | Yes | 8-step distilled model from [`Photoroom/photon-512-t2i-sft`](https://huggingface.co/Photoroom/photon-512-t2i-sft) | Can handle less detailed prompts in natural language|8 steps, cfg=1.0| `torch.bfloat16` | | ||
| | [`Photoroom/photon-512-t2i-dc-ae`](https://huggingface.co/Photoroom/photon-512-t2i-dc-ae)| 512 | No | No | Base model pre-trained at 512 with [Deep Compression Autoencoder (DC-AE)](https://hanlab.mit.edu/projects/dc-ae)|Works best with detailed prompts in natural language|28 steps, cfg=5.0| `torch.bfloat16` | | ||
| | [`Photoroom/photon-512-t2i-dc-ae-sft`](https://huggingface.co/Photoroom/photon-512-t2i-dc-ae-sft)| 512 | Yes | No | Fine-tuned on the [Alchemist dataset](https://huggingface.co/datasets/yandex/alchemist) dataset with [Deep Compression Autoencoder (DC-AE)](https://hanlab.mit.edu/projects/dc-ae) | Can handle less detailed prompts in natural language|28 steps, cfg=5.0| `torch.bfloat16` | | ||
| | [`Photoroom/photon-512-t2i-dc-ae-sft-distilled`](https://huggingface.co/Photoroom/photon-512-t2i-dc-ae-sft-distilled)| 512 | Yes | Yes | 8-step distilled model from [`Photoroom/photon-512-t2i-dc-ae-sft-distilled`](https://huggingface.co/Photoroom/photon-512-t2i-dc-ae-sft-distilled) | Can handle less detailed prompts in natural language|8 steps, cfg=1.0| `torch.bfloat16` |s | ||
|
|
||
| Refer to [this](https://huggingface.co/collections/Photoroom/photon-models-68e66254c202ebfab99ad38e) collection for more information. | ||
|
|
||
| ## Loading the pipeline | ||
|
|
||
| Load the pipeline with [`~DiffusionPipeline.from_pretrained`]. | ||
|
|
||
| ```py | ||
| from diffusers.pipelines.photon import PhotonPipeline | ||
|
|
||
| # Load pipeline - VAE and text encoder will be loaded from HuggingFace | ||
| pipe = PhotonPipeline.from_pretrained("Photoroom/photon-512-t2i-sft", torch_dtype=torch.bfloat16) | ||
| pipe.to("cuda") | ||
|
|
||
| prompt = "A front-facing portrait of a lion the golden savanna at sunset." | ||
| image = pipe(prompt, num_inference_steps=28, guidance_scale=5.0).images[0] | ||
| image.save("photon_output.png") | ||
| ``` | ||
|
|
||
| ### Manual Component Loading | ||
|
|
||
| Load components individually to customize the pipeline for instance to use quantized models. | ||
|
|
||
| ```py | ||
| import torch | ||
| from diffusers.pipelines.photon import PhotonPipeline | ||
| from diffusers.models import AutoencoderKL, AutoencoderDC | ||
| from diffusers.models.transformers.transformer_photon import PhotonTransformer2DModel | ||
| from diffusers.schedulers import FlowMatchEulerDiscreteScheduler | ||
| from transformers import T5GemmaModel, GemmaTokenizerFast | ||
| from diffusers import BitsAndBytesConfig as DiffusersBitsAndBytesConfig | ||
| from transformers import BitsAndBytesConfig as BitsAndBytesConfig | ||
|
|
||
| quant_config = DiffusersBitsAndBytesConfig(load_in_8bit=True) | ||
| # Load transformer | ||
| transformer = PhotonTransformer2DModel.from_pretrained( | ||
| "checkpoints/photon-512-t2i-sft", | ||
| subfolder="transformer", | ||
| quantization_config=quant_config, | ||
| torch_dtype=torch.bfloat16, | ||
| ) | ||
|
|
||
| # Load scheduler | ||
| scheduler = FlowMatchEulerDiscreteScheduler.from_pretrained( | ||
| "checkpoints/photon-512-t2i-sft", subfolder="scheduler" | ||
| ) | ||
|
|
||
| # Load T5Gemma text encoder | ||
| t5gemma_model = T5GemmaModel.from_pretrained("google/t5gemma-2b-2b-ul2", | ||
| quantization_config=quant_config, | ||
| torch_dtype=torch.bfloat16) | ||
| text_encoder = t5gemma_model.encoder.to(dtype=torch.bfloat16) | ||
| tokenizer = GemmaTokenizerFast.from_pretrained("google/t5gemma-2b-2b-ul2") | ||
| tokenizer.model_max_length = 256 | ||
|
|
||
| # Load VAE - choose either Flux VAE or DC-AE | ||
| # Flux VAE | ||
| vae = AutoencoderKL.from_pretrained("black-forest-labs/FLUX.1-dev", | ||
| subfolder="vae", | ||
| quantization_config=quant_config, | ||
| torch_dtype=torch.bfloat16) | ||
|
|
||
| pipe = PhotonPipeline( | ||
| transformer=transformer, | ||
| scheduler=scheduler, | ||
| text_encoder=text_encoder, | ||
| tokenizer=tokenizer, | ||
| vae=vae | ||
| ) | ||
| pipe.to("cuda") | ||
| ``` | ||
|
|
||
|
|
||
| ## Memory Optimization | ||
|
|
||
| For memory-constrained environments: | ||
|
|
||
| ```py | ||
| import torch | ||
| from diffusers.pipelines.photon import PhotonPipeline | ||
|
|
||
| pipe = PhotonPipeline.from_pretrained("Photoroom/photon-512-t2i-sft", torch_dtype=torch.bfloat16) | ||
| pipe.enable_model_cpu_offload() # Offload components to CPU when not in use | ||
|
|
||
| # Or use sequential CPU offload for even lower memory | ||
| pipe.enable_sequential_cpu_offload() | ||
| ``` | ||
|
|
||
| ## PhotonPipeline | ||
|
|
||
| [[autodoc]] PhotonPipeline | ||
| - all | ||
| - __call__ | ||
|
|
||
| ## PhotonPipelineOutput | ||
|
|
||
| [[autodoc]] pipelines.photon.pipeline_output.PhotonPipelineOutput | ||
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.