Skip to content

[WIP] Refactor Attention Modules #11685

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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

[WIP] Refactor Attention Modules #11685

wants to merge 7 commits into from

Conversation

DN6
Copy link
Collaborator

@DN6 DN6 commented Jun 10, 2025

What does this PR do?

Draft PR to address some issues with the attention modules.

  1. Moves a number of transformer related blocks/objects in the attention module that would have a better home under models/transformers

  2. Moves the definition of the Attention module into attention.py, rather than have it live in attention_prcessors.py.

  3. We have a very large number of processors, but with Attention Dispatcher #11368 we should no longer need a good chunk of them and they can be deprecated. I think with these changes we would end up with ~3 processors per model (Attn, IPAdapter, PAG)

  4. Make it so that we can bump up our minimum supported Torch version to >=2.0 and use the F.sdpa API for all processors.

  5. There was some discussion around naming of the processors:
    https://huggingface.slack.com/archives/C065E480NN9/p1737130514639479
    We landed on calling the processors something like AttnProcessorsSDPA, but with Attention Dispatcher #11368 we no longer need to use a dedicated processor per backend, so I think it's okay to just have the class be named AttnProcessor.

  6. Move processor definitions into the model files, so we don't end up with very large files containing all processors.

  7. Introduce AttentionModuleMixin that contains all common methods related to attention operations. New attention modules would inherit from this class.

  8. Introduce an AttentionMixin for models so that methods like set_processor are not duplicated across models. Although we can probably just add the methods of this Mixin to ModelMixin

  9. Using Flux as an example here to show how we can define a single Processor to support both fused/unfused qkv projections.

Fixes # (issue)

Before submitting

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

Copy link
Member

@a-r-r-o-w a-r-r-o-w left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, glad to see this refactor finally coming together 😄

@@ -0,0 +1,1251 @@
# Copyright 2024 The HuggingFace Team. All rights reserved.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no strong feelings about the idea of having a common modeling file, but I think if we could minify the implementation a bit and specialize per-model, it will be really clean. Basically, the entire model implementation is top-to-bottom present in a single without requiring imports from diffusers.*. I can help complete this if we're okay with the idea

logger = logging.get_logger(__name__)


def _chunked_feed_forward(ff: nn.Module, hidden_states: torch.Tensor, chunk_dim: int, chunk_size: int):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, I would like to try and deprecate this method. We should, in theory, be able to chunk across all the dimensions on which a model does not operate on. We discussed a bit in the past about a SplitInferenceHook but I never quite got around to it. I can revive the idea if it sounds like something we would be okay with doing.

return hidden_states


class LuminaFeedForward(nn.Module):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move to Lumina file?

value = torch.cat([encoder_value, value], dim=2)

if image_rotary_emb is not None:
from ..embeddings import apply_rotary_emb
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the attention refactor, I think having per-model implementation of RoPE preparation would be nice. This aligns with having one-file-per-model and the full implementation being available at once place

return hidden_states


class FluxIPAdapterAttnProcessor(torch.nn.Module):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know the context behind making an attention processor a torch.nn.Module and why this was done in the past. Is there a way we could decouple the module part from the attention processor by creating a new "AttentionIPAdapter" class and setting its processor to this?


return processors

def set_attn_processor(self, processor: Union[AttentionProcessor, Dict[str, AttentionProcessor]]):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this implementation could be simplified a bit too to not use recursion

Comment on lines +111 to +112
if "Added" in str(attn_processor.__class__.__name__):
raise ValueError("`fuse_qkv_projections()` is not supported for models having added KV projections.")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, we should support fusing the KV projections into single linear. Anything that's commonly used for inference optimization would benefit from having a reference implementation. Not really a priority though, so just making a note

backend = AttentionBackendName(backend.lower())
self.processor._attention_backend = backend

def set_use_npu_flash_attention(self, use_npu_flash_attention: bool) -> None:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to keep the npu/xla/xformers-specific functions here? I think attention backends should have it covered already, no?

self.set_attention_backend("xformers")

@torch.no_grad()
def fuse_projections(self):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having a fuse/unfuse method per "Attention" class (which may exist at per-model level if we are aligned with my above comments) would be nice and super clean IMO


self.fused_projections = False

def set_attention_slice(self, slice_size: int) -> None:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, I would like to completely get rid of the 4-5 functions that follow and do model-specific implementations. For batch/head slicing, re: SplitInferenceHook.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants