Refactor Pipelines / Community pipelines and add better explanations. #257

patrickvonplaten · 2022-08-26T15:07:12Z

This PR takes a stab at better defining what our pipelines are and introduces community-pipelines as discussed with @anton-l @patil-suraj and @apolinario .

Would be happy about some in-detail feedback here. The PR still has some TODOs, but it would be nice to get a general review on the working which is more or less finished.

HuggingFaceDocBuilderDev · 2022-08-26T15:10:36Z

The documentation is not available anymore as the PR was closed or merged.

…example_readme

natolambert

I went through the added text and added comments. I haven't yet run the examples, but am happy to do that tomorrow if its useful / has not been verified!

natolambert · 2022-08-29T02:12:10Z

examples/README.md

+
+# 🧨 Diffusers Examples
+
+Diffusers examples are a collection of best-practices on how to use the `diffusers` library.


Is best-practices what we mean here? Maybe they're suggestions? Most-frequently used?
A somewhat strange first sentence imo.

examples/README.md

pcuenca

Great work! I just did a first pass and suggested some typo fixes or small wording changes.

src/diffusers/pipelines/README.md

pcuenca

Started looking at the code itself. One question so far is what's the intention for the scripts inside examples/inference, which are currently empty. If we should provide the code that's quoted in the README file I can do that if you want.

pcuenca · 2022-08-29T08:00:24Z

src/diffusers/pipelines/README.md

+
+### In-painting using Stable Diffusion
+
+The `inpainting.py` script implements `StableDiffusionInpaintingPipeline`. This script lets you edit specific parts of an image by providing a mask and text prompt.


Wasn't it renamed to StableDiffusionInpaintPipeline? See https://github.com/huggingface/diffusers/pull/257/files#diff-39d36ab1e622684e35fe6971c12fb44e24756bdc383aba3d7f6e3b1625bdaafcR40

src/diffusers/pipelines/README.md

src/diffusers/pipelines/stable_diffusion/__init__.py

Co-authored-by: Nathan Lambert <nathan@huggingface.co> Co-authored-by: Pedro Cuenca <pedro@huggingface.co>

…example_readme

src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_inpaint.py

…sers into example_readme

…sion_inpaint.py Co-authored-by: Anton Lozhkov <anton@huggingface.co>

src/diffusers/models/vae.py

src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_img2img.py

tests/test_pipelines.py

anton-l

LGTM! 🚀
Nit: the community folder is now on the same level as individual training examples, so it might get lost there in the future (obviously not a problem for now).

README.md

src/diffusers/pipelines/README.md

patil-suraj

Thanks a lot @patrickvonplaten for working on this ❤️ .
Just left some nits, LGTM!

README.md

examples/README.md

src/diffusers/pipelines/README.md

src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_img2img.py

src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_inpaint.py

src/diffusers/pipelines/stable_diffusion/readme.md

tests/test_pipelines.py

pcuenca

Amazing work! I think everything's much clearer now!

examples/README.md

src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_inpaint.py

src/diffusers/pipelines/stable_diffusion/readme.md

tests/test_pipelines.py

Co-authored-by: Suraj Patil <surajp815@gmail.com> Co-authored-by: Pedro Cuenca <pedro@huggingface.co>

Co-authored-by: Suraj Patil <surajp815@gmail.com>

Co-authored-by: Pedro Cuenca <pedro@huggingface.co> Co-authored-by: Suraj Patil <surajp815@gmail.com> Co-authored-by: Anton Lozhkov <anton@huggingface.co>

Co-authored-by: Suraj Patil <surajp815@gmail.com>

…sers into example_readme

DustinWehr · 2022-09-05T14:43:11Z

Will this be in v0.2.5? If so, any guess of when? Thanks!

patil-suraj · 2022-09-06T07:03:42Z

@DustinWehr we are planning to do a release soon, maybe this week.

…#257) * [Examples readme] * Improve * more * save * save * save more * up * up * Apply suggestions from code review Co-authored-by: Nathan Lambert <nathan@huggingface.co> Co-authored-by: Pedro Cuenca <pedro@huggingface.co> * up * make deterministic * up * better * up * add generator to img2img pipe * save * make pipelines deterministic * Update src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_inpaint.py Co-authored-by: Anton Lozhkov <anton@huggingface.co> * apply all changes * more correctnios * finish * improve table * more fixes * up * Apply suggestions from code review Co-authored-by: Suraj Patil <surajp815@gmail.com> Co-authored-by: Pedro Cuenca <pedro@huggingface.co> * Apply suggestions from code review Co-authored-by: Suraj Patil <surajp815@gmail.com> * Apply suggestions from code review Co-authored-by: Suraj Patil <surajp815@gmail.com> * Apply suggestions from code review Co-authored-by: Pedro Cuenca <pedro@huggingface.co> Co-authored-by: Suraj Patil <surajp815@gmail.com> Co-authored-by: Anton Lozhkov <anton@huggingface.co> * Update src/diffusers/pipelines/README.md Co-authored-by: Suraj Patil <surajp815@gmail.com> * add better links * fix more * finish Co-authored-by: Nathan Lambert <nathan@huggingface.co> Co-authored-by: Pedro Cuenca <pedro@huggingface.co> Co-authored-by: Anton Lozhkov <anton@huggingface.co> Co-authored-by: Suraj Patil <surajp815@gmail.com>

…huggingface#257) * [Examples readme] * Improve * more * save * save * save more * up * up * Apply suggestions from code review Co-authored-by: Nathan Lambert <nathan@huggingface.co> Co-authored-by: Pedro Cuenca <pedro@huggingface.co> * up * make deterministic * up * better * up * add generator to img2img pipe * save * make pipelines deterministic * Update src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_inpaint.py Co-authored-by: Anton Lozhkov <anton@huggingface.co> * apply all changes * more correctnios * finish * improve table * more fixes * up * Apply suggestions from code review Co-authored-by: Suraj Patil <surajp815@gmail.com> Co-authored-by: Pedro Cuenca <pedro@huggingface.co> * Apply suggestions from code review Co-authored-by: Suraj Patil <surajp815@gmail.com> * Apply suggestions from code review Co-authored-by: Suraj Patil <surajp815@gmail.com> * Apply suggestions from code review Co-authored-by: Pedro Cuenca <pedro@huggingface.co> Co-authored-by: Suraj Patil <surajp815@gmail.com> Co-authored-by: Anton Lozhkov <anton@huggingface.co> * Update src/diffusers/pipelines/README.md Co-authored-by: Suraj Patil <surajp815@gmail.com> * add better links * fix more * finish Co-authored-by: Nathan Lambert <nathan@huggingface.co> Co-authored-by: Pedro Cuenca <pedro@huggingface.co> Co-authored-by: Anton Lozhkov <anton@huggingface.co> Co-authored-by: Suraj Patil <surajp815@gmail.com>

[Examples readme]

98e57e6

patrickvonplaten added 9 commits August 26, 2022 17:11

Merge branch 'main' of https://github.com/huggingface/diffusers into …

e8fe1bc

…example_readme

Improve

6a902a9

more

5df441e

Merge branch 'main' of https://github.com/huggingface/diffusers into …

51b9dee

…example_readme

save

04e2a9d

save

f2ee1fa

save more

5a1c49c

up

c90c8d0

up

036d00b

patrickvonplaten changed the title ~~[Examples readme]~~ Refactor Pipelines / Community pipelines and add better explanations. Aug 26, 2022

patrickvonplaten requested review from anton-l, apolinario, natolambert, osanseviero, patil-suraj and pcuenca August 26, 2022 21:17

natolambert reviewed Aug 29, 2022

View reviewed changes

pcuenca reviewed Aug 29, 2022

View reviewed changes

patrickvonplaten and others added 2 commits August 29, 2022 11:02

Apply suggestions from code review

62adb64

Co-authored-by: Nathan Lambert <nathan@huggingface.co> Co-authored-by: Pedro Cuenca <pedro@huggingface.co>

Merge branch 'main' of https://github.com/huggingface/diffusers into …

b4f44d7

…example_readme

anton-l reviewed Aug 29, 2022

View reviewed changes

src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_inpaint.py Outdated Show resolved Hide resolved

patrickvonplaten added 6 commits August 29, 2022 19:26

up

fa0a5dc

make deterministic

d7c2ca8

Merge branch 'example_readme' of https://github.com/huggingface/diffu…

7524f76

…sers into example_readme

up

5eafc4f

Merge branch 'example_readme' of https://github.com/huggingface/diffu…

d5b4c62

…sers into example_readme

better

bfebb41

patrickvonplaten and others added 4 commits August 30, 2022 11:19

correct

be1ea60

Update src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffu…

6338a91

…sion_inpaint.py Co-authored-by: Anton Lozhkov <anton@huggingface.co>

apply all changes

eff421b

more correctnios

b73e0a1

patrickvonplaten commented Aug 30, 2022

View reviewed changes

src/diffusers/models/vae.py Show resolved Hide resolved

patrickvonplaten commented Aug 30, 2022

View reviewed changes

src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_img2img.py Show resolved Hide resolved

patrickvonplaten commented Aug 30, 2022

View reviewed changes

tests/test_pipelines.py Show resolved Hide resolved

patrickvonplaten added 4 commits August 30, 2022 12:16

finish

d8bcdd6

improve table

102eb97

more fixes

e3238c0

up

dbd9489

anton-l approved these changes Aug 30, 2022

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

src/diffusers/pipelines/README.md Outdated Show resolved Hide resolved

src/diffusers/pipelines/README.md Show resolved Hide resolved

patil-suraj approved these changes Aug 30, 2022

View reviewed changes

pcuenca approved these changes Aug 30, 2022

View reviewed changes

patrickvonplaten and others added 9 commits August 30, 2022 18:22

Apply suggestions from code review

b78467a

Co-authored-by: Suraj Patil <surajp815@gmail.com> Co-authored-by: Pedro Cuenca <pedro@huggingface.co>

Apply suggestions from code review

914c7c0

Co-authored-by: Suraj Patil <surajp815@gmail.com>

Apply suggestions from code review

f9f39f4

Co-authored-by: Suraj Patil <surajp815@gmail.com>

Apply suggestions from code review

36dd1a8

Co-authored-by: Pedro Cuenca <pedro@huggingface.co> Co-authored-by: Suraj Patil <surajp815@gmail.com> Co-authored-by: Anton Lozhkov <anton@huggingface.co>

Update src/diffusers/pipelines/README.md

e076f99

Co-authored-by: Suraj Patil <surajp815@gmail.com>

add better links

8c5d071

Merge branch 'example_readme' of https://github.com/huggingface/diffu…

79ba4c6

…sers into example_readme

fix more

2f5b6b3

finish

02c85e0

patrickvonplaten merged commit a4d5b59 into main Aug 30, 2022

patrickvonplaten deleted the example_readme branch August 30, 2022 16:43

patrickvonplaten mentioned this pull request Sep 3, 2022

[Img2Img2] Re-add K LMS scheduler #340

Merged


		# 🧨 Diffusers Examples

		Diffusers examples are a collection of best-practices on how to use the `diffusers` library.


		### In-painting using Stable Diffusion

		The `inpainting.py` script implements `StableDiffusionInpaintingPipeline`. This script lets you edit specific parts of an image by providing a mask and text prompt.

Refactor Pipelines / Community pipelines and add better explanations. #257

Refactor Pipelines / Community pipelines and add better explanations. #257

Uh oh!

Conversation

patrickvonplaten commented Aug 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

HuggingFaceDocBuilderDev commented Aug 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

natolambert left a comment

Choose a reason for hiding this comment

Uh oh!

natolambert Aug 29, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pcuenca left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pcuenca left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pcuenca Aug 29, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anton-l left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

patil-suraj left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pcuenca left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

patrickvonplaten commented Aug 26, 2022 •

edited

Loading

HuggingFaceDocBuilderDev commented Aug 26, 2022 •

edited

Loading

pcuenca left a comment •

edited

Loading

DustinWehr commented Sep 5, 2022 •

edited

Loading