-
Notifications
You must be signed in to change notification settings - Fork 309
Validate the computed chunk_overlap (a float ≥ 1.0 silently drops all content) #604
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
aaravanmay
wants to merge
1
commit into
feyninc:main
Choose a base branch
from
aaravanmay:validate-computed-overlap
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,25 @@ | ||||||||||||||||||||||||||||
| """Regression test: a float chunk_overlap >= 1.0 must be rejected, not silently drop content. | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| TokenChunker.__init__ guarded `chunk_overlap >= chunk_size` only for int inputs. A float | ||||||||||||||||||||||||||||
| like 1.5 is turned into int(1.5 * chunk_size), which can exceed chunk_size, making the step | ||||||||||||||||||||||||||||
| (chunk_size - chunk_overlap) negative -> range() is empty -> chunk() returns [] and the whole | ||||||||||||||||||||||||||||
| document is silently dropped from a RAG index. The docstring promises ValueError when | ||||||||||||||||||||||||||||
| chunk_overlap >= chunk_size; this enforces it for floats too. | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| with the fix -> PASS (raises ValueError at construction; valid fractional overlap still works) | ||||||||||||||||||||||||||||
| without it -> FAIL (no raise; chunk() silently returns []) | ||||||||||||||||||||||||||||
| """ | ||||||||||||||||||||||||||||
| import pytest | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| from chonkie import TokenChunker | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| def test_float_overlap_ge_one_is_rejected(): | ||||||||||||||||||||||||||||
| with pytest.raises(ValueError): | ||||||||||||||||||||||||||||
| TokenChunker(tokenizer="character", chunk_size=10, chunk_overlap=1.5) | ||||||||||||||||||||||||||||
|
Comment on lines
+17
to
+19
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It is highly recommended to add test cases verifying that negative overlaps (both integer and float) are correctly rejected during initialization.
Suggested change
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| def test_valid_fractional_overlap_still_chunks(): | ||||||||||||||||||||||||||||
| chunker = TokenChunker(tokenizer="character", chunk_size=10, chunk_overlap=0.1) # -> 1 token | ||||||||||||||||||||||||||||
| chunks = chunker.chunk("a" * 100) | ||||||||||||||||||||||||||||
| assert len(chunks) > 0 | ||||||||||||||||||||||||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a subtle correctness issue here with negative float overlaps. If a user passes a negative float overlap like
-0.05withchunk_size=10, the expressionint(-0.05 * 10)evaluates toint(-0.5), which truncates to0in Python. As a result,self.chunk_overlapbecomes0, and the checkself.chunk_overlap < 0will evaluate toFalse, silently bypassing the validation. Checking the rawchunk_overlapinput directly for negative values resolves this issue.