Skip to content
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

[HacktoberFest] Add missing docstrings to diffusers/models #5248

Merged
merged 4 commits into from
Oct 9, 2023

Conversation

a-r-r-o-w
Copy link
Member

What does this PR do?

Adds missing docstrings as mentioned in the linked issue. Also adds docstrings for similar missing cases in other files not mentioned in the original issue.

Fixes #5228

cc: @patrickvonplaten @yiyixuxu

Copy link
Collaborator

@yiyixuxu yiyixuxu left a comment

Choose a reason for hiding this comment

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

thanks!

Comment on lines 674 to 675
Conditional embeddings for timestep. If provided, the embeddings will be summed with the samples
passed through the `self.time_embedding` layer to obtain the timestep embeddings.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Conditional embeddings for timestep. If provided, the embeddings will be summed with the samples
passed through the `self.time_embedding` layer to obtain the timestep embeddings.
Additional conditional embeddings for timestep. If provided, the embeddings will be summed with the timestep embedding
passed through the `self.time_embedding` layer to obtain the timestep embeddings.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added the suggestion.

@yiyixuxu
Copy link
Collaborator

yiyixuxu commented Oct 6, 2023

@a-r-r-o-w don't forget make quality !

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

@patrickvonplaten patrickvonplaten merged commit 8d314c9 into huggingface:main Oct 9, 2023
10 of 11 checks passed
@a-r-r-o-w a-r-r-o-w deleted the docstrings branch November 7, 2023 11:40
yoonseokjin pushed a commit to yoonseokjin/diffusers that referenced this pull request Dec 25, 2023
…ce#5248)

* add missing docstrings

* chore: run make quality

* improvement: include docs suggestion by @yiyixuxu

---------

Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>
AmericanPresidentJimmyCarter pushed a commit to AmericanPresidentJimmyCarter/diffusers that referenced this pull request Apr 26, 2024
…ce#5248)

* add missing docstrings

* chore: run make quality

* improvement: include docs suggestion by @yiyixuxu

---------

Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>
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.

[HacktoberFest][Missing Docstrings] UNet2DConditionModel
5 participants