* restructure guides as skill references
* reorganize AGENTS.md and references
* clean up
* clean up
* clean up
* fix AGENTS.md references and add check_ai to Makefile
* clean up
* update paths
* clean up
* Auto-reply to new model requests with Modular Diffusers guidance
Points new model/pipeline/scheduler requests at building a Hub-hosted
modular pipeline instead of waiting on a core PR, and asks requesters to
tag @asomoza when they have something to share.
Gates on the `### Model/Pipeline/Scheduler description` heading the issue
form renders rather than on a label: the label the template declares does
not exist in this repo, so GitHub never applies it, and template labels
land after issue creation anyway.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Apply suggestion from @yiyixuxu
* Tighten the new model request reply
Lead with starting on the Hub and frame what follows as a support
decision (work with the authors, upstream a community version, or point
people at the Hub one) rather than a soft no to PRs. Trims the message
by collapsing the author section and the resource list.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Link the Modular Pipelines collection in the reply
Community-built model pipelines belong in the Modular Pipelines
collection rather than Custom Blocks, so point the "we'll add the ones we
like" line there and keep both collections in the resource list.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Recommend starting on the Hub for new models
Adds a callout to the contribution guide asking model authors to get in
touch on a feature request, and community contributors to coordinate
there and start with a Hub repo at the same time.
Points agents the same way: default to publishing a modular pipeline as
remote code rather than opening a PR against src/diffusers.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Apply suggestion from @yiyixuxu
* Apply suggestion from @yiyixuxu
* Update .github/workflows/new_model_request_reply.yml
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Consolidate the Hub-first guidance into one place
stevhliu noted the new callout in "Adding pipelines, models, schedulers"
overlapped the last two paragraphs of the AI-assisted contributions
section. Drop the community-contributor paragraph there — it is general
contribution policy rather than agent-specific guidance — and point the
model-author paragraph at the callout instead. Carry the custom models
link over so the non-modular Hub path stays covered.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Require sharing self-review notes on PRs
The PR template's self-review checkbox is unverifiable on its own — make the
notes a required, shareable artifact:
- self-review skill: new step to save each round's report and post all rounds
on the PR (description or comment)
- contribution guide: sharing the notes is part of the AI-assisted
contribution workflow; a checked box without notes counts as not done
- PR template: checkbox for having shared the notes
- .ai/AGENTS.md: mention the notes-sharing step in the self-review section
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Share only the final self-review round, not all rounds
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Mention self-review notes in the PR template intro comment
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Soften notes-sharing ask; skill iterates until ready then reminds to share
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Apply suggestion from @yiyixuxu
* Point checkbox and guide at the self-review skill directly
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Note human review comments as a source for agent doc gaps
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
* Commit root AGENTS.md/CLAUDE.md symlinks so agents auto-load conventions
Track the root AGENTS.md/CLAUDE.md symlinks (-> .ai/AGENTS.md) instead of
generating them via `make claude`/`make codex`, so a fresh clone auto-loads
the agent guide with no setup step (matching transformers). The make targets
now only wire up skills; .ai/AGENTS.md, the contribution doc, and the PR
template are updated to match.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Add documentation-impact check to PR review rules
During review, scan related usage docs and agent docs and flag (advisory)
any that should be updated based on the PR — outdated/missing usage docs, or
a rule/pattern/gotcha worth recording in the agent guides.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* Make root PHILOSOPHY.md a symlink to the docs philosophy page
The root PHILOSOPHY.md had drifted into a stale duplicate of
docs/source/en/conceptual/philosophy.md (which was rewritten in #13808 to
cover the single-file model policy and Modular Diffusers). Replace it with a
symlink to the docs file, mirroring CONTRIBUTING.md -> contribution.md, so
there's a single source of truth.
A symlink renders as a path stub (not content) on GitHub, so repoint the
links that pointed at blob/main/PHILOSOPHY.md to the rendered docs site:
the PR template and the English contribution guide.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* Point contributor-guide links at the rendered docs site
CONTRIBUTING.md is a symlink, so blob/main/CONTRIBUTING.md renders as a path
stub on GitHub rather than the guide. Repoint the PR template and README
links to the rendered docs page, matching the philosophy/AI-agents links.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* Repoint remaining symlink-stub doc links to the rendered docs site
The stale-bot comment and the ko/zh contribution guides still linked to
blob/main/{CONTRIBUTING,PHILOSOPHY}.md, which render as path stubs because
those root files are symlinks. Point them at the rendered docs pages
(localized /ko/ and /zh/ for the translations).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
* [.ai] add self-review skill, retire parity-testing skill, and tighten the agent guides
- New `self-review` skill mirroring the `@claude` CI review (rubric from
review-rules.md, call-path dead-code analysis), report-only, with the report
flagging what to fix before submitting (blocking + dead code) vs what to leave
for the actual review.
- Remove the WIP `parity-testing` skill; preserve its pitfalls as
`model-integration/pitfalls.md` (numerical-discrepancy reference).
- model-integration: restructure around a grouped checklist, default-to-modular,
an overall file-structure sketch (details deferred to the guides), a
fresh-conversion `Model parity test` example (internal, not shipped), and a
filled-in weight/checkpoint-conversion section.
- Centralize the loading rule (from_pretrained / from_single_file, no custom
loaders) in models.md; add per-folder File structure sections to models.md /
pipelines.md; default-to-modular note in pipelines.md.
- AGENTS.md: dedicated 'Self-review before a PR' and 'Reference guides' sections.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* [.ai] simplify pitfalls #6 and drop the model-storage / injection-test entries
Trim pitfall #6 to the essential point (small dtype diffs compound into a large
final difference), remove the `/tmp` model-storage and incomplete-injection-test
pitfalls, and renumber 1-16 with cross-references updated.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* [.ai] drop parity-harness-specific pitfalls
With the parity-testing skill gone, remove the stale-test-fixtures pitfall (saved
tensors / cross-pipeline fixtures no longer apply) and de-jargon the noise-dtype
detection note. Keeps the pitfalls list generic to numerical discrepancy.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* [.ai] trim pitfalls to a concise possible-causes reference
Drop the variable-shadowing and decoder-config pitfalls and the noise-dtype
'Detection' aside, tighten the remaining entries, renumber 1-12 (cross-refs
updated), and reframe the intro as a non-checklist reference list of possible
causes to consult only when outputs don't match.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* Apply suggestion from @yiyixuxu
* Apply suggestion from @yiyixuxu
* [docs] update contributing guide for the self-review skill
Replace the retired parity-testing skill with self-review in the skills list, and
add a 'Self-review before opening' step to the AI-assisted contributions section:
run the self-review skill / review-rules, fix blocking issues + dead code, and
treat the @claude CI review as a non-authoritative helper (note any intentional
skips in the PR for the reviewer).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* Apply suggestions from code review
Co-authored-by: Sayak Paul <spsayakpaul@gmail.com>
* [.ai] fix dangling pitfalls ref and broaden self-review scope
- Drop the broken 'pitfalls.md #10' reference in the conversion step (the /tmp
model-storage pitfall was removed); save to a local path instead.
- Self-review now reviews the whole diff, not just src/diffusers/ and .ai/ — a
contributor should review their own tests/docs/scripts too (the CI's scoping is
a safety measure for untrusted PRs). Reword to 'same rubric as the CI'.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: Sayak Paul <spsayakpaul@gmail.com>
* [docs] refresh philosophy.md for current conventions
Update the framing to match how Diffusers actually works now: models
follow the single-file policy (with UNet/older transformers as legacy
exceptions, not the model), add a Modular Pipelines section parallel to
standard Pipelines, and slim Pipelines/Models bullets to remove stale
guidance (per-task pipeline subclassing, generic-class checkpoint
adaptation, dead links to deprecated repos).
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
* Update docs/source/en/conceptual/philosophy.md
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Apply suggestions from code review
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
---------
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* [docs] Replace runwayml/stable-diffusion-v1-5 with Lykon/dreamshaper-8
Updated documentation as runwayml/stable-diffusion-v1-5 has been removed from Huggingface.
* Update docs/source/en/using-diffusers/inpaint.md
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* Replace with stable-diffusion-v1-5/stable-diffusion-v1-5
* Update inpaint.md
---------
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
* first refactor
* more text
* improve
* finish
* up
* up
* up
* up
* finish
* Apply suggestions from code review
Co-authored-by: Sayak Paul <spsayakpaul@gmail.com>
Co-authored-by: YiYi Xu <yixu310@gmail.com>
* up
* Apply suggestions from code review
Co-authored-by: Pedro Cuenca <pedro@huggingface.co>
* finished
* Apply suggestions from code review
Co-authored-by: Pedro Cuenca <pedro@huggingface.co>
* finished
---------
Co-authored-by: Sayak Paul <spsayakpaul@gmail.com>
Co-authored-by: YiYi Xu <yixu310@gmail.com>
Co-authored-by: Pedro Cuenca <pedro@huggingface.co>
There isn't a space between the "Scope" paragraph and "Ethical Guidelines", here: https://huggingface.co/docs/diffusers/main/en/conceptual/ethical_guidelines , yet I can't see that in the preview. In this PR, I'm simply adding some spaces in the hopes that it resolves the issue.....
