Skip to content

Commit a6212f3

Browse files
committed
docs: mark Unit 1 (RAG Fundamentals) as complete ✅
1 parent ebcf322 commit a6212f3

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Project: Real-Time Streaming RAG Chat
2+
3+
## Goal
4+
5+
This project aims to build a functional real-time chat application enhanced with Retrieval-Augmented Generation (RAG), demonstrating how to combine WebSockets with AI-driven information retrieval and generation for live conversations.
6+
7+
## Project Units
8+
9+
This project is broken down into the following units. See each unit's README for details:
10+
11+
1. **[Unit 1: RAG Fundamentals & Basic Demo](assignment1_llm_embeddings/README.md)** - ✅ Complete! Basic RAG implementation with document processing, embedding generation, and query answering. ([See demo output](RAG-output.md))
12+
2. **[Unit 2: Real-Time WebSocket Chat](assignment2_websocket_chat/README.md)** - Builds the foundational real-time chat server and client.
13+
3. **[Unit 3: Integrating RAG with Real-Time Chat](assignment3_rag_chat_integration/README.md)** - (TBA) Focuses on combining RAG (Unit 1) with the chat system (Unit 2).
14+
4. **[Unit 4: Advanced RAG Techniques & Optimization](assignment4_advanced_rag/README.md)** - (TBA) Explores improvements to the RAG pipeline.
15+
5. **[Unit 5: User Interface Enhancements](assignment5_ui_ux/README.md)** - (TBA) Focuses on improving the chat UI/UX.
16+
6. **[Unit 6: Deployment & Scalability](assignment6_deployment/README.md)** - (TBA) Covers preparing the application for deployment.
17+
18+
---
19+
20+
*Initial Setup: Run `npm install` in the root directory and create a `.env` file with your `OPENAI_API_KEY`.*

0 commit comments

Comments
 (0)