Fix README links#827
Conversation
AdrianSosic
commented
Jun 12, 2026
- Fixes the navigation links
- Turn mentioned code components into links (clickable is always better than non-clickable)
There was a problem hiding this comment.
Pull request overview
This PR updates project documentation links in README.md and also introduces a new Gaussian Process feature (GaussianProcessSurrogate.posterior_mean_function) intended to reuse a trained GP’s posterior mean as the mean function for a newly-fitted GP (with accompanying tests and a changelog entry).
Changes:
- Fix and restructure top-level README navigation links; convert referenced components in the README to clickable API-doc links.
- Add
GaussianProcessSurrogate.posterior_mean_functionand refactor GP input/outcome transform construction into helpers. - Add unit tests covering posterior-mean correctness across differing bounds; add an Unreleased changelog entry.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Adjusts navigation links and converts referenced components to documentation hyperlinks. |
baybe/surrogates/gaussian_process/core.py |
Adds posterior_mean_function and refactors input/outcome transform creation. |
baybe/surrogates/gaussian_process/components/mean.py |
Minor module-level change (GC collection pattern). |
tests/test_gp.py |
Adds tests for posterior mean behavior (bounds-equality and not-fitted error). |
CHANGELOG.md |
Adds Unreleased entry documenting the new GP method. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AVHopp
left a comment
There was a problem hiding this comment.
I think one additional link should be changed, other than that everything seems to work
| <ul> | ||
| <li>Capture relationships between categories via <a href="https://emdgroup.github.io/baybe/stable/components/parameters.html#customdiscreteparameter">custom encodings for categorical</a> data.</li> | ||
| <li>Use built-in <a href="https://emdgroup.github.io/baybe/stable/components/parameters.html#substanceparameter">chemical encodings</a> for chemistry-related parameters.</li> | ||
| <li>Add mechanistic process understanding via <a href="https://emdgroup.github.io/baybe/stable/components/surrogates.html#using-custom-models">custom surrogate</a> models.</li> |
There was a problem hiding this comment.
@AdrianSosic could you also change this link here? This now only directs we to the top of the Surrogates, probably because the part after the #... is not up to date anymore