-
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
Open
DavidBert
wants to merge
40
commits into
huggingface:main
Choose a base branch
from
Photoroom:photon
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.
+2,459
−0
Open
Changes from all commits
Commits
Show all changes
40 commits
Select commit
Hold shift + click to select a range
fa8faed
Add Photon model and pipeline support
64ddfe5
just store the T5Gemma encoder
2947da0
enhance_vae_properties if vae is provided only
2575997
remove autocast for text encoder forwad
27421cb
BF16 example
david-PHR 1321ab4
conditioned CFG
32807a1
remove enhance vae and use vae.config directly when possible
117e835
move PhotonAttnProcessor2_0 in transformer_photon
c86aed2
remove einops dependency and now inherits from AttentionMixin
5f6359f
unify the structure of the forward block
3396143
update doc
c78f444
update doc
3f70395
fix T5Gemma loading from hub
d09ff3c
fix timestep shift
91486cf
remove lora support from doc
23dd181
Rename EmbedND for PhotoEmbedND
DavidBert 7efad33
remove modulation dataclass
DavidBert ef9c48d
put _attn_forward and _ffn_forward logic in PhotonBlock's forward
DavidBert 178cc6e
renam LastLayer for FinalLayer
DavidBert 924643a
remove lora related code
DavidBert faa00b9
rename vae_spatial_compression_ratio for vae_scale_factor
DavidBert 804dafd
support prompt_embeds in call
DavidBert 6f90e41
move xattention conditionning out computation out of the denoising loop
DavidBert 59f4bda
add negative prompts
DavidBert 9ad5720
Use _import_structure for lazy loading
DavidBert 027dbd5
make quality + style
DavidBert ff28f65
add pipeline test + corresponding fixes
DavidBert 28b9cf2
utility function that determines the default resolution given the VAE
DavidBert b596595
Refactor PhotonAttention to match Flux pattern
DavidBert c522119
built-in RMSNorm
DavidBert 3239f26
Revert accidental .gitignore change
DavidBert b7bbb04
parameter names match the standard diffusers conventions
DavidBert 83e0396
renaming and remove unecessary attributes setting
DavidBert 582b64a
Update docs/source/en/api/pipelines/photon.md
DavidBert 33926e0
Update docs/source/en/api/pipelines/photon.md
DavidBert c9e0a20
Update docs/source/en/api/pipelines/photon.md
DavidBert 2877b60
Update docs/source/en/api/pipelines/photon.md
DavidBert ed87475
quantization example
DavidBert 8aa65ba
added doc to toctree
DavidBert fba7b33
Merge branch 'photon' of https://github.com/Photoroom/diffusers into …
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`](hhttps://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` | | ||||||
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.
Suggested change
|
||||||
| [`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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these model links expected to be broken for now? I get a 404 for https://huggingface.co/Photoroom/photon-256-t2i-sft currently and see that only the
Photoroom/photon-256-t2i
model is currently in the Photon collection.