Skip to content

Commit 7667cfc

Browse files
authored
[docs] Add missing AttnProcessors (#10246)
* attnprocessors * lora * make style * fix * fix * sana * typo
1 parent 9f00c61 commit 7667cfc

File tree

2 files changed

+120
-11
lines changed

2 files changed

+120
-11
lines changed

docs/source/en/api/attnprocessor.md

Lines changed: 104 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,133 @@ specific language governing permissions and limitations under the License.
1515
An attention processor is a class for applying different types of attention mechanisms.
1616

1717
## AttnProcessor
18+
1819
[[autodoc]] models.attention_processor.AttnProcessor
1920

20-
## AttnProcessor2_0
2121
[[autodoc]] models.attention_processor.AttnProcessor2_0
2222

23-
## AttnAddedKVProcessor
2423
[[autodoc]] models.attention_processor.AttnAddedKVProcessor
2524

26-
## AttnAddedKVProcessor2_0
2725
[[autodoc]] models.attention_processor.AttnAddedKVProcessor2_0
2826

27+
[[autodoc]] models.attention_processor.AttnProcessorNPU
28+
29+
[[autodoc]] models.attention_processor.FusedAttnProcessor2_0
30+
31+
## Allegro
32+
33+
[[autodoc]] models.attention_processor.AllegroAttnProcessor2_0
34+
35+
## AuraFlow
36+
37+
[[autodoc]] models.attention_processor.AuraFlowAttnProcessor2_0
38+
39+
[[autodoc]] models.attention_processor.FusedAuraFlowAttnProcessor2_0
40+
41+
## CogVideoX
42+
43+
[[autodoc]] models.attention_processor.CogVideoXAttnProcessor2_0
44+
45+
[[autodoc]] models.attention_processor.FusedCogVideoXAttnProcessor2_0
46+
2947
## CrossFrameAttnProcessor
48+
3049
[[autodoc]] pipelines.text_to_video_synthesis.pipeline_text_to_video_zero.CrossFrameAttnProcessor
3150

32-
## CustomDiffusionAttnProcessor
51+
## Custom Diffusion
52+
3353
[[autodoc]] models.attention_processor.CustomDiffusionAttnProcessor
3454

35-
## CustomDiffusionAttnProcessor2_0
3655
[[autodoc]] models.attention_processor.CustomDiffusionAttnProcessor2_0
3756

38-
## CustomDiffusionXFormersAttnProcessor
3957
[[autodoc]] models.attention_processor.CustomDiffusionXFormersAttnProcessor
4058

41-
## FusedAttnProcessor2_0
42-
[[autodoc]] models.attention_processor.FusedAttnProcessor2_0
59+
## Flux
60+
61+
[[autodoc]] models.attention_processor.FluxAttnProcessor2_0
62+
63+
[[autodoc]] models.attention_processor.FusedFluxAttnProcessor2_0
64+
65+
[[autodoc]] models.attention_processor.FluxSingleAttnProcessor2_0
66+
67+
## Hunyuan
68+
69+
[[autodoc]] models.attention_processor.HunyuanAttnProcessor2_0
70+
71+
[[autodoc]] models.attention_processor.FusedHunyuanAttnProcessor2_0
72+
73+
[[autodoc]] models.attention_processor.PAGHunyuanAttnProcessor2_0
74+
75+
[[autodoc]] models.attention_processor.PAGCFGHunyuanAttnProcessor2_0
76+
77+
## IdentitySelfAttnProcessor2_0
78+
79+
[[autodoc]] models.attention_processor.PAGIdentitySelfAttnProcessor2_0
80+
81+
[[autodoc]] models.attention_processor.PAGCFGIdentitySelfAttnProcessor2_0
82+
83+
## IP-Adapter
84+
85+
[[autodoc]] models.attention_processor.IPAdapterAttnProcessor
86+
87+
[[autodoc]] models.attention_processor.IPAdapterAttnProcessor2_0
88+
89+
## JointAttnProcessor2_0
90+
91+
[[autodoc]] models.attention_processor.JointAttnProcessor2_0
92+
93+
[[autodoc]] models.attention_processor.PAGJointAttnProcessor2_0
94+
95+
[[autodoc]] models.attention_processor.PAGCFGJointAttnProcessor2_0
96+
97+
[[autodoc]] models.attention_processor.FusedJointAttnProcessor2_0
98+
99+
## LoRA
100+
101+
[[autodoc]] models.attention_processor.LoRAAttnProcessor
102+
103+
[[autodoc]] models.attention_processor.LoRAAttnProcessor2_0
104+
105+
[[autodoc]] models.attention_processor.LoRAAttnAddedKVProcessor
106+
107+
[[autodoc]] models.attention_processor.LoRAXFormersAttnProcessor
108+
109+
## Lumina-T2X
110+
111+
[[autodoc]] models.attention_processor.LuminaAttnProcessor2_0
112+
113+
## Mochi
114+
115+
[[autodoc]] models.attention_processor.MochiAttnProcessor2_0
116+
117+
[[autodoc]] models.attention_processor.MochiVaeAttnProcessor2_0
118+
119+
## Sana
120+
121+
[[autodoc]] models.attention_processor.SanaLinearAttnProcessor2_0
122+
123+
[[autodoc]] models.attention_processor.SanaMultiscaleAttnProcessor2_0
124+
125+
[[autodoc]] models.attention_processor.PAGCFGSanaLinearAttnProcessor2_0
126+
127+
[[autodoc]] models.attention_processor.PAGIdentitySanaLinearAttnProcessor2_0
128+
129+
## Stable Audio
130+
131+
[[autodoc]] models.attention_processor.StableAudioAttnProcessor2_0
43132

44133
## SlicedAttnProcessor
134+
45135
[[autodoc]] models.attention_processor.SlicedAttnProcessor
46136

47-
## SlicedAttnAddedKVProcessor
48137
[[autodoc]] models.attention_processor.SlicedAttnAddedKVProcessor
49138

50139
## XFormersAttnProcessor
140+
51141
[[autodoc]] models.attention_processor.XFormersAttnProcessor
52142

53-
## AttnProcessorNPU
54-
[[autodoc]] models.attention_processor.AttnProcessorNPU
143+
[[autodoc]] models.attention_processor.XFormersAttnAddedKVProcessor
144+
145+
## XLAFlashAttnProcessor2_0
146+
147+
[[autodoc]] models.attention_processor.XLAFlashAttnProcessor2_0

src/diffusers/models/attention_processor.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5423,21 +5423,37 @@ def __call__(self, attn: SanaMultiscaleLinearAttention, hidden_states: torch.Ten
54235423

54245424

54255425
class LoRAAttnProcessor:
5426+
r"""
5427+
Processor for implementing attention with LoRA.
5428+
"""
5429+
54265430
def __init__(self):
54275431
pass
54285432

54295433

54305434
class LoRAAttnProcessor2_0:
5435+
r"""
5436+
Processor for implementing attention with LoRA (enabled by default if you're using PyTorch 2.0).
5437+
"""
5438+
54315439
def __init__(self):
54325440
pass
54335441

54345442

54355443
class LoRAXFormersAttnProcessor:
5444+
r"""
5445+
Processor for implementing attention with LoRA using xFormers.
5446+
"""
5447+
54365448
def __init__(self):
54375449
pass
54385450

54395451

54405452
class LoRAAttnAddedKVProcessor:
5453+
r"""
5454+
Processor for implementing attention with LoRA with extra learnable key and value matrices for the text encoder.
5455+
"""
5456+
54415457
def __init__(self):
54425458
pass
54435459

0 commit comments

Comments
 (0)