[docs] update philosophy.md (finally) by yiyixuxu · Pull Request #13808 · huggingface/diffusers · GitHub
Skip to content

[docs] update philosophy.md (finally)#13808

Merged
yiyixuxu merged 3 commits into
mainfrom
philosophy-refresh
Jun 5, 2026
Merged

[docs] update philosophy.md (finally)#13808
yiyixuxu merged 3 commits into
mainfrom
philosophy-refresh

Conversation

@yiyixuxu

@yiyixuxu yiyixuxu commented May 26, 2026

Copy link
Copy Markdown
Collaborator

in this PR, I

  1. removed stuff that's no longer true in our philosophy file, mostly single-file related
  2. add a mention on modular pipelines

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>
@github-actions github-actions Bot added documentation Improvements or additions to documentation size/S PR with diff < 50 LOC labels May 26, 2026
@yiyixuxu yiyixuxu requested review from DN6, dg845, sayakpaul and stevhliu May 26, 2026 05:59
@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

Comment thread docs/source/en/conceptual/philosophy.md Outdated

@stevhliu stevhliu left a comment

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.

thanks for the update!

Comment thread docs/source/en/conceptual/philosophy.md Outdated
Comment thread docs/source/en/conceptual/philosophy.md Outdated
Comment thread docs/source/en/conceptual/philosophy.md Outdated
Comment thread docs/source/en/conceptual/philosophy.md Outdated
Comment thread docs/source/en/conceptual/philosophy.md Outdated
Comment thread docs/source/en/conceptual/philosophy.md Outdated
Comment thread docs/source/en/conceptual/philosophy.md Outdated
Comment thread docs/source/en/conceptual/philosophy.md Outdated
Comment thread docs/source/en/conceptual/philosophy.md Outdated
Comment thread docs/source/en/conceptual/philosophy.md Outdated
yiyixuxu and others added 2 commits June 4, 2026 14:47
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@yiyixuxu yiyixuxu merged commit 5d10b4d into main Jun 5, 2026
7 checks passed
@yiyixuxu yiyixuxu deleted the philosophy-refresh branch June 5, 2026 00:59
yiyixuxu added a commit that referenced this pull request Jun 15, 2026
* 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>
DN6 pushed a commit that referenced this pull request Jul 1, 2026
* [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>
DN6 pushed a commit that referenced this pull request Jul 1, 2026
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/S PR with diff < 50 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants