Dhruv Pawar commited on
Commit
8e1caab
·
1 Parent(s): e90676e

newest README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -212
README.md CHANGED
@@ -4,11 +4,11 @@ emoji: 🧠
4
  colorFrom: purple
5
  colorTo: blue
6
  sdk: gradio
7
- sdk_version: "5.0.0"
8
  app_file: main.py
9
  pinned: false
10
  license: mit
11
- short_description: Next-gen AI reasoning platform with multiple research methodologies
12
  tags:
13
  - llm
14
  - reasoning
@@ -36,27 +36,6 @@ tags:
36
 
37
  ---
38
 
39
- ## ✨ Screenshots
40
-
41
- <div align="center">
42
-
43
- ### 🌟 Modern Dark Theme Interface
44
- ![Header Section](./screenshots/header-section.png)
45
-
46
- *Professional branding with animated logo, clear typography, and interactive feature badges*
47
-
48
- ### 🎯 Reasoning Workspace
49
- ![Reasoning Interface](./screenshots/reasoning-workspace.png)
50
-
51
- *Clean, distraction-free workspace with collapsible sidebar and live metrics*
52
-
53
- ### 📊 Analytics Dashboard
54
- ![Analytics Dashboard](./screenshots/analytics-dashboard.png)
55
-
56
- *Real-time performance insights with beautiful visual indicators*
57
-
58
- </div>
59
-
60
  ## 🎨 Modern Dark Theme UI
61
 
62
  Dive into a **stunning, professionally designed interface** that sets new standards for AI applications.
@@ -78,19 +57,13 @@ Dive into a **stunning, professionally designed interface** that sets new standa
78
  - **Breakpoint-Specific**: Tailored designs for tablets, phones, and desktops
79
  - **Flexible Components**: Adaptive feature badges and navigation elements
80
 
81
- ### **🎯 User Experience Enhancements**
82
- - **Clear Visual Hierarchy**: Intuitively organized information with proper spacing
83
- - **Interactive Badges**: Hover effects on feature tags with smooth animations
84
- - **Modern Card Designs**: Black cards with subtle borders and soft shadows
85
- - **Accessibility First**: Focus indicators, high contrast ratios, reduced motion support
86
-
87
  ---
88
 
89
  ## ✨ Research Features
90
 
91
  ### 🔬 Advanced Reasoning Modes
92
- - **🌳 Tree of Thoughts (ToT)** - Systematic exploration of multiple reasoning paths (*Yao et al., 2023*)
93
- - **🔗 Chain of Thought (CoT)** - Step-by-step logical reasoning (*Wei et al., 2022*)
94
  - **🔍 Self-Consistency** - Multiple solution paths with consensus validation
95
  - **🪞 Reflexion** - Self-critique and iterative improvement cycles
96
  - **👥 Multi-Agent Debate** - Multiple AI perspectives with synthesis
@@ -125,74 +98,39 @@ Dive into a **stunning, professionally designed interface** that sets new standa
125
  ### Installation
126
 
127
  ```bash
128
- # 1. Clone the repository
129
  git clone <repository-url>
130
  cd reasoning-system-pro
131
-
132
- # 2. Create virtual environment
133
  python -m venv venv
134
- source venv/bin/activate # Windows: venv\Scripts\activate
135
-
136
- # 3. Install dependencies
137
  pip install -r requirements.txt
138
 
139
- # 4. Configure environment
140
  cp .env.example .env
141
- # Edit .env and add your GROQ_API_KEY
142
-
143
- # 5. Run the application
144
  python main.py
145
-
146
- # 6. Open in browser
147
- # http://localhost:7860
148
  ```
149
 
150
  ---
151
 
152
- ## 🔄 Latest Updates
153
-
154
- ### **v1.0.0 - Complete UI Redesign**
155
- - ✨ **Stunning Dark Theme**: Professional dark interface with optimal contrast
156
- - 🎨 **Enhanced Typography**: Space Grotesk + Inter fonts for modern aesthetics
157
- - ⚡ **Smooth Animations**: Subtle transitions and interactive elements
158
- - 🎯 **Improved UX**: Better visual hierarchy and navigation
159
- - 📱 **Responsive Design**: Optimized for all device sizes
160
- - 🎪 **Interactive Features**: Hover effects, animations, and feedback
161
 
162
- ### Key Improvements:
163
- - **Visual Clarity**: Crystal-clear text rendering with anti-aliasing
164
- - **Brand Enhancement**: Animated logo and refined branding elements
165
- - **Performance**: Optimized CSS and smooth interactions
166
- - **Accessibility**: High contrast ratios and focus indicators
167
 
168
- ---
 
169
 
170
- ## 📁 Project Structure
 
171
 
172
- ```
173
- reasoning-system-pro/
174
- ├── src/
175
- │ ├── api/ # API client management
176
- │ ├── core/ # Core business logic
177
- │ ├── models/ # Data models
178
- │ ├── services/ # Business services
179
- │ ├── ui/ # Gradio interface
180
- │ ├── utils/ # Utilities
181
- │ └── config/ # Configuration
182
- ├── tests/ # Test suite
183
- ├── exports/ # Generated exports
184
- ├── backups/ # Conversation backups
185
- ├── logs/ # Application logs
186
- ├── main.py # Entry point
187
- ├── requirements.txt # Dependencies
188
- └── .env # Environment config
189
- ```
190
 
191
  ## 🔧 Configuration
192
 
193
- ### Environment Variables
194
-
195
- Key configuration options in `.env`:
196
 
197
  ```env
198
  # API
@@ -207,126 +145,13 @@ ENABLE_PDF_EXPORT=true
207
  ENABLE_CACHE=true
208
  ```
209
 
210
- ### Advanced Configuration
211
-
212
- Edit `src/config/settings.py` for fine-tuned control over:
213
- - Cache TTL and size
214
- - Rate limiting parameters
215
- - Request timeouts and retries
216
- - File storage locations
217
- - UI themes
218
-
219
- ## 📖 Usage Examples
220
-
221
- ### Basic Query
222
- ```
223
- Simply type your question in the chat interface
224
- "Explain quantum entanglement using the Tree of Thoughts method"
225
- ```
226
-
227
- ### With Self-Critique
228
- Enable "Self-Critique" checkbox for automatic validation and refinement.
229
-
230
- ### Custom Templates
231
- Select from pre-built templates:
232
- - Research Analysis
233
- - Problem Solving
234
- - Code Review
235
- - Writing Enhancement
236
- - Debate Analysis
237
- - Learning Explanation
238
-
239
- ## 🧪 Testing
240
-
241
- ```bash
242
- # Run all tests
243
- pytest
244
-
245
- # With coverage
246
- pytest --cov=src --cov-report=html
247
-
248
- # Specific test file
249
- pytest tests/test_reasoner.py
250
- ```
251
-
252
- ## 📊 Available Models
253
-
254
- ### Meta / Llama Models
255
- - `llama-3.3-70b-versatile` - Best overall performance
256
- - `llama-3.1-8b-instant` - Ultra-fast responses
257
- - `llama-4-maverick-17b-128k` - Experimental long context
258
-
259
- ### DeepSeek Models
260
- - `deepseek-r1-distill-llama-70b` - Optimized reasoning
261
-
262
- ### Mixtral Models
263
- - `mixtral-8x7b-32768` - Long context specialist
264
-
265
- And many more! See `src/config/constants.py` for the full list.
266
-
267
- ## 🛠️ Development
268
-
269
- ### Code Style
270
- ```bash
271
- # Format code
272
- black src/
273
-
274
- # Check linting
275
- flake8 src/
276
-
277
- # Type checking
278
- mypy src/
279
- ```
280
-
281
- ### Adding New Reasoning Modes
282
-
283
- 1. Add to `src/config/constants.py`:
284
- ```python
285
- class ReasoningMode(Enum):
286
- YOUR_MODE = "Your Mode Name"
287
- ```
288
-
289
- 2. Add system prompt in `src/core/prompt_engine.py`:
290
- ```python
291
- SYSTEM_PROMPTS = {
292
- ReasoningMode.YOUR_MODE: "Your prompt here..."
293
- }
294
- ```
295
-
296
- ## 📝 API Documentation
297
-
298
- ### Core Classes
299
-
300
- #### AdvancedReasoner
301
- Main reasoning engine with streaming support.
302
-
303
- ```python
304
- reasoner = AdvancedReasoner()
305
- for response in reasoner.generate_response(query, ...):
306
- print(response)
307
- ```
308
-
309
- #### ResponseCache
310
- Thread-safe LRU cache with TTL.
311
-
312
- ```python
313
- cache = ResponseCache(maxsize=100, ttl=3600)
314
- cache.set(key, value)
315
- result = cache.get(key)
316
- ```
317
-
318
- ## 🐛 Troubleshooting
319
-
320
- ### Common Issues
321
 
322
- **Issue: "GROQ_API_KEY not found"**
323
- - Solution: Ensure `.env` file exists and contains `GROQ_API_KEY=your_key`
324
 
325
- **Issue: PDF export fails**
326
- - Solution: Install reportlab: `pip install reportlab`
327
 
328
- **Issue: Rate limit errors**
329
- - Solution: Increase `RATE_LIMIT_WINDOW` in `.env`
330
 
331
  ## 🤝 Contributing
332
 
@@ -336,24 +161,12 @@ result = cache.get(key)
336
  4. Add tests
337
  5. Submit a pull request
338
 
 
 
339
  ## 📄 License
340
 
341
  MIT License - See LICENSE file for details
342
 
343
- ## 🙏 Acknowledgments
344
-
345
- - **Yao et al. (2023)** - Tree of Thoughts
346
- - **Wei et al. (2022)** - Chain of Thought
347
- - **Bai et al. (2022)** - Constitutional AI
348
- - **Groq** - High-speed LLM inference
349
-
350
- ## 📧 Support
351
-
352
- For issues and questions:
353
- - Create an issue on GitHub
354
- - Check existing documentation
355
- - Review logs in `logs/` directory
356
-
357
  ---
358
 
359
  **Built with ❤️ using Gradio and Groq**
 
4
  colorFrom: purple
5
  colorTo: blue
6
  sdk: gradio
7
+ sdk_version: 5.0.0
8
  app_file: main.py
9
  pinned: false
10
  license: mit
11
+ short_description: Advanced AI reasoning with multiple methodologies
12
  tags:
13
  - llm
14
  - reasoning
 
36
 
37
  ---
38
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
39
  ## 🎨 Modern Dark Theme UI
40
 
41
  Dive into a **stunning, professionally designed interface** that sets new standards for AI applications.
 
57
  - **Breakpoint-Specific**: Tailored designs for tablets, phones, and desktops
58
  - **Flexible Components**: Adaptive feature badges and navigation elements
59
 
 
 
 
 
 
 
60
  ---
61
 
62
  ## ✨ Research Features
63
 
64
  ### 🔬 Advanced Reasoning Modes
65
+ - **🌳 Tree of Thoughts (ToT)** - Systematic exploration of multiple reasoning paths
66
+ - **🔗 Chain of Thought (CoT)** - Step-by-step logical reasoning
67
  - **🔍 Self-Consistency** - Multiple solution paths with consensus validation
68
  - **🪞 Reflexion** - Self-critique and iterative improvement cycles
69
  - **👥 Multi-Agent Debate** - Multiple AI perspectives with synthesis
 
98
  ### Installation
99
 
100
  ```bash
101
+ # Clone and setup
102
  git clone <repository-url>
103
  cd reasoning-system-pro
 
 
104
  python -m venv venv
105
+ source venv/bin/activate
 
 
106
  pip install -r requirements.txt
107
 
108
+ # Configure and run
109
  cp .env.example .env
110
+ # Add your GROQ_API_KEY to .env
 
 
111
  python main.py
 
 
 
112
  ```
113
 
114
  ---
115
 
116
+ ## 📊 Available Models
 
 
 
 
 
 
 
 
117
 
118
+ ### Meta / Llama Models
119
+ - `llama-3.3-70b-versatile` - Best overall performance
120
+ - `llama-3.1-8b-instant` - Ultra-fast responses
121
+ - `llama-4-maverick-17b-128k` - Experimental long context
 
122
 
123
+ ### DeepSeek Models
124
+ - `deepseek-r1-distill-llama-70b` - Optimized reasoning
125
 
126
+ ### Mixtral Models
127
+ - `mixtral-8x7b-32768` - Long context specialist
128
 
129
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
130
 
131
  ## 🔧 Configuration
132
 
133
+ Key configuration options:
 
 
134
 
135
  ```env
136
  # API
 
145
  ENABLE_CACHE=true
146
  ```
147
 
148
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
149
 
150
+ ## 📖 Usage
 
151
 
152
+ Simply type your question in the chat interface and select your preferred reasoning mode. Enable "Self-Critique" for automatic validation and refinement.
 
153
 
154
+ ---
 
155
 
156
  ## 🤝 Contributing
157
 
 
161
  4. Add tests
162
  5. Submit a pull request
163
 
164
+ ---
165
+
166
  ## 📄 License
167
 
168
  MIT License - See LICENSE file for details
169
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
170
  ---
171
 
172
  **Built with ❤️ using Gradio and Groq**