Feature/improve doc deterministic #1266
Merged
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
Added information on the 'deterministic' parameter for objective functions, explaining its use for both deterministic and stochastic objectives.
Clarify the role of the 'deterministic' parameter in objective functions.
Updated docstring for 'deterministic' parameter to clarify its behavior and requirements.
Removed mention of surrogate modeling aleatoric uncertainty for stochastic objectives.
Reformat docstring for better readability.
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation of the deterministic parameter in SMAC to better explain its behavior and usage in both deterministic and stochastic optimization scenarios.
- Enhanced the
deterministicparameter description in theScenarioclass docstring with clearer explanation of seed handling and intensification requirements - Added an informational section in the getting started guide explaining when to use deterministic vs. stochastic modes
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| smac/scenario.py | Updated the deterministic parameter documentation to clarify seed passing behavior and intensification requirements |
| docs/3_getting_started.md | Added new info box explaining deterministic vs. stochastic objective handling |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
daphne12345
approved these changes
Oct 23, 2025
|
Overall, it looks fine to me. However, I think we should first merge this to the development branch. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Improving documentation of deterministic behavior.