docs: document the 8 new algorithms; fix stale PSAF usage - #11
Open
blankjul wants to merge 2 commits into
Open
Conversation
The docs covered only GPSAF/PSAF/SSANSGA2 and predated the Bayesian-optimization algorithm suite. Bring them up to date: - Add a "Bayesian Optimization Algorithms" section describing all eight new algorithms (ParEGO, EHVI, MOEA/D-EGO, TSEMO, K-RVEA, CSEA, TuRBO, SAASBO) with a summary table, and add worked, executed usage examples for a representative set (ParEGO, EHVI, TuRBO, K-RVEA) with real output. - Fix the PSAF usage cells: rho_min (not the misspelled max_rho, which the algorithm silently ignored) and drop the GPSAF-only n_max_infills/n_max_doe kwargs PSAF never read. The stored outputs are unchanged (the effective config was already the defaults). - Extend algorithms.csv with the eight algorithms and fix two pre-existing table bugs (PSAF-DE/GPSAF-DE mislabeled "particle swarm"; GPSAF-GA/DE/CMAES anchors pointed at the PSAF sections). - Pin nbsphinx_execute='never': the notebook is pre-executed with committed outputs, so the build renders them instead of re-running full optimizations.
Every algorithm now has its own executed usage example: add MOEA/D-EGO, TSEMO, CSEA and SAASBO (SAASBO shown on Sphere, where the MAP scaffold converges, with a note that it is a scaffold). Point the algorithms-table anchors for these four at their new sections instead of the overview.
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.
The documentation covered only GPSAF/PSAF/SSANSGA2 and predated the Bayesian-optimization algorithm suite added on this project. This brings it current.
Added
algorithms.csvtable.Fixed
rho_min(not the misspelledmax_rho, which was silently ignored) and dropped GPSAF-onlyn_max_infills/n_max_doekwargs PSAF never read. Stored outputs unchanged (effective config was already the defaults).nbsphinx_execute='never'so the build renders the committed pre-executed outputs instead of re-running full optimizations.pyclawd docs buildrenders cleanly; verified the new sections + example outputs appear in the HTML.🤖 Generated with Claude Code