Repository navigation
Update the README and add architecture documentation - #7
Merged
Merged
Conversation
The README still described the project as two nodes for SDXL and FLUX, told readers to "choose either", and showed an info example predating the architecture line. It also stated the wrong licence. README: - Lead with the three nodes and when to use each, rather than bolting the Universal loader onto a two-node description. - Refresh the info example to a real one, including the architecture/stacks line, and explain every column. - Add a Troubleshooting section covering the cases the node can now report: nodes missing from the menu, the mismatch warning, a LoRA that matches nothing, a high Other Tensors count, and divergence from the built-in LoraLoader. - Note that the SDXL node also covers SD1.5 and SD2. - Separate architectures actually verified from those supported by the same mechanism but not exercised, rather than implying one list. - Correct the licence to Apache-2.0; the README claimed GPL-3.0. - Move the changelog to CHANGELOG.md, which was 90 of the README's 250 lines. docs/ARCHITECTURE.md is new and covers why classification runs on the canonical target key rather than the LoRA's own names, why stack matching uses the raw dotted key instead of the normalised one, how runtime stack discovery and the depth axis work, and how to add an architecture or a family -- including the widget-order compatibility contract that is easy to break silently. Every factual claim in both documents was checked against the code: the FLUX and SDXL block range tables, the Universal block list, the preset names, the documented stack names against STACK_ORDER, the test count, and all internal links and anchors. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TUT2wQ8UsjNgosRWu6jvpj
BobsBlazed
marked this pull request as ready for review
August 12, 2026 02:21
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Documentation only — no code changes.
Why
The README had drifted behind three releases. It described the project as two nodes for SDXL and FLUX, told readers to "choose either SDXL or FLUX", showed an
infoexample predating the architecture line added in 1.2.0, and stated the wrong licence (GPL-3.0; the repo is Apache-2.0).README
infoexample — a real one, including thearchitecture: QwenImage transformer_blocks[60]line, with every column explained.Other Tensorscount, and divergence from the built-inLoraLoader.CHANGELOG.md— it was 90 of the README's 250 lines and growing one section per release.docs/ARCHITECTURE.md(new)The design knowledge behind the current implementation, so it doesn't have to be re-derived:
(key, offset)tuples for fused weights (534 of them in a real FLUX key map), and model/CLIP routing without name guessing.joint_blocks.-1.Verification
Every factual claim in both documents was checked against the code rather than written from memory: both FLUX block-range tables, the Universal and SDXL block lists, the preset names, all documented stack names against
STACK_ORDER, the test count, and all internal links and anchors.That check is what caught the licence error and the over-broad architecture list.
Note on versioning
No version bump —
publish.ymlonly fires onpyproject.tomlchanges, so this won't republish to the registry. The registry keeps 1.2.1's README snapshot until the next code release. Happy to bump to 1.2.2 if you'd rather the registry listing update now.Generated by Claude Code