-
Notifications
You must be signed in to change notification settings - Fork 348
Validate float chunk_overlap in TokenChunker, not just int #633
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
santhreal
wants to merge
2
commits into
feyninc:main
Choose a base branch
from
santhreal:fix/token-chunker-float-overlap-validation
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.
+56
−2
Open
Changes from 1 commit
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 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -309,3 +309,42 @@ def test_token_chunker_return_type(tiktokenizer: Encoding, sample_text: str) -> | |||||||||||||||||||||
| chunks = chunker.chunk(sample_text) | ||||||||||||||||||||||
| assert all([type(chunk) is Chunk for chunk in chunks]) | ||||||||||||||||||||||
| assert all([len(tiktokenizer.encode(chunk.text)) <= 512 for chunk in chunks]) | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| def test_token_chunker_rejects_int_overlap_equal_to_chunk_size() -> None: | ||||||||||||||||||||||
| """An int chunk_overlap equal to chunk_size is invalid (existing behavior).""" | ||||||||||||||||||||||
| with pytest.raises(ValueError, match="chunk_overlap must be less than chunk_size"): | ||||||||||||||||||||||
| TokenChunker(tokenizer="character", chunk_size=10, chunk_overlap=10) | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| def test_token_chunker_rejects_float_overlap_resolving_to_chunk_size() -> None: | ||||||||||||||||||||||
| """A float chunk_overlap of 1.0 resolves to chunk_size and must be rejected. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Previously only the int path was validated, so this constructed a chunker with | ||||||||||||||||||||||
| a zero stride and chunk() raised 'range() arg 3 must not be zero'. | ||||||||||||||||||||||
| """ | ||||||||||||||||||||||
| with pytest.raises(ValueError, match="chunk_overlap must be less than chunk_size"): | ||||||||||||||||||||||
| TokenChunker(tokenizer="character", chunk_size=10, chunk_overlap=1.0) | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| def test_token_chunker_rejects_float_overlap_exceeding_chunk_size() -> None: | ||||||||||||||||||||||
| """A float chunk_overlap > 1.0 resolves above chunk_size and must be rejected. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Previously this produced a negative stride and chunk() silently returned zero | ||||||||||||||||||||||
| chunks, dropping the entire input text. | ||||||||||||||||||||||
| """ | ||||||||||||||||||||||
| with pytest.raises(ValueError, match="chunk_overlap must be less than chunk_size"): | ||||||||||||||||||||||
| TokenChunker(tokenizer="character", chunk_size=10, chunk_overlap=1.5) | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| def test_token_chunker_accepts_valid_fractional_overlap_and_chunks() -> None: | ||||||||||||||||||||||
| """A valid fractional float overlap resolves correctly and chunks non-empty text.""" | ||||||||||||||||||||||
| chunker = TokenChunker(tokenizer="character", chunk_size=10, chunk_overlap=0.5) | ||||||||||||||||||||||
| assert chunker.chunk_overlap == 5 | ||||||||||||||||||||||
| text = "x" * 40 | ||||||||||||||||||||||
| chunks = chunker.chunk(text) | ||||||||||||||||||||||
| assert len(chunks) > 1 | ||||||||||||||||||||||
| assert "".join(dict.fromkeys([c.text[0] for c in chunks])) == "x" | ||||||||||||||||||||||
| # Every original character is covered by the first chunk's start through the last chunk's end. | ||||||||||||||||||||||
| assert chunks[0].start_index == 0 | ||||||||||||||||||||||
| assert chunks[-1].end_index == len(text) | ||||||||||||||||||||||
|
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 would be beneficial to add test cases to verify that negative values for
Suggested change
|
||||||||||||||||||||||
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.
Checking
self.chunk_overlap < 0after resolving it to an integer can lead to inconsistent behavior for small negative float values due to truncation. For example, ifchunk_overlap = -0.05andchunk_size = 10,int(-0.05 * 10)resolves to0, which silently bypasses the non-negative check. However, ifchunk_size = 100,int(-0.05 * 100)resolves to-5, which correctly raises aValueError.To ensure consistent validation regardless of the
chunk_size, we should validate that the inputchunk_overlapis non-negative before resolving it.