📝 Add README visual of diffusion evolution on Rastrigin#12
Merged
Conversation
- Add scripts/generate_readme_figure.py producing a 4-panel static snapshot plus animated GIF of a Rastrigin run (seeded, rerunnable). - Tune fitness mapping/temperature/sigma_m so the final population spreads across multiple Rastrigin peaks instead of collapsing to the global max alone, highlighting the algorithm's multi-modal behavior. - Embed the static figure and link the GIF from the README's "What Is This?" section. - Whitelist docs/images/*.png and *.gif in .gitignore so README assets are tracked while stray plots remain ignored. - Note the addition in CHANGELOG under [Unreleased].
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
1 participant
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.
What does this PR do?
Adds a hero visual to the README showing diffusion evolution in action on the Rastrigin landscape — a 4-panel static PNG of the trajectory from pure noise to multi-peak convergence, plus an animated GIF. The figure is fully reproducible from a seeded script (
scripts/generate_readme_figure.py) committed alongside the generated assets.Details
scripts/generate_readme_figure.pywith seeded Rastrigin run and matplotlib rendering. Outputs 4-panel static figure and animated GIF.fitness.mapping=EXPONENTIALwithtemperature=2.0andNormalType.IDENTITY,sigma_m=0.5, and a wider initial noise scale so the final population visibly clusters across multiple Rastrigin peaks instead of collapsing to a single mode.docs/images/*.pngand*.gifin.gitignoreso the README assets are tracked while stray plot output stays ignored.CHANGELOG.mdunder[Unreleased].Reproducing the figures
Outputs to
docs/images/denoising-trajectory.{png,gif}.