Skip to content

fix: correct broken README code examples and outdated blog post#4

Merged
atandra2000 merged 1 commit into
mainfrom
fix/docs-accuracy
Jun 2, 2026
Merged

fix: correct broken README code examples and outdated blog post#4
atandra2000 merged 1 commit into
mainfrom
fix/docs-accuracy

Conversation

@atandra2000
Copy link
Copy Markdown
Owner

Bug fixes for documentation accuracy:

README:

  • 'Loading from Python' now uses sys.path + 'from SD_Model import UNetModel' (src/ is not a package), loads EMA shadow with strict=False
  • 'Python API' example now matches generate.py's actual signature

docs/blog_post.md:

  • Drop the stale 'inference.py doesn't wire --negative' caveat
  • Rewrite the latent-clamp post-mortem (now opt-in, not monkey-patched)
  • Remove 'What I'd Do Differently' items 5 and 6 (both already done)
  • Replace flat file tree with the actual src/ + data_pipeline/ + docs/ + tests/ + scripts/ layout
  • Drop 'the one clamp at line 736' from final thoughts

README:
- 'Loading from Python' now uses sys.path + 'from SD_Model import UNetModel'
  (src/ is not a package), loads EMA shadow with strict=False, and points to
  inference.py:load_ema_unet as the canonical loader
- 'Python API' example now matches generate.py's actual signature
  (load_model + generate, not the fictional generate_images)

docs/blog_post.md:
- \u00a76.3: drop the stale 'inference.py doesn't wire --negative' caveat
- \u00a77.1: rewrite the post-mortem for the latent clamp — it is now opt-in
  via clamp_pred_x0=False (default), not monkey-patched
- \u00a78: remove 'What I'd Do Differently' items 5 and 6 (both already done)
- \u00a710: replace flat file tree with the actual src/ + data_pipeline/ + docs/
  + tests/ + scripts/ layout, point to HF Hub for the checkpoint
- Final thoughts: drop 'the one clamp at line 736'
@atandra2000 atandra2000 merged commit 1f16e9d into main Jun 2, 2026
1 check passed
@atandra2000 atandra2000 deleted the fix/docs-accuracy branch June 2, 2026 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant