[docs] refactoring docstrings in ./src/diffusers/models/transformers/auraflow_transformer_2d.py #9715
+21
−18
Conversation
This file contains 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
…auraflow_transformer_2d.py I reopened this PR since the previous one may occur sync issue.
a-r-r-o-w
reviewed
Oct 19, 2024
| processor (`dict` of `AttentionProcessor` or only `AttentionProcessor`): | ||
| The instantiated processor class or a dictionary of processor classes that will be set as the processor | ||
| Args: | ||
| processor (Union[`dict`, `dict[`AttentionProcessor`]`]): |
There was a problem hiding this comment.
Suggested change
| processor (Union[`dict`, `dict[`AttentionProcessor`]`]): | |
| processor (`AttentionProcessor` or `Dict[str, AttentionProcessor]`]): |
| @@ -347,8 +347,9 @@ def __init__( | |||
| def attn_processors(self) -> Dict[str, AttentionProcessor]: | |||
| r""" | |||
| Returns: | |||
| `dict` of attention processors: A dictionary containing all attention processors used in the model with | |||
| indexed by its weight name. | |||
| [`dict[`attention processors`]`] | |||
There was a problem hiding this comment.
This would cause tests to fail too as it requires all implementation that copy from UNet2DConditionalModel.attn_processors to have the same docs and implementation. This can be changed, but you need to make the modification in the mentioned file and then run make fix-copies (can do in a separate PR)
| @@ -405,8 +406,10 @@ def fn_recursive_attn_processor(name: str, module: torch.nn.Module, processor): | |||
| # Copied from diffusers.models.unets.unet_2d_condition.UNet2DConditionModel.fuse_qkv_projections with FusedAttnProcessor2_0->FusedAuraFlowAttnProcessor2_0 | |||
| def fuse_qkv_projections(self): | |||
| """ | |||
| Enables fused QKV projections. For self-attention modules, all projection matrices (i.e., query, key, value) | |||
| are fused. For cross-attention modules, key and value projection matrices are fused. | |||
| Enables fused QKV projections. | |||
There was a problem hiding this comment.
I think this will cause test to break because it is # Copied from elsewhere. This would require the implementations and docs to be the same as every other occurrence
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
Fixes #9567
(I reopened PR with same doc since my previous PR may occur sync issue. sorry for confusion!)
Fixes # (issue)
Before submitting
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
This PR tries to attempt a solution at one of the submodules listed in #9567 so I think @a-r-r-o-w is the best to review it. Alongside the same, @charchit7 @yijun-lee and @SubhasmitaSw were also working on the same, so just a ping for the update on the same.