Skip to content
This repository was archived by the owner on Oct 4, 2026. It is now read-only.

docs: document model, quantization and upscale changes from recent PRs - #381

Merged
Pfannkuchensack merged 5 commits into
upstream-mergefrom
docs/v7-doc-gaps
Oct 1, 2026
Merged

Pfannkuchensack merged 5 commits into
upstream-mergefrom
docs/v7-doc-gaps

Conversation

@Pfannkuchensack

Copy link
Copy Markdown
Member

Summary

Several recent merged PRs changed behaviour that the docs either did not describe or described incorrectly. The FP8 Storage page was the most out of date: it still said Wan ignores the setting, that the toggle is "silently a no-op" for quantized formats, that the exit hook casts back to fp8, and that only CUDA qualifies. This PR is stacked on #377 and uses its new page layout.

User guide:

Contributor docs:

  • New model integration guide:
    • Prefix stripping for detection and for loaders.
    • Reserving once: install_int8_convrot_layers makes its own reservation.
    • reject_quantized_side_channel.
    • Declaring FP8 Storage support with Unimplemented/NotApplicable.
    • Adding vendored encoder assets to package-data.
  • Removed development/Guides/models.mdx: it duplicated the integration guide with webv1 paths. Its URL now redirects to the guide.

Config descriptions:

  • force_tiled_decode no longer says "as of this release"; it lists the families that read it and says it also tiles encodes.
  • fp8_compute covers ROCm GPUs that pass the matmul probe, and no longer credits itself alone with the VRAM saving.
  • docs/src/generated/settings.json regenerated.

Related Issues / Discussions

QA Instructions

From docs/:

  • pnpm build: passes, "All internal links are valid." Also passes with DEPLOY_TARGET=ghpages.
  • pnpm run check-deploy-output: passes for both targets.
  • pnpm run check-redirects: 88 redirect targets validated.
  • uv run --no-sync python ../scripts/generate_docs_json.py: settings.json matches the committed file.

From the repo root:

  • uv tool run ruff@0.11.2 check and format --check on config_default.py: clean.
  • uv run --no-sync pytest tests/test_config.py: 48 passed.

Checked in a local preview: the Upscaling, FP8 Storage, Krea-2, Models introduction and System Requirements pages, including tables, the sidebar position of the new page, and anchors.

Every factual claim was checked against the code on this branch: loader declarations, node fields and titles, UI strings in en.json, the webv2 upscale graph, and starter model entries. Figures come from the measurements in the linked PRs.

Note for anyone running pnpm run generate-docs-data: it calls uv run without --no-sync. That re-syncs the virtualenv without extras and replaces an accelerator-specific torch build. This PR does not change the script.

Review

Findings resolved:

  • The Upscale page first described the FLUX.1 detail pass as tiled and listed the wrong contents for the panel's Advanced section. It now matches the graph and the widget.
  • force_tiled_decode was described as applying to every VAE. It now lists the families that read it.
  • The FP8 table missed SD3, CogView4, SDXL Refiner, ERNIE-Image, LTX-2, all FLUX.2 variants and SD2 ControlNet. It is now rebuilt from fp8_storage_support().
  • The fp8 rows in the SDNQ table said LoRAs patch directly. Layers holding fp8 weights always use sidecar patching.
  • Krea-2 sizes mixed transformer-only and total figures. The table is now transformer-only, and encoder sizes are listed separately.
  • Contributor guide: prefix stripping for detection versus loaders, and double reservation when using install_int8_convrot_layers.

Remaining limitations:

  • Ideogram 4 with a GGUF 8B encoder was not measured on hardware, so the page makes no fit claim for it.
  • The RAM minimums in the new system-requirements rows are estimates, like the rest of that table.

Checklist

  • The PR has a short but descriptive title, suitable for a changelog
  • Meaningful regression coverage added / updated where needed; obsolete tests/code removed
  • Persisted-state and API changes include required migrations / compatibility validation
  • Relevant performance/efficiency opportunities considered; material claims have evidence
  • Material review findings resolved and relevant checks rerun
  • Documentation added / updated (if applicable)
  • Updated What's New copy (if doing a release after this PR)

Covers FP8 Storage support per loader, quantized formats, ERNIE-Image, Krea-2 builds and GGUF encoders, the Upscale panel and tiled VAE settings.
Updates the contributor guide's loader rules, drops the stale models guide behind a redirect, and corrects the force_tiled_decode and fp8_compute descriptions.
Pfannkuchensack and others added 2 commits September 30, 2026 15:04
Other nvfp4 exports, such as AWQ builds, are refused at load; who publishes the file does not matter.
Base automatically changed from lstein/docs/v7-docs-update to upstream-merge October 1, 2026 20:35
…-gaps

Moves the quantized formats to Model Formats and Families, model identification under Advanced Topics, and the Ideogram 4 and ERNIE-Image additions to their new per-family pages.
Points the Ideogram 4 requirements link at its page and sorts Upscaling after Intermediates.
@Pfannkuchensack
Pfannkuchensack merged commit 899e1e5 into upstream-merge Oct 1, 2026
13 checks passed
@Pfannkuchensack
Pfannkuchensack deleted the docs/v7-doc-gaps branch October 1, 2026 21:05
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants