fix: correct Forrester benchmark in quick-start examples - #69
Open
arunimshukla wants to merge 1 commit into
Open
arunimshukla wants to merge 1 commit into
arunimshukla wants to merge 1 commit into
Conversation
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
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.
Summary
Correct the Forrester function in the README quick start and getting-started guide so both examples match the repository’s existing benchmark implementation.
Problem
Both documented examples define
term = 6 * x - 2, then calculate:However,
hola-py/benchmarks/functions/single_objective.pyimplements the Forrester benchmark as:The documented sine argument is therefore
3*x - 1instead of12*x - 4. Users copying these examples optimise a different function and cannot reproduce the stated benchmark minimum.At
x = 0.757248757841856:Changes
math.sin(term / 2)withmath.sin(2 * term)in both documentation examples.-6.03to-6.02074.hola-py/tests/test_doc_objectives.pyto compare both documented objectives against the existing benchmark at five inputs, including the approximate minimiser and domain endpoints.The regression test evaluates only the objective functions extracted from the Markdown examples. It does not execute optimisation studies or remote-client examples and requires no third-party dependencies or compiled Rust bindings.
Validation
1e-12.Full Rust/Python suites and Ruff checks were not run because the required tooling and compiled bindings were unavailable in the validation environment.
No changes to the optimisation engine, public API or existing benchmark implementation.