docs(retrieval): align score_propagation_alpha default 0.5→1.0 with #1947#1948
Open
r266-tech wants to merge 5 commits intovolcengine:mainfrom
Open
docs(retrieval): align score_propagation_alpha default 0.5→1.0 with #1947#1948r266-tech wants to merge 5 commits intovolcengine:mainfrom
r266-tech wants to merge 5 commits intovolcengine:mainfrom
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
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
Aligns documentation with #1947 (qin-ptr/qin-ctx 2026-05-09T11:58Z), which changed
RetrievalConfig.score_propagation_alphadefault from0.0to1.0inopenviking_cli/utils/config/retrieval_config.py. Five docs/example files still showed0.5(the original pre-#1804 default), creating drift two steps behind code.Changes
Default value
0.5→1.0and description rewording so the canonical-anchor case is the new default:docs/en/guides/01-configuration.md—retrievalJSON example, table row description+default, Full Schema appendix JSON exampledocs/zh/guides/01-configuration.md— mirror of aboveexamples/ov.conf.example— single-lineretrievalblockdocs/en/concepts/07-retrieval.md— Key Parameters row in Hierarchical Retrieval sectiondocs/zh/concepts/07-retrieval.md— mirror of aboveDescription text reordered to put
1.0first ("ignores the parent score (semantic similarity only)") so the explanatory anchor matches the actual default. Prior text said "0.5keeps the existing equal blend" — that "existing" framing referenced 0.5 as default, which is no longer true.0.5and0.0retained as alternative-behavior callouts.Notes
tests/test_config_loader.pyasserts0.5from a fixture.conf(explicit value, not the model default);tests/retrieve/test_hierarchical_retriever_rerank.pyalready exercisesRetrievalConfig(score_propagation_alpha=1.0)directly. Both remain valid.openviking/eval/datasets/local_doc_example_glm5.jsonlmentionsSCORE_PROPAGATION_ALPHA = 0.5inside a static training-data answer string. Left alone.cc @qin-ctx — fresh follow-up to your #1947 merge.