-
Notifications
You must be signed in to change notification settings - Fork 6.8k
feat: implement rae autoencoder. #13046
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
Ando233
wants to merge
33
commits into
huggingface:main
Choose a base branch
from
Ando233:rae
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.
+1,912
−0
Open
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
382aad0
feat: implement three RAE encoders(dinov2, siglip2, mae)
f82cecc
feat: finish first version of autoencoder_rae
a3926d7
Merge branch 'main' into rae
Ando233 3ecf89d
Merge branch 'main' into rae
kashif 0850c8c
fix formatting
kashif 24acab0
make fix-copies
kashif 25bc9e3
initial doc
kashif f06ea7a
fix latent_mean / latent_var init types to accept config-friendly inputs
kashif d7cb124
use mean and std convention
kashif 0d59b22
cleanup
kashif 202b14f
add rae to diffusers script
kashif 7cbbf27
use imports
kashif e6d4499
use attention
kashif 6a9bde6
remove unneeded class
kashif 9522e68
example traiing script
kashif 906d79a
input and ground truth sizes have to be the same
kashif d3cbd5a
fix argument
kashif 96520c4
move loss to training script
kashif fc52959
cleanup
kashif a4fc9f6
simplify mixins
kashif d06b501
fix training script
kashif d8b2983
Merge branch 'main' into rae
kashif c68b812
fix entrypoint for instantiating the AutoencoderRAE
kashif 61885f3
added encoder_image_size config
kashif 28a02eb
undo last change
kashif b297868
fixes from pretrained weights
kashif 7debd07
Merge branch 'main' into rae
kashif b3ffd63
cleanups
kashif dca5923
address reviews
kashif c71cb44
Merge branch 'rae' of https://github.com/Ando233/diffusers into rae
kashif 5c85781
fix train script to use pretrained
kashif d965cab
fix conversion script review
kashif 663b580
latebt normalization buffers are now always registered with no-op def…
kashif 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,88 @@ | ||
| <!-- Copyright 2026 The NYU Vision-X and HuggingFace Teams. 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. | ||
| --> | ||
|
|
||
| # AutoencoderRAE | ||
|
|
||
| The Representation Autoencoder (RAE) model introduced in [Diffusion Transformers with Representation Autoencoders](https://huggingface.co/papers/2510.11690) by Boyang Zheng, Nanye Ma, Shengbang Tong, Saining Xie from NYU VISIONx. | ||
|
|
||
| RAE combines a frozen pretrained vision encoder (DINOv2, SigLIP2, or MAE) with a trainable ViT-MAE-style decoder. In the two-stage RAE training recipe, the autoencoder is trained in stage 1 (reconstruction), and then a diffusion model is trained on the resulting latent space in stage 2 (generation). | ||
|
|
||
| The following RAE models are released and supported in Diffusers: | ||
|
|
||
| | Model | Encoder | Latent shape (224px input) | | ||
| |:------|:--------|:---------------------------| | ||
| | [`nyu-visionx/RAE-dinov2-wReg-base-ViTXL-n08`](https://huggingface.co/nyu-visionx/RAE-dinov2-wReg-base-ViTXL-n08) | DINOv2-base | 768 x 16 x 16 | | ||
| | [`nyu-visionx/RAE-dinov2-wReg-base-ViTXL-n08-i512`](https://huggingface.co/nyu-visionx/RAE-dinov2-wReg-base-ViTXL-n08-i512) | DINOv2-base (512px) | 768 x 32 x 32 | | ||
| | [`nyu-visionx/RAE-dinov2-wReg-small-ViTXL-n08`](https://huggingface.co/nyu-visionx/RAE-dinov2-wReg-small-ViTXL-n08) | DINOv2-small | 384 x 16 x 16 | | ||
| | [`nyu-visionx/RAE-dinov2-wReg-large-ViTXL-n08`](https://huggingface.co/nyu-visionx/RAE-dinov2-wReg-large-ViTXL-n08) | DINOv2-large | 1024 x 16 x 16 | | ||
| | [`nyu-visionx/RAE-siglip2-base-p16-i256-ViTXL-n08`](https://huggingface.co/nyu-visionx/RAE-siglip2-base-p16-i256-ViTXL-n08) | SigLIP2-base | 768 x 16 x 16 | | ||
| | [`nyu-visionx/RAE-mae-base-p16-ViTXL-n08`](https://huggingface.co/nyu-visionx/RAE-mae-base-p16-ViTXL-n08) | MAE-base | 768 x 16 x 16 | | ||
|
|
||
| ## Loading a pretrained model | ||
|
|
||
| ```python | ||
| from diffusers import AutoencoderRAE | ||
|
|
||
| model = AutoencoderRAE.from_pretrained( | ||
| "nyu-visionx/RAE-dinov2-wReg-base-ViTXL-n08" | ||
| ).to("cuda").eval() | ||
| ``` | ||
|
|
||
| ## Encoding and decoding a real image | ||
|
|
||
| ```python | ||
| import torch | ||
| from diffusers import AutoencoderRAE | ||
| from PIL import Image | ||
| from torchvision.transforms.functional import to_tensor, to_pil_image | ||
|
|
||
| model = AutoencoderRAE.from_pretrained( | ||
| "nyu-visionx/RAE-dinov2-wReg-base-ViTXL-n08" | ||
| ).to("cuda").eval() | ||
|
|
||
| image = Image.open("cat.png").convert("RGB").resize((224, 224)) | ||
| x = to_tensor(image).unsqueeze(0).to("cuda") # (1, 3, 224, 224), values in [0, 1] | ||
|
|
||
| with torch.no_grad(): | ||
| latents = model.encode(x).latent # (1, 768, 16, 16) | ||
| recon = model.decode(latents).sample # (1, 3, 256, 256) | ||
|
|
||
| recon_image = to_pil_image(recon[0].clamp(0, 1).cpu()) | ||
| recon_image.save("recon.png") | ||
| ``` | ||
|
|
||
| ## Latent normalization | ||
|
|
||
| Some pretrained checkpoints include per-channel `latents_mean` and `latents_std` statistics for normalizing the latent space. When present, `encode` and `decode` automatically apply the normalization and denormalization, respectively. | ||
|
|
||
| ```python | ||
| model = AutoencoderRAE.from_pretrained( | ||
| "nyu-visionx/RAE-dinov2-wReg-base-ViTXL-n08" | ||
| ).to("cuda").eval() | ||
|
|
||
| # Latent normalization is handled automatically inside encode/decode | ||
| # when the checkpoint config includes latents_mean/latents_std. | ||
| with torch.no_grad(): | ||
| latents = model.encode(x).latent # normalized latents | ||
| recon = model.decode(latents).sample | ||
| ``` | ||
|
|
||
| ## AutoencoderRAE | ||
|
|
||
| [[autodoc]] AutoencoderRAE | ||
| - encode | ||
| - decode | ||
| - all | ||
|
|
||
| ## DecoderOutput | ||
|
|
||
| [[autodoc]] models.autoencoders.vae.DecoderOutput |
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,65 @@ | ||
| # Training AutoencoderRAE | ||
|
|
||
| This example trains the decoder of `AutoencoderRAE` (stage-1 style), while keeping the representation encoder frozen. | ||
|
|
||
| It follows the same high-level training recipe as the official RAE stage-1 setup: | ||
| - frozen encoder | ||
| - train decoder | ||
| - pixel reconstruction loss | ||
| - optional encoder feature consistency loss | ||
|
|
||
| ## Quickstart | ||
|
|
||
| ### Resume or finetune from pretrained weights | ||
|
|
||
| ```bash | ||
| accelerate launch examples/research_projects/autoencoder_rae/train_autoencoder_rae.py \ | ||
| --pretrained_model_name_or_path nyu-visionx/RAE-dinov2-wReg-base-ViTXL-n08 \ | ||
| --train_data_dir /path/to/imagenet_like_folder \ | ||
| --output_dir /tmp/autoencoder-rae \ | ||
| --resolution 256 \ | ||
| --train_batch_size 8 \ | ||
| --learning_rate 1e-4 \ | ||
| --num_train_epochs 10 \ | ||
| --report_to wandb \ | ||
| --reconstruction_loss_type l1 \ | ||
| --use_encoder_loss \ | ||
| --encoder_loss_weight 0.1 | ||
| ``` | ||
|
|
||
| ### Train from scratch with a pretrained encoder | ||
|
|
||
| ```bash | ||
| accelerate launch examples/research_projects/autoencoder_rae/train_autoencoder_rae.py \ | ||
| --train_data_dir /path/to/imagenet_like_folder \ | ||
| --output_dir /tmp/autoencoder-rae \ | ||
| --resolution 256 \ | ||
| --encoder_type dinov2 \ | ||
| --encoder_name_or_path facebook/dinov2-with-registers-base \ | ||
| --encoder_input_size 224 \ | ||
| --patch_size 16 \ | ||
| --image_size 256 \ | ||
| --decoder_hidden_size 1152 \ | ||
| --decoder_num_hidden_layers 28 \ | ||
| --decoder_num_attention_heads 16 \ | ||
| --decoder_intermediate_size 4096 \ | ||
| --train_batch_size 8 \ | ||
| --learning_rate 1e-4 \ | ||
| --num_train_epochs 10 \ | ||
| --report_to wandb \ | ||
| --reconstruction_loss_type l1 \ | ||
| --use_encoder_loss \ | ||
| --encoder_loss_weight 0.1 | ||
| ``` | ||
|
|
||
| Note: stage-1 reconstruction loss assumes matching target/output spatial size, so `--resolution` must equal `--image_size`. | ||
|
|
||
| Dataset format is expected to be `ImageFolder`-compatible: | ||
|
|
||
| ```text | ||
| train_data_dir/ | ||
| class_a/ | ||
| img_0001.jpg | ||
| class_b/ | ||
| img_0002.jpg | ||
| ``` | ||
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.
Maybe also include the pretrained encoder path in the example command?