docs: clarify CH need for Neighborhoods API#2288
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Neighborhoods API documentation to clarify how it should be configured within the solver phase pipeline, specifically when users explicitly define a local search phase.
Changes:
- Adds a
constructionHeuristicentry to the XML solver configuration example for Neighborhoods API usage. - Adds a note explaining that Neighborhoods runs as part of Local Search and therefore expects an initialized solution.
- Adjusts the surrounding docs to make the setup steps more explicit for users configuring phases manually.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
triceo
approved these changes
May 5, 2026
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.
If you have never needed the solverconfig.xml file, but want to try the Neighborhoods API, it's not entirely clear that you also need to add a CH phase when you explicitly set the localsearch phase. Tried to clarify that here.