Skip to content

Commit 3ac527a

Browse files
committed
add to docstrings.
1 parent d623186 commit 3ac527a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/diffusers/models/transformers/transformer_minimax_h3.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ class MiniMaxH3TransformerOutput(BaseOutput):
4646
sample (`torch.Tensor` of shape `(batch_size, num_video_tokens, in_channels * prod(patch_size))`):
4747
The video velocity prediction for the rows addressed by `video_indices`, in the same order. Conditioning
4848
rows are returned unmasked — masking them out before the scheduler step is the caller's job.
49-
audio_sample (`torch.Tensor` of shape `(batch_size, num_audio_tokens, audio_in_channels)`):
50-
The audio velocity prediction for the rows addressed by `audio_indices`, in the same order.
49+
audio_sample (`torch.Tensor` of shape `(batch_size, num_audio_tokens, audio_in_channels)`, defaults to `None`):
50+
The audio velocity prediction for the rows addressed by `audio_indices`, in the same order. `forward`
51+
always populates it; it only defaults to `None` so that the output can be rebuilt from a plain dict of its
52+
fields, which is how the accelerate offload hooks move a `BaseOutput` back to the input device.
5153
"""
5254

5355
sample: torch.Tensor
54-
# `forward` always populates `audio_sample`; the default is what lets the output be rebuilt from a plain dict of
55-
# its fields, which is how the accelerate offload hooks move a `BaseOutput` back to the input device.
5656
audio_sample: torch.Tensor | None = None
5757

5858

0 commit comments

Comments
 (0)