Skip to content

fix: README_flux2.md fsdp config error - #14806

Open
Thundermean-sky wants to merge 1 commit into
huggingface:mainfrom
Thundermean-sky:fix-error-ReadME_flux2
Open

Thundermean-sky wants to merge 1 commit into
huggingface:mainfrom
Thundermean-sky:fix-error-ReadME_flux2

Conversation

@Thundermean-sky

Copy link
Copy Markdown

What does this PR do?

Fix incorrect FSDP configuration examples in the examples/dreambooth/README_flux2.md.

While training, I encountered two issues with the config examples in the README:

  1. The value of fsdp_auto_wrap_policy was incorrect, which caused training to fail.
  2. There was an extra space between the two class names in fsdp_transformer_layer_cls_to_wrap (Flux2TransformerBlock, Flux2SingleTransformerBlock). Removing the space resolved the error.

After correcting both parameters, the training runs successfully.

This PR updates the README with the corrected FSDP configuration examples.

Before submitting

  • Did you use an AI agent (Claude Code, Codex, Cursor, etc.) to help with this PR? If so:
    • Did you read the Coding with AI agents guide?
    • Did you run the self-review skill on the diff?
    • Did you share the final self-review notes in the PR description or a comment?
  • Did you read the contributor guideline?
  • Did you read our philosophy doc? (important for complex PRs)
  • Was this discussed/approved via a GitHub issue or the forum? Please add a link to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?
  • Are you the author (or part of the team) of the model/pipeline (only applicable for model/pipeline related PRs)?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@github-actions github-actions Bot added examples size/S PR with diff < 50 LOC labels Sep 18, 2026
@Thundermean-sky

Copy link
Copy Markdown
Author

Note:
Regarding the space between Flux2TransformerBlock and Flux2SingleTransformerBlock in fsdp_transformer_layer_cls_to_wrap: I removed the space because it caused an error in my environment. I'm not sure if this is a general issue or something specific to my setup. Feedback is welcome.

@github-actions

github-actions Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Hi @Thundermean-sky, 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.

@Thundermean-sky

Thundermean-sky commented Sep 20, 2026 •

Copy link
Copy Markdown
Author

Hi, thanks for the reminder!

This PR is a small documentation fix for incorrect FSDP config examples in the README (specifically fsdp_auto_wrap_policy and the space in fsdp_transformer_layer_cls_to_wrap). It doesn't fix a tracked issue.

Could a maintainer please add the no-issue-needed label? Thank you!

Hi @Thundermean-sky, 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.

This branch has not been deployed

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

Labels

examples size/S PR with diff < 50 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant