Skip to content

Fix some documentation in ./src/diffusers/models/embeddings.py for demo#9579

Merged
yiyixuxu merged 14 commits intohuggingface:mainfrom
DTG2005:main
Dec 3, 2024
Merged

Fix some documentation in ./src/diffusers/models/embeddings.py for demo#9579
yiyixuxu merged 14 commits intohuggingface:mainfrom
DTG2005:main

Conversation

@DTG2005
Copy link
Contributor

@DTG2005 DTG2005 commented Oct 4, 2024 •
edited
Loading

What does this PR do?

Fixes #9567

Before submitting

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.

a-r-r-o-w
a-r-r-o-w reviewed Oct 4, 2024
View reviewed changes
Copy link
Contributor

@a-r-r-o-w a-r-r-o-w left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! Just some minor improvement suggestions. Will be good to merge after that

DTG2005 and others added 4 commits October 8, 2024 19:26
@DTG2005 @a-r-r-o-w
Update src/diffusers/models/embeddings.py
60eee1f 
Co-authored-by: Aryan <contact.aryanvs@gmail.com>
@DTG2005 @a-r-r-o-w
Update src/diffusers/models/embeddings.py
ed2cf8c 
Co-authored-by: Aryan <contact.aryanvs@gmail.com>
@DTG2005 @a-r-r-o-w
Update src/diffusers/models/embeddings.py
493c49b 
Co-authored-by: Aryan <contact.aryanvs@gmail.com>
@DTG2005 @a-r-r-o-w
Update src/diffusers/models/embeddings.py
697ecec 
Co-authored-by: Aryan <contact.aryanvs@gmail.com>
DTG2005
DTG2005 commented Oct 8, 2024
View reviewed changes
Copy link
Contributor Author

@DTG2005 DTG2005 left a comment

Choose a reason for hiding this comment

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

Reviewed! I'll remember the convention and follow the same when submitting future PRs!

a-r-r-o-w
a-r-r-o-w approved these changes Oct 9, 2024
View reviewed changes
Copy link
Contributor

@a-r-r-o-w a-r-r-o-w left a comment

Choose a reason for hiding this comment

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

One last thing, could you run make style to fix the quality tests?

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Oct 9, 2024

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.

@a-r-r-o-w
Copy link
Contributor

a-r-r-o-w commented Oct 15, 2024

Gentle ping to run make style and push the changes @DTG2005

@DTG2005
Copy link
Contributor Author

DTG2005 commented Oct 15, 2024

Sorry for the late response, there was some college work piled up.

So while running the same after eliminating certain errors, and then some, this output is printed

ruff check examples scripts src tests utils benchmarks setup.py --fix
All checks passed!
ruff format examples scripts src tests utils benchmarks setup.py
15 files reformatted, 1081 files left unchanged
doc-builder style src/diffusers docs/source --max_len 119
make: doc-builder: No such file or directory
make: *** [Makefile:59: style] Error 127

Is this correct or should I fix some more things before I push?

@a-r-r-o-w
Copy link
Contributor

a-r-r-o-w commented Oct 15, 2024

I believe that should be all, thanks!

@github-actions
Copy link
Contributor

github-actions bot commented Nov 11, 2024

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

@github-actions github-actions bot added the stale Issues that haven't received updates label Nov 11, 2024
@yiyixuxu yiyixuxu added close-to-merge and removed stale Issues that haven't received updates labels Dec 3, 2024
@yiyixuxu yiyixuxu merged commit fc72e0f into huggingface:main Dec 3, 2024
@yiyixuxu
Copy link
Collaborator

yiyixuxu commented Dec 3, 2024

thank you!

lawrence-cj pushed a commit to lawrence-cj/diffusers that referenced this pull request Dec 4, 2024
@DTG2005 @a-r-r-o-w
@yiyixuxu @lawrence-cj
Fix some documentation in ./src/diffusers/models/embeddings.py for de…
3b7c5aa 
…mo (huggingface#9579)

* Fix some documentation in ./src/diffusers/models/embeddings.py as demonstration.


---------

Co-authored-by: DaAccursed05 <68813178+DaAccursed05@users.noreply.github.com>
Co-authored-by: Aryan <contact.aryanvs@gmail.com>
Co-authored-by: Aryan <aryan@huggingface.co>
Co-authored-by: YiYi Xu <yixu310@gmail.com>
sayakpaul pushed a commit that referenced this pull request Dec 23, 2024
@DTG2005 @a-r-r-o-w
@yiyixuxu @sayakpaul
Fix some documentation in ./src/diffusers/models/embeddings.py for de…
598c252 
…mo (#9579)

* Fix some documentation in ./src/diffusers/models/embeddings.py as demonstration.


---------

Co-authored-by: DaAccursed05 <68813178+DaAccursed05@users.noreply.github.com>
Co-authored-by: Aryan <contact.aryanvs@gmail.com>
Co-authored-by: Aryan <aryan@huggingface.co>
Co-authored-by: YiYi Xu <yixu310@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@a-r-r-o-w a-r-r-o-w a-r-r-o-w approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[community] Improving docstrings and type hints

4 participants

@DTG2005 @HuggingFaceDocBuilderDev @a-r-r-o-w @yiyixuxu