@@ -128,12 +128,6 @@ Choose your preferred installation method:
128
128
4 . ** View Citations** - See highlighted text in the PDF that supports each answer
129
129
5 . ** Explore** - Continue the conversation to dive deeper into your document
130
130
131
- ### Example Questions
132
-
133
- - "What are the main conclusions of this research paper?"
134
- - "Summarize the financial results from Q3"
135
- - "What methodology was used in the study?"
136
- - "List all the recommendations mentioned"
137
131
138
132
## 🏗️ Architecture
139
133
@@ -154,64 +148,7 @@ User Question → Semantic Search → Context Retrieval → AI Response
154
148
- ** PDF Processing** : PyMuPDF4LLM for structure-aware extraction
155
149
- ** Embeddings** : nomic-embed-text model
156
150
157
- ## 🔧 Configuration
158
-
159
- ### Available Models
160
-
161
- The app automatically detects your installed Ollama models. Popular choices:
162
-
163
- - ** qwen3:14b** - Well-balanced performance and accuracy (recommended)
164
- - ** llama3.1:8b** - Good alternative option
165
- - ** mistral: latest ** - Fast and efficient
166
- - ** codellama: latest ** - Good for technical documents
167
-
168
- ### Advanced Settings
169
-
170
- Configure in the sidebar:
171
- - ** Chunk Size** : How much text to process at once
172
- - ** Chunk Overlap** : Text overlap between chunks
173
- - ** Top-K Results** : Number of relevant chunks to consider
174
-
175
-
176
-
177
- ## 🧪 Testing
178
-
179
- Run the test suite:
180
-
181
- ``` bash
182
- pytest tests/ -v
183
- ```
184
151
185
- Test the RAG system specifically:
186
-
187
- ``` bash
188
- python experiments/test_rag.py
189
- ```
190
-
191
- ## 🤝 Contributing
192
-
193
- We welcome contributions! Here's how to get started:
194
-
195
- 1 . Fork the repository
196
- 2 . Create a feature branch (` git checkout -b feature/amazing-feature ` )
197
- 3 . Make your changes
198
- 4 . Add tests for new functionality
199
- 5 . Commit your changes (` git commit -m 'Add amazing feature' ` )
200
- 6 . Push to the branch (` git push origin feature/amazing-feature ` )
201
- 7 . Open a Pull Request
202
-
203
- ### Development Setup
204
-
205
- ``` bash
206
- # Install development dependencies
207
- pip install -r requirements.txt
208
-
209
- # Run tests
210
- pytest
211
-
212
- # Run linting
213
- flake8 ragadoc/
214
- ```
215
152
216
153
## 🐛 Troubleshooting
217
154
0 commit comments