Skip to content

docs: pool eight small doc fixes into one PR - #14757

Open
simpleqt wants to merge 7 commits into
huggingface:mainfrom
simpleqt:docs/pooled-doc-fixes
Open

docs: pool eight small doc fixes into one PR#14757
simpleqt wants to merge 7 commits into
huggingface:mainfrom
simpleqt:docs/pooled-doc-fixes

Conversation

@simpleqt

@simpleqt simpleqt commented Sep 11, 2026

Copy link
Copy Markdown

Per maintainer feedback on #14716, this pools all my open diffusers doc fixes into a single PR:

  1. optimization.py: document num_cycles, not the nonexistent num_periods (docs(optimization): document num_cycles, not the nonexistent num_periods #14727)
  2. LTX latent upsampler docstring: 'latent' → 'latents' (docs: fix latent -> latents in LTX latent upsampler docstrings #14717)
  3. Kandinsky5 default prompt template: 'promt' → 'prompt' (docs: fix 'promt' typo in kandinsky5 default prompt templates #14716)
  4. Docstring parameter names that don't match signatures (docs: fix docstring parameter names that do not match signatures #14715)
  5. Chinese docs: English anchors pointing at translated Chinese headings (docs(zh): fix English anchors pointing at translated Chinese headings #14714)
  6. PAG anchor + StableDiffusionPipelineSafe row in SD overview (docs: fix PAG anchor and the StableDiffusionPipelineSafe row in the SD overview #14713)
  7. Dead Masked Im2Im TOC anchors in community pipelines README (docs: fix dead Masked Im2Im TOC anchors in community pipelines README #14712)
  8. 16 example scripts: duplicated 'with' in T5/Gemma sequence-length help (docs(examples): drop duplicated 'with' in sequence-length help strings #14728)

All are docs-only changes, no behavior impact.

Copilot AI lite review requested due to automatic review settings September 11, 2026 15:08
Copilot AI reviewed Sep 11, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions github-actions Bot added documentation Improvements or additions to documentation pipelines examples size/M PR with diff < 200 LOC labels Sep 11, 2026
stevhliu
stevhliu approved these changes Sep 11, 2026
View reviewed changes

@stevhliu stevhliu left a comment •
edited
Loading

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 fixes! please fix the failing CI check and then i can merge

@github-actions

github-actions Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Hi @simpleqt, thanks for the PR! It does not appear to link an issue it fixes. If this PR addresses an existing issue, please add a closing keyword (e.g. Fixes #1234) to the PR description so the issue is linked. See the contribution guide for more details. If this PR intentionally does not fix a tracked issue, a maintainer can add the no-issue-needed label to silence this reminder.

Please note that PRs without a linked issue are likely to be automatically closed 10 days after this notice.

Once the PR links an issue (or gets the no-issue-needed label), you can ignore this message — it stays here as a comment, but it no longer applies.

@simpleqt
docs: fix latent -> latents in LTX latent upsampler docstrings
cd26e94 
__call__ takes 'latents' (the docstring said 'latent', and its own
description says 'Input latents to normalize').
@simpleqt
docs: fix 'promt' typo in kandinsky5 default prompt templates
4787595 
The default system template sent to the Qwen text encoder misspelled
'prompt engineer' as 'promt engineer' (4 pipelines).

Note: this changes the token sequence of the default template, so
default outputs will differ numerically from before / from the
upstream Kandinsky5 reference. If exact parity with the reference
repo is preferred, the reference itself would need the same fix.
@simpleqt
docs: fix docstring parameter names that do not match signatures
283da20 
- flux controlnet encode_prompt documented a clip_skip parameter that
  does not exist (copy-paste from SD-style docs; flux has no CLIP
  layer-skipping)
- hunyuan_video1_5 pipelines documented num_images_per_prompt while
  the parameter is num_videos_per_prompt
- kandinsky5 _encode_prompt_qwen/_encode_prompt_clip documented
  num_videos_per_prompt, which neither method accepts
@simpleqt
docs(zh): fix English anchors pointing at translated Chinese headings
c4ffda3 
speed-memory-optims.md linked ./memory#model-offloading and
#group-offloading while the zh memory page translates those headings
(模型卸载 / 组卸载); using_peft_for_inference.md linked #hotswapping
while the zh heading is 热切换. Repointed at the Chinese slugs.
@simpleqt
docs: fix PAG anchor and the StableDiffusionPipelineSafe row in the S…
f867596 
…D overview

- pag.md linked #pagappliedlayers; the heading '### pag_applied_layers'
  keeps its underscores (#pag_applied_layers)
- the SD overview table linked ./stable_diffusion_safe, a doc page that
  no longer exists anywhere under docs/source; the row now names the
  deprecated pipeline as plain text instead of a dead link
@simpleqt
docs: fix dead Masked Im2Im TOC anchors in community pipelines README
7cf8523 
The TOC rows linked #stable-diffusion-masked-im2im /
#stable-diffusion-xl-masked-im2im; the actual headings are
'Masked Im2Im Stable Diffusion Pipeline' and 'Masked Im2Im Stable
Diffusion Pipeline XL' (lines 3184/3219).
@simpleqt
docs(examples): drop duplicated 'with' in T5/Gemma sequence-length he…
e0720cf 
…lp strings

16 example scripts' --max_sequence_length help read 'to use with with
the T5 text encoder' (or the Gemma variant); surfaced in --help output.
@simpleqt
simpleqt force-pushed the docs/pooled-doc-fixes branch from 373bd3f to e0720cf Compare September 15, 2026 15:57
This was referenced Sep 15, 2026
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
@simpleqt

simpleqt commented Sep 15, 2026

Copy link
Copy Markdown
Author

Updated: rebased onto current main and force-pushed. The num_cycles fix (#14727) is dropped from the pool — it is already fixed upstream, and the rebase detected the patch as identical. Seven fixes remain; each is docs/comment-only.

@stevhliu

stevhliu commented Sep 15, 2026

Copy link
Copy Markdown
Member

looks like its still failing, can you fix this link specifically? https://github.com/huggingface/diffusers/actions/runs/34991854159/job/104458797640?pr=14757

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@stevhliu stevhliu stevhliu approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation examples pipelines size/M PR with diff < 200 LOC

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@simpleqt @stevhliu