[community] Load Models from Sources like `Civitai` into Existing Pipelines by suzukimain · Pull Request #9986 · huggingface/diffusers

suzukimain · 2024-11-21T16:59:52Z

What does this PR do?

This PR adds an example that allows you to search for models from Civitai and Hugging Face by simply entering a keyword and loading models that meet the criteria into existing pipelines.

Example

!wget https://raw.githubusercontent.com/suzukimain/auto_diffusers/refs/heads/master/src/auto_diffusers/pipeline_easy.py

from pipeline_easy import (
    EasyPipelineForText2Image,
    EasyPipelineForImage2Image,
    EasyPipelineForInpainting,
)

# Search for Civitai
pipeline = EasyPipelineForText2Image.from_civitai(
    "search_word",
    base_model="SD 1.5",
).to("cuda")


# Search for Hugging Face
pipeline = EasyPipelineForText2Image.from_huggingface(
    "search_word",
    checkpoint_format="diffusers",
).to("cuda")

Before submitting

This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
Did you read the contributor guideline?
Did you read our philosophy doc (important for complex PRs)?
Was this discussed/approved via a GitHub issue or the forum? Please add a link to it if that's the case.
Did you make sure to update the documentation with your changes? Here are the
documentation guidelines, and
here are tips on formatting docstrings.
Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

bghira · 2024-11-22T19:11:51Z

can it use AIR IDs to import them? thanks for this example!

edit: the fact that model API responses has the model type in it we could even do AutoPipeline.from_civitai(air=model_air) kind of thing.

stevhliu

Nice, really cool and convenient functionality!

examples/model_search/README.md

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

HuggingFaceDocBuilderDev · 2024-12-03T15:55:06Z

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.

suzukimain · 2024-12-04T13:01:00Z

I was mostly done reflecting the changes.
However, I was not sure how to do these parts.
cc: @stevhliu

diffusers/examples/model_search/README.md

Line 118 in 745d4d0

    
           | model_type      | string                 | `Checkpoint`  | The type of model to search for.  <br>(for example `Checkpoint`, `TextualInversion`, `Controlnet`, `LORA`, `Hypernetwork`, `AestheticGradient`, `Poses`)      |

diffusers/examples/model_search/README.md

Line 148 in 745d4d0

    
           | checkpoint_format     | string              | `single_file`  | The format of the model checkpoint.<br>● `single_file` to search for `single file checkpoint` <br>●`diffusers` to search for `multifolder diffusers format checkpoint` |

stevhliu

Thanks! Just a few more formatting things :)

examples/model_search/README.md

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

suzukimain · 2024-12-04T23:55:01Z

Fixed. Please confirm. cc:@stevhliu

stevhliu

Cool, thanks so much for your project 🤗

Can you run make style to fix the failing CI test?

suzukimain · 2024-12-06T04:51:04Z

hi, @stevhliu Corrected

suzukimain · 2024-12-06T13:03:54Z

Corrected pipeline style.

…elines (#9986) * Added example of model search. * Combine processing into one file * Add parameters for base model * Bug Fixes * bug fix * Create README.md * Update search_for_civitai_and_HF.py * Create requirements.txt * bug fix * Update README.md * bug fix * Correction of typos * Update examples/model_search/README.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update examples/model_search/README.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update examples/model_search/README.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update examples/model_search/README.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update examples/model_search/README.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update examples/model_search/README.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * apply the changes * Replace search_for_civitai_and_HF.py with pipeline_easy.py * Update examples/model_search/README.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update examples/model_search/README.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update examples/model_search/README.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update README.md * Organize the table of parameters * Update README.md * Update README.md * Update README.md * make style * Fixing the style of pipeline * Fix pipeline style * fix --------- Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

suzukimain and others added 11 commits November 21, 2024 06:27

Added example of model search.

8924b57

Combine processing into one file

3e158b3

Add parameters for base model

ca50857

Bug Fixes

28352b0

bug fix

76b32da

Create README.md

17e38b0

Update search_for_civitai_and_HF.py

aac8073

Create requirements.txt

6c3c259

Merge branch 'huggingface:main' into ModelSearch

61aa2aa

bug fix

5202bb1

Update README.md

13a66bb

suzukimain mentioned this pull request Nov 21, 2024

Update version of huggingface-hub from 0.23.2 to 0.26.2 #9969

Closed

6 tasks

suzukimain added 3 commits November 22, 2024 07:47

bug fix

920876d

Correction of typos

d953d7f

Merge branch 'main' into ModelSearch

36d34a6

suzukimain mentioned this pull request Nov 24, 2024

[Pipeline] Enhancements to AutoPipeline #10006

Closed

6 tasks

sayakpaul requested a review from stevhliu November 28, 2024 10:52

stevhliu reviewed Dec 2, 2024

View reviewed changes

suzukimain and others added 6 commits December 3, 2024 11:27

Update examples/model_search/README.md

4b02904

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

Update examples/model_search/README.md

994fe95

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

Update examples/model_search/README.md

65372d4

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

Update examples/model_search/README.md

ab76aa4

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

Update examples/model_search/README.md

341f3a3

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

Update examples/model_search/README.md

05594cc

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

suzukimain and others added 3 commits December 4, 2024 21:22

apply the changes

241c943

Replace search_for_civitai_and_HF.py with pipeline_easy.py

43d936a

Merge branch 'main' into ModelSearch

745d4d0

stevhliu reviewed Dec 4, 2024

View reviewed changes

suzukimain and others added 7 commits December 5, 2024 07:26

Update examples/model_search/README.md

4f3d4b0

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

Update examples/model_search/README.md

8b2e3e6

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

Update examples/model_search/README.md

2e32020

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

Update README.md

68000fa

Organize the table of parameters

cd70647

Update README.md

c9e87b8

Update README.md

b10a55a

suzukimain added 2 commits December 5, 2024 08:55

Merge branch 'main' into ModelSearch

c3e51e6

Update README.md

026202c

stevhliu approved these changes Dec 5, 2024

View reviewed changes

suzukimain and others added 2 commits December 6, 2024 12:54

Merge branch 'huggingface:main' into ModelSearch

ac1c3e1

make style

efe5fba

suzukimain and others added 4 commits December 6, 2024 19:18

Fixing the style of pipeline

5df8f99

Fix pipeline style

4ff6e38

fix

5e92b8e

Merge branch 'main' into ModelSearch

54fd90e

stevhliu merged commit 6394d90 into huggingface:main Dec 6, 2024
8 checks passed

suzukimain deleted the ModelSearch branch January 13, 2026 04:44

Conversation

suzukimain commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Before submitting

Who can review?

Uh oh!

bghira commented Nov 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stevhliu 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!

HuggingFaceDocBuilderDev commented Dec 3, 2024

Uh oh!

suzukimain commented Dec 4, 2024

Uh oh!

stevhliu 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!

suzukimain commented Dec 4, 2024

Uh oh!

stevhliu 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!

suzukimain commented Dec 6, 2024

Uh oh!

suzukimain commented Dec 6, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

suzukimain commented Nov 21, 2024 •

edited

Loading

bghira commented Nov 22, 2024 •

edited

Loading

stevhliu left a comment •

edited

Loading