docs: clarify and document --summary-token-threshold for markdown indexing - #482
Open
denis-samatov wants to merge 1 commit into
Open
docs: clarify and document --summary-token-threshold for markdown indexing#482denis-samatov wants to merge 1 commit into
denis-samatov wants to merge 1 commit into
Conversation
…exing - Document --summary-token-threshold semantics in README.md under Markdown CLI indexing - Clarify in run_pageindex.py --help that nodes below threshold receive verbatim text as summary unless set to 0 - Add docstring explanation to get_node_summary in page_index_md.py Closes VectifyAI#355
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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
--summary-token-thresholdwhen indexing Markdown documents.--helpoutput andREADME.mdthat nodes whose token count is below the threshold receive their raw text verbatim assummary(to avoid costly LLM calls for short sections), and explains how setting--summary-token-threshold 0generates full summaries for all nodes.Changes
run_pageindex.py:--summary-token-thresholdto clearly explain the verbatim-copy behavior and how to force LLM summary generation for all nodes with0.README.md:python3 run_pageindex.py --md_path ...with descriptions for--summary-token-threshold,--if-thinning, and--thinning-threshold.pageindex/page_index_md.py:get_node_summary().Verification
python3 run_pageindex.py --helpoutput.tests/test_page_index_md.pypassed).Closes #355