-
Notifications
You must be signed in to change notification settings - Fork 7.2k
Auto-reply to new model requests with remote code guidance #14343
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
Open
yiyixuxu
wants to merge
9
commits into
main
Choose a base branch
from
new-model-request-auto-reply
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+49
−3
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
a46db13
Auto-reply to new model requests with Modular Diffusers guidance
yiyixuxu a6a9f7c
Apply suggestion from @yiyixuxu
yiyixuxu 647f918
Tighten the new model request reply
yiyixuxu 8062541
Link the Modular Pipelines collection in the reply
yiyixuxu c8d4045
Recommend starting on the Hub for new models
yiyixuxu fbe02f1
Apply suggestion from @yiyixuxu
yiyixuxu 40e46f5
Apply suggestion from @yiyixuxu
yiyixuxu b818414
Update .github/workflows/new_model_request_reply.yml
yiyixuxu 12b55ad
Consolidate the Hub-first guidance into one place
yiyixuxu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: New Model Request Reply | ||
|
|
||
| on: | ||
| issues: | ||
| types: [opened] | ||
|
|
||
| jobs: | ||
| reply: | ||
| name: Point new model requests at Modular Diffusers | ||
| # Match the heading the issue form renders for its first field rather than a label: template | ||
| # labels are applied after the issue is created, so `github.event.issue.labels` is empty here. | ||
| # Keep this string in sync with .github/ISSUE_TEMPLATE/new-model-addition.yml. | ||
| if: >- | ||
| github.repository == 'huggingface/diffusers' && | ||
| contains(github.event.issue.body, '### Model/Pipeline/Scheduler description') | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| issues: write | ||
| steps: | ||
| - name: Post Modular Diffusers guidance | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| GH_REPO: ${{ github.repository }} | ||
| ISSUE_NUMBER: ${{ github.event.issue.number }} | ||
| BODY: | | ||
| Thanks for the request! | ||
|
|
||
| **How new model support works in Diffusers** | ||
|
|
||
| We're a small team, and our review queue shouldn't be what decides whether a model is usable in Diffusers. With [Modular Diffusers](https://huggingface.co/docs/diffusers/modular_diffusers/overview), a pipeline can live as remote code in any Hub repo and load straight from there with `from_pretrained`. | ||
|
|
||
| 🛠️ **Want to bring this model to Diffusers?** | ||
|
|
||
| Please start with a Hub repo — you don't need anything from us to do that, and people can use it immediately. From there we decide how to support it: we might work with the authors, upstream an existing community version, or just point people at the one on the Hub. The pipelines we integrate are usually the ones people are already running. | ||
|
|
||
| Tag `@asomoza` when you have something to share — we'll give feedback on the implementation, help get it in front of people, and add the ones we like to our hand-picked [Modular Pipelines](https://huggingface.co/collections/diffusers/modular-pipelines) collection. Tell us where you hit friction along the way, too: confusing APIs, missing docs, bugs. That feedback is worth as much to us as the pipeline. | ||
|
|
||
| 👋 **Are you an author of the model?** We'd love to hear from you — comment here and we'll help you pick the path that fits. | ||
|
|
||
| 📚 [Quickstart](https://huggingface.co/docs/diffusers/modular_diffusers/quickstart) · [Building custom blocks](https://huggingface.co/docs/diffusers/modular_diffusers/custom_blocks) — template repo, and how to publish to the Hub · [Modular Pipelines](https://huggingface.co/collections/diffusers/modular-pipelines) and [Custom Blocks](https://huggingface.co/collections/diffusers/modular-diffusers-custom-blocks) — examples to crib from | ||
|
|
||
| *This is an automated message.* | ||
| run: gh issue comment "$ISSUE_NUMBER" --body "$BODY" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.