ashiquzzaman commited on
Commit
adfe4de
·
verified ·
1 Parent(s): eecd0b7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +31 -1
README.md CHANGED
@@ -1 +1,31 @@
1
- # github-docs-rag-cloud
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: GitHub Docs RAG
3
+ emoji: 📦
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: streamlit
7
+ sdk_version: "1.37.0"
8
+ python_version: "3.10"
9
+ app_file: app.py
10
+ pinned: false
11
+ ---
12
+
13
+ # GitHub Documentation RAG
14
+
15
+ Ask questions about GitHub repository documentation and get answers with citations.
16
+
17
+ ## Features
18
+ - Semantic search across documentation
19
+ - AI-powered answers with source citations
20
+ - Powered by Pinecone vector DB and Groq LLM
21
+
22
+ ## How to Use
23
+ 1. Type your question in the search box
24
+ 2. Get instant answers with source file references
25
+ 3. View the actual context chunks used
26
+
27
+ ## Tech Stack
28
+ - **Embeddings**: all-MiniLM-L6-v2
29
+ - **Vector DB**: Pinecone
30
+ - **LLM**: Groq (Llama 3.1)
31
+ - **UI**: Streamlit