[docs] add docstrings in `pipline_stable_diffusion.py` by jeongiin · Pull Request #9590 · huggingface/diffusers · GitHub
Skip to content

[docs] add docstrings in pipline_stable_diffusion.py - #9590

Merged
stevhliu merged 19 commits into
huggingface:mainfrom
jeongiin:pipline_stable_diffusion
Oct 21, 2024
Merged

[docs] add docstrings in pipline_stable_diffusion.py#9590
stevhliu merged 19 commits into
huggingface:mainfrom
jeongiin:pipline_stable_diffusion

Conversation

@jeongiin

@jeongiin jeongiin commented Oct 5, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

What does this PR do?

Fixes : #9567

I have added a docstring to the rescale_noise_cfg function. I plan to continue addressing this issue, and I would greatly appreciate any advice you could offer on writing effective commit messages or PRs. Thank you!

ps. I've worked on other tasks as well, so there are many commit messages, but only one file was actually changed.

Before submitting

Who can review?

@a-r-r-o-w @stevhliu

stevhliu
stevhliu approved these changes Oct 7, 2024
View reviewed changes

@stevhliu stevhliu left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice job!

Run make style to automatically format the code so the CI test passes :)

Comment thread src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion.py Outdated
@HuggingFaceDocBuilderDev

HuggingFaceDocBuilderDev commented Oct 7, 2024

Copy link
Copy Markdown

jeongiin and others added 2 commits October 9, 2024 00:19
@a-r-r-o-w

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

Copy link
Copy Markdown
Contributor

Hi @jeongiin, just need to run make style and push changes here to be ready for merge I think

@jeongiin

jeongiin commented Oct 9, 2024

Copy link
Copy Markdown
Contributor Author

Hello @a-r-r-o-w and @stevhliu I fixed style!

@stevhliu

stevhliu commented Oct 9, 2024

Copy link
Copy Markdown
Member

Thanks! Can you also run make fix-copies to align all the # Copied from statements?

@jeongiin

jeongiin commented Oct 10, 2024

Copy link
Copy Markdown
Contributor Author

Thanks for catching that!! @stevhliu

@stevhliu

stevhliu commented Oct 10, 2024

Copy link
Copy Markdown
Member

Hmm, the copy inconsistencies are still there for some reason. Can you try running python utils/check_copies.py --fix_and_overwrite instead?

@jeongiin

jeongiin commented Oct 12, 2024

Copy link
Copy Markdown
Contributor Author

I've tried running python utils/check_copies.py --fix_and_overwrite, but nothing happens to the problematic file. Could you suggest another solution? :(

@stevhliu

stevhliu commented Oct 15, 2024

Copy link
Copy Markdown
Member

Hmm, I'm not entirely sure then! Running those commands and pushing their changes should fix the tests. @sayakpaul do you have another suggestion?

@sayakpaul

sayakpaul commented Oct 16, 2024

Copy link
Copy Markdown
Member

We need to apply make fix-copies to fix the errors.

@a-r-r-o-w

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

Copy link
Copy Markdown
Contributor

@stevhliu @sayakpaul good to merge?

@sayakpaul

sayakpaul commented Oct 16, 2024

Copy link
Copy Markdown
Member

Okay for me!

@stevhliu
stevhliu merged commit bcd61fd into huggingface:main Oct 21, 2024
@HanLiii

HanLiii commented Oct 25, 2024

Copy link
Copy Markdown

Will pipeline_animatediff_sdxl_video2video.py be released in the future?

@a-r-r-o-w

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

Copy link
Copy Markdown
Contributor

sayakpaul added a commit that referenced this pull request Dec 23, 2024
@jeongiin @stevhliu
@a-r-r-o-w @sayakpaul
[docs] add docstrings in pipline_stable_diffusion.py (#9590)
898a5e4 
* fix the issue on flux dreambooth lora training

* update : origin main code

* docs: update pipeline_stable_diffusion docstring

* docs: update pipeline_stable_diffusion docstring

* Update src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion.py

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* fix: style

* fix: style

* fix: copies

* make fix-copies

* remove extra newline

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Aryan <aryan@huggingface.co>
Co-authored-by: Sayak Paul <spsayakpaul@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stevhliu stevhliu stevhliu approved these changes

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

6 participants

@jeongiin @HuggingFaceDocBuilderDev @a-r-r-o-w @stevhliu @sayakpaul @HanLiii