-
Notifications
You must be signed in to change notification settings - Fork 76
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
v0.0.1a4 #1
Merged
Merged
v0.0.1a4 #1
Conversation
This file contains 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
…nhancing sentence and semantic chunking capabilities
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.
This pull request introduces comprehensive documentation and a new chunking strategy to the
chonkie
library, along with some structural and initialization changes. The most important changes include the addition of detailed documentation, a new semantic chunking strategy, and updates to the initialization files.Documentation:
DOCS.md
: Added detailed documentation for theTokenChunker
class, including initialization, methods, and examples.README.md
: Enhanced the README with a logo, a detailed introduction, usage instructions, and citation guidelines.New Features:
chonkie/chunker/semantic.py
: Introduced a newSemanticChunker
class that groups sentences based on semantic similarity and splits them into chunks while maintaining sentence boundaries.Structural Updates:
chonkie/__init__.py
: Updated the initialization file to include imports for all chunker classes and defined__all__
for module exports.chonkie/chunker/__init__.py
: Added imports for all chunker classes and defined__all__
for module exports.Base Class Addition:
chonkie/chunker/base.py
: Added aBaseChunker
abstract class and aChunk
dataclass to serve as the foundation for all chunker implementations.