Skip to content

Commit

Permalink
Merge pull request #165 from chonkie-ai/add-chonkbook
Browse files Browse the repository at this point in the history
Add chonkbook
  • Loading branch information
bhavnicksm authored Feb 6, 2025
2 parents 67cea70 + 579b286 commit 5cc6001
Show file tree
Hide file tree
Showing 3 changed files with 3,619 additions and 0 deletions.
Binary file added assets/chonkbook_logo_transparent_bg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 50 additions & 0 deletions cookbook/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<div align='center'>

![Chonkie Cookbook Logo](/assets/chonkbook_logo_transparent_bg.png)

# πŸ¦› Chonkie's Cookbook πŸ“š

_A collection of recipes, tutorials, and projects using Chonkie_

</div>

## πŸ“– Official Tutorials

| Tutorial | Description | Try it in Colab |
|----------|-------------|-----------------|
| Recursive Chunking for PDF/Markdown Documents | A quick look at how you can use Chonkie's RecursiveChunker to chunk your PDF/Markdown documents and build a RAG pipeline over it! | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/bhavnicksm/chonkie/blob/main/cookbook/tutorials/recursive_chunking_pdf.ipynb) |

## πŸ”Œ Community Integrations

Chonkie is proud to power a diverse ecosystem of projects and integrations across the AI and ML landscape. Our lightweight, flexible architecture makes it easy to integrate Chonkie into your existing workflows and tools.

Want to add your integration? Simply [raise an issue](https://github.com/bhavnicksm/chonkie/issues/new) and we'll help you get started! Once approved, your integration will be featured here.

| Integration | Description | Repository |
|-------------|-------------|------------|
| ⚑️ FlashRAG | High-performance RAG framework optimized for speed and efficiency | [![GitHub](https://img.shields.io/badge/GitHub-181717?style=plastic&logo=github&logoColor=white&labelColor=464646)](https://github.com/RUC-NLPIR/FlashRAG) |
| πŸ“„ txtai | All-in-one embeddings database for semantic search, LLM orchestration and language model workflows | [![GitHub](https://img.shields.io/badge/GitHub-181717?style=plastic&logo=github&logoColor=white&labelColor=464646)](https://github.com/neuml/txtai) |
| [Add your integration here!](CONTRIBUTING.md) | Share your Chonkie integration with the community | [![GitHub](https://img.shields.io/badge/GitHub-181717?style=plastic&logo=github&logoColor=white&labelColor=464646)](CONTRIBUTING.md) |

## πŸ“š Community Blogs & Resources

Share your knowledge and experiences with Chonkie! Whether it's a blog post, video tutorial, or technical deep-dive, we'd love to feature your content here.

| Type | Title | Author | Description |
|------|--------|--------|-------------|
| Video | [Chonkie - RAG Chunking Library - Easy Local Installation and Testing](https://www.youtube.com/watch?v=f4f1TkeL5Hk) | Fahd Mirza | A quick walkthrough of how to install Chonkie and test it out for yourself! |
| Blog | [Easy Late-Chunking with Chonkie](https://pub.towardsai.net/easy-late-chunking-with-chonkie-7f05e5916997) | Michael Ryaboy | This blog post is a quick look at how you can use Chonkie's LateChunker to chunk your documents and build a search pipeline over it with KDB.AI! |

Have content to share? Open an issue with your resource and we'll get it added to the cookbook!

## πŸ“ Contributing

Want to add your project or integration to the cookbook? Check out our [contribution guidelines](CONTRIBUTING.md)!

---

<div align='center'>

Need help? Join our [Discord community](https://discord.gg/rYYp6DC4cv)!

</div>
Loading

0 comments on commit 5cc6001

Please sign in to comment.