-
Notifications
You must be signed in to change notification settings - Fork 6.4k
Prx #12525
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
Prx #12525
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b7fb0fe
rename photon to prx
DavidBert 9fd52e8
rename photon into prx
DavidBert 163521b
Revert .gitignore to state before commit b7fb0fe9d63bf766bbe3c42ac154…
DavidBert 8417ff5
rename photon to prx
DavidBert c44717b
rename photon into prx
DavidBert 1b34a3c
Revert .gitignore to state before commit b7fb0fe9d63bf766bbe3c42ac154…
DavidBert 34dc6c4
Merge branch 'prx' of https://github.com/Photoroom/diffusers into prx
DavidBert 3b80dcd
make fix-copies
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
This file was deleted.
Oops, something went wrong.
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. --> | ||
|
|
||
| # PRX | ||
|
|
||
|
|
||
| PRX 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 | ||
|
|
||
| PRX 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/prx-256-t2i`](https://huggingface.co/Photoroom/prx-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/prx-256-t2i-sft`](https://huggingface.co/Photoroom/prx-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/prx-512-t2i`](https://huggingface.co/Photoroom/prx-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/prx-512-t2i-sft`](https://huggingface.co/Photoroom/prx-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/prx-512-t2i-sft-distilled`](https://huggingface.co/Photoroom/prx-512-t2i-sft-distilled)| 512 | Yes | Yes | 8-step distilled model from [`Photoroom/prx-512-t2i-sft`](https://huggingface.co/Photoroom/prx-512-t2i-sft) | Can handle less detailed prompts in natural language|8 steps, cfg=1.0| `torch.bfloat16` | | ||
| | [`Photoroom/prx-512-t2i-dc-ae`](https://huggingface.co/Photoroom/prx-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/prx-512-t2i-dc-ae-sft`](https://huggingface.co/Photoroom/prx-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/prx-512-t2i-dc-ae-sft-distilled`](https://huggingface.co/Photoroom/prx-512-t2i-dc-ae-sft-distilled)| 512 | Yes | Yes | 8-step distilled model from [`Photoroom/prx-512-t2i-dc-ae-sft-distilled`](https://huggingface.co/Photoroom/prx-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/prx-models-68e66254c202ebfab99ad38e) collection for more information. | ||
|
|
||
| ## Loading the pipeline | ||
|
|
||
| Load the pipeline with [`~DiffusionPipeline.from_pretrained`]. | ||
|
|
||
| ```py | ||
| from diffusers.pipelines.prx import PRXPipeline | ||
|
|
||
| # Load pipeline - VAE and text encoder will be loaded from HuggingFace | ||
| pipe = PRXPipeline.from_pretrained("Photoroom/prx-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("prx_output.png") | ||
| ``` | ||
|
|
||
| ### Manual Component Loading | ||
|
|
||
| Load components individually to customize the pipeline for instance to use quantized models. | ||
|
|
||
| ```py | ||
| import torch | ||
| from diffusers.pipelines.prx import PRXPipeline | ||
| from diffusers.models import AutoencoderKL, AutoencoderDC | ||
| from diffusers.models.transformers.transformer_prx import PRXTransformer2DModel | ||
| 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 = PRXTransformer2DModel.from_pretrained( | ||
| "checkpoints/prx-512-t2i-sft", | ||
| subfolder="transformer", | ||
| quantization_config=quant_config, | ||
| torch_dtype=torch.bfloat16, | ||
| ) | ||
|
|
||
| # Load scheduler | ||
| scheduler = FlowMatchEulerDiscreteScheduler.from_pretrained( | ||
| "checkpoints/prx-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 = PRXPipeline( | ||
| 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.prx import PRXPipeline | ||
|
|
||
| pipe = PRXPipeline.from_pretrained("Photoroom/prx-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() | ||
| ``` | ||
|
|
||
| ## PRXPipeline | ||
|
|
||
| [[autodoc]] PRXPipeline | ||
| - all | ||
| - __call__ | ||
|
|
||
| ## PRXPipelineOutput | ||
|
|
||
| [[autodoc]] pipelines.prx.pipeline_output.PRXPipelineOutput |
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.
Can be safely reverted.
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.
Oops, sorry about that.