Starter code for RAG (Retrieval Augmented Generation) projects and tools. This repository provides examples and best practice guidelines for building RAG systems. Our goal is to build a comprehensive set of tools and examples that leverage recent advances in natural language processing, information retrieval, and machine learning.
This repository supports various RAG scenarios, including:
- ☝️ Create Embeddings Notebook: Introductory notebook to create and use vector embeddings in chat
- 🔍 AI News Hound: A tool for journalists to uncover newsworthy AI research topics
Our target audience includes data scientists, machine learning engineers, and developers with varying levels of NLP and information retrieval knowledge. The utilities and examples provided are intended to be solution accelerators for real-world RAG problems.
To get started, navigate to the Setup Guide, which lists instructions on how to setup the compute environment and dependencies needed to run the notebooks in this repo.
| Scenario | Support | Description | Notebook |
|---|---|---|---|
| 🔍 AI News Hound | Base | A tool for journalists to identify potentially newsworthy AI research topics by visualizing and analyzing relationships between scientific papers, news articles, and social media discussions. |  |
| [Future Scenario 1] | Planned | Description of future scenario 1 | - |
| [Future Scenario 2] | Planned | Description of future scenario 2 | - |
- Pinecone: Vector Database to store embeddings
- Vercel: Site hosting
[Add your build status badges here when you set up CI/CD]
This project welcomes contributions and suggestions. Please see our contribution guidelines.
This project is licensed under the MIT License - see the LICENSE file for details.
MIT License
Copyright (c) 2023 [Sundai.Club]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.