Update documentation to use the new VOCS interface#302
Open
RemiLehe wants to merge 2 commits into
Open
Conversation
Replace references to the old VaryingParameter/Objective/Parameter classes with the new VOCS-based interface throughout the user guide and example descriptions: - basic_setup.rst: rewrite the setup section around a single VOCS object; update generator instantiation to AxSingleFidelityGenerator(vocs=vocs) - analyze_output.rst: replace class cross-refs with plain terminology - running_with_simulations.rst: update variable/objective/observable language throughout - ps_grid_sampling.rst, ps_line_sampling.rst: replace VaryingParameter refs with VOCS-based wording - bo_with_astra.rst: 'analyzed parameters' → 'observables' Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
pycln v2.5.0 uses ast.Str which was removed in Python 3.12+, causing pre-commit.ci to fail on all Python files. v2.6.0 switches to ast.Constant for string node handling. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
Replaces all references to the old
VaryingParameter/Objective/ParameterAPI with the new VOCS-based interface, keeping the documentation consistent with how the examples and generators actually work.Changes
basic_setup.rst: Rewrites the setup section around a singleVOCSobject (variables, objectives, observables); updates the generator example toAxSingleFidelityGenerator(vocs=vocs, n_init=4).analyze_output.rst: ReplacesVaryingParameter/Objective/Parameterclass cross-references with plain "variables, objectives, observables" terminology.running_with_simulations.rst: Updates all variable/objective/observable language; replaces "analyzed parameters" with "observables" throughout.ps_grid_sampling.rst,ps_line_sampling.rst: ReplacesVaryingParameterreferences with VOCS-based wording.bo_with_astra.rst: "analyzed parameters" → "observables".The Python scripts in
examples/were already using the new interface and were verified to run correctly against the currentmainbranch.🤖 Generated with Claude Code