doc: update docstrings for diffusers models #367
+74
−1
Conversation
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
Comment on lines
+225
to
+232
| Args: | ||
| sample (torch.FloatTensor): The noisy input tensor. | ||
| timestep (Union[torch.Tensor, float, int]): The number of timesteps to denoise an input. | ||
| encoder_hidden_states (torch.Tensor): The encoder hidden states. | ||
| controlnet_cond (torch.FloatTensor): The conditional input tensor of shape `(batch_size, max_seq_len, hidden_size)`. | ||
| conditioning_scale (torch.Tensor): The scale factor for ControlNet outputs. | ||
| added_cond_kwargs (Dict[str, torch.Tensor]): Additional conditions for the Stable Diffusion XL UNet. | ||
| return_dict (bool): Whether or not to return a [`~diffusers.models.controlnets.controlnet.ControlNetOutput`] instead of a plain tuple |
Contributor
There was a problem hiding this comment.
Is it okay if there is no mention of kwargs?
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.
Pull Request Description
Type of Change
Changes Overview
Update docstrings for diffusers models.
docstrings for diffusers pipelines will be updated after current update is reviewed.
Motivation and Context
Related Issues
#363
Conventional commit
Type candidate
model: Adding New models or Bugfix for existing modelsperformance: Optimizing some models or this library itselfrefactor: Re-arrange class architecture, or more.doc: Update docstring onlydependency: Update requirements, something like that.release: Merging dev to main for production releaseother: None of above.