Spaces:
Running
Running
Delete USER_GUIDE.md
Browse files- USER_GUIDE.md +0 -300
USER_GUIDE.md
DELETED
|
@@ -1,300 +0,0 @@
|
|
| 1 |
-
# 📖 User Guide - ZeroGPU LLM Inference
|
| 2 |
-
|
| 3 |
-
## Quick Start (5 Minutes)
|
| 4 |
-
|
| 5 |
-
### 1. Choose Your Model
|
| 6 |
-
The model dropdown shows 30+ options organized by size:
|
| 7 |
-
- **Compact (<2B)**: Fast, lightweight - great for quick responses
|
| 8 |
-
- **Mid-size (2-8B)**: Best balance of speed and quality
|
| 9 |
-
- **Large (14B+)**: Highest quality, slower but more capable
|
| 10 |
-
|
| 11 |
-
**Recommendation for beginners**: Start with `Qwen3-4B-Instruct-2507`
|
| 12 |
-
|
| 13 |
-
### 2. Try an Example Prompt
|
| 14 |
-
Click on any example below the chat box to get started:
|
| 15 |
-
- "Explain quantum computing in simple terms"
|
| 16 |
-
- "Write a Python function..."
|
| 17 |
-
- "What are the latest developments..." (requires web search)
|
| 18 |
-
|
| 19 |
-
### 3. Start Chatting!
|
| 20 |
-
Type your message and press Enter or click "📤 Send"
|
| 21 |
-
|
| 22 |
-
## Core Features
|
| 23 |
-
|
| 24 |
-
### 💬 Chat Interface
|
| 25 |
-
|
| 26 |
-
The main chat area shows:
|
| 27 |
-
- Your messages on one side
|
| 28 |
-
- AI responses with a 🤖 avatar
|
| 29 |
-
- Copy button on each message
|
| 30 |
-
- Smooth streaming as tokens generate
|
| 31 |
-
|
| 32 |
-
**Tips:**
|
| 33 |
-
- Press Enter to send (Shift+Enter for new line)
|
| 34 |
-
- Click Copy button to save responses
|
| 35 |
-
- Scroll up to review history
|
| 36 |
-
- Use Clear Chat to start fresh
|
| 37 |
-
|
| 38 |
-
### 🤖 Model Selection
|
| 39 |
-
|
| 40 |
-
**When to use each size:**
|
| 41 |
-
|
| 42 |
-
| Model Size | Best For | Speed | Quality |
|
| 43 |
-
|------------|----------|-------|---------|
|
| 44 |
-
| <2B | Quick questions, testing | ⚡⚡⚡ | ⭐⭐ |
|
| 45 |
-
| 2-8B | General chat, coding help | ⚡⚡ | ⭐⭐⭐ |
|
| 46 |
-
| 14B+ | Complex reasoning, long-form | ⚡ | ⭐⭐⭐⭐ |
|
| 47 |
-
|
| 48 |
-
**Specialized Models:**
|
| 49 |
-
- **Phi-4-mini-Reasoning**: Math, logic problems
|
| 50 |
-
- **Qwen2.5-Coder**: Programming tasks
|
| 51 |
-
- **DeepSeek-R1-Distill**: Step-by-step reasoning
|
| 52 |
-
- **Apriel-1.5-15b-Thinker**: Multimodal understanding
|
| 53 |
-
|
| 54 |
-
### 🔍 Web Search
|
| 55 |
-
|
| 56 |
-
Enable this when you need:
|
| 57 |
-
- Current events and news
|
| 58 |
-
- Recent information (after model training cutoff)
|
| 59 |
-
- Facts that change frequently
|
| 60 |
-
- Real-time data
|
| 61 |
-
|
| 62 |
-
**How it works:**
|
| 63 |
-
1. Toggle "🔍 Enable Web Search"
|
| 64 |
-
2. Web search settings accordion appears
|
| 65 |
-
3. System prompt updates automatically
|
| 66 |
-
4. Search runs in background (won't block chat)
|
| 67 |
-
5. Results injected into context
|
| 68 |
-
|
| 69 |
-
**Settings explained:**
|
| 70 |
-
- **Max Results**: How many search results to fetch (4 is good default)
|
| 71 |
-
- **Max Chars/Result**: Limit length per result (50 prevents overwhelming context)
|
| 72 |
-
- **Search Timeout**: Maximum wait time (5s recommended)
|
| 73 |
-
|
| 74 |
-
### 📝 System Prompt
|
| 75 |
-
|
| 76 |
-
This defines the AI's personality and behavior.
|
| 77 |
-
|
| 78 |
-
**Default prompts:**
|
| 79 |
-
- Without search: Helpful, creative assistant
|
| 80 |
-
- With search: Includes search results and current date
|
| 81 |
-
|
| 82 |
-
**Customization ideas:**
|
| 83 |
-
```
|
| 84 |
-
You are a professional code reviewer...
|
| 85 |
-
You are a creative writing coach...
|
| 86 |
-
You are a patient tutor explaining concepts simply...
|
| 87 |
-
You are a technical documentation writer...
|
| 88 |
-
```
|
| 89 |
-
|
| 90 |
-
## Advanced Features
|
| 91 |
-
|
| 92 |
-
### 🎛️ Advanced Generation Parameters
|
| 93 |
-
|
| 94 |
-
Click the accordion to reveal these controls:
|
| 95 |
-
|
| 96 |
-
#### Max Tokens (64-16384)
|
| 97 |
-
- **What it does**: Sets maximum response length
|
| 98 |
-
- **Lower (256-512)**: Quick, concise answers
|
| 99 |
-
- **Medium (1024)**: Balanced (default)
|
| 100 |
-
- **Higher (2048+)**: Long-form content, detailed explanations
|
| 101 |
-
|
| 102 |
-
#### Temperature (0.1-2.0)
|
| 103 |
-
- **What it does**: Controls randomness/creativity
|
| 104 |
-
- **Low (0.1-0.3)**: Focused, deterministic (good for facts, code)
|
| 105 |
-
- **Medium (0.7)**: Balanced creativity (default)
|
| 106 |
-
- **High (1.2-2.0)**: Very creative, unpredictable (stories, brainstorming)
|
| 107 |
-
|
| 108 |
-
#### Top-K (1-100)
|
| 109 |
-
- **What it does**: Limits token choices to top K most likely
|
| 110 |
-
- **Lower (10-20)**: More focused
|
| 111 |
-
- **Medium (40)**: Balanced (default)
|
| 112 |
-
- **Higher (80-100)**: More varied vocabulary
|
| 113 |
-
|
| 114 |
-
#### Top-P (0.1-1.0)
|
| 115 |
-
- **What it does**: Nucleus sampling threshold
|
| 116 |
-
- **Lower (0.5-0.7)**: Conservative choices
|
| 117 |
-
- **Medium (0.9)**: Balanced (default)
|
| 118 |
-
- **Higher (0.95-1.0)**: Full vocabulary range
|
| 119 |
-
|
| 120 |
-
#### Repetition Penalty (1.0-2.0)
|
| 121 |
-
- **What it does**: Reduces repeated words/phrases
|
| 122 |
-
- **Low (1.0-1.1)**: Allows some repetition
|
| 123 |
-
- **Medium (1.2)**: Balanced (default)
|
| 124 |
-
- **High (1.5+)**: Strongly avoids repetition (may hurt coherence)
|
| 125 |
-
|
| 126 |
-
### Preset Configurations
|
| 127 |
-
|
| 128 |
-
**For Creative Writing:**
|
| 129 |
-
```
|
| 130 |
-
Temperature: 1.2
|
| 131 |
-
Top-P: 0.95
|
| 132 |
-
Top-K: 80
|
| 133 |
-
Max Tokens: 2048
|
| 134 |
-
```
|
| 135 |
-
|
| 136 |
-
**For Code Generation:**
|
| 137 |
-
```
|
| 138 |
-
Temperature: 0.3
|
| 139 |
-
Top-P: 0.9
|
| 140 |
-
Top-K: 40
|
| 141 |
-
Max Tokens: 1024
|
| 142 |
-
Repetition Penalty: 1.1
|
| 143 |
-
```
|
| 144 |
-
|
| 145 |
-
**For Factual Q&A:**
|
| 146 |
-
```
|
| 147 |
-
Temperature: 0.5
|
| 148 |
-
Top-P: 0.85
|
| 149 |
-
Top-K: 30
|
| 150 |
-
Max Tokens: 512
|
| 151 |
-
Enable Web Search: Yes
|
| 152 |
-
```
|
| 153 |
-
|
| 154 |
-
**For Reasoning Tasks:**
|
| 155 |
-
```
|
| 156 |
-
Model: Phi-4-mini-Reasoning or DeepSeek-R1
|
| 157 |
-
Temperature: 0.7
|
| 158 |
-
Max Tokens: 2048
|
| 159 |
-
```
|
| 160 |
-
|
| 161 |
-
## Tips & Tricks
|
| 162 |
-
|
| 163 |
-
### 🎯 Getting Better Results
|
| 164 |
-
|
| 165 |
-
1. **Be Specific**: "Write a Python function to sort a list" → "Write a Python function that sorts a list of dictionaries by a specific key"
|
| 166 |
-
|
| 167 |
-
2. **Provide Context**: "Explain recursion" → "Explain recursion to someone learning programming for the first time, with a simple example"
|
| 168 |
-
|
| 169 |
-
3. **Use System Prompts**: Define role/expertise in system prompt instead of every message
|
| 170 |
-
|
| 171 |
-
4. **Iterate**: Use follow-up questions to refine responses
|
| 172 |
-
|
| 173 |
-
5. **Experiment with Models**: Try different models for the same task
|
| 174 |
-
|
| 175 |
-
### ⚡ Performance Tips
|
| 176 |
-
|
| 177 |
-
1. **Start Small**: Test with smaller models first
|
| 178 |
-
2. **Adjust Max Tokens**: Don't request more than you need
|
| 179 |
-
3. **Use Cancel**: Stop bad generations early
|
| 180 |
-
4. **Clear Cache**: Clear chat if experiencing slowdowns
|
| 181 |
-
5. **One Task at a Time**: Don't send multiple requests simultaneously
|
| 182 |
-
|
| 183 |
-
### 🔍 When to Use Web Search
|
| 184 |
-
|
| 185 |
-
**✅ Good use cases:**
|
| 186 |
-
- "What happened in the latest SpaceX launch?"
|
| 187 |
-
- "Current cryptocurrency prices"
|
| 188 |
-
- "Recent AI research papers"
|
| 189 |
-
- "Today's weather in Paris"
|
| 190 |
-
|
| 191 |
-
**❌ Don't need search for:**
|
| 192 |
-
- General knowledge questions
|
| 193 |
-
- Code writing/debugging
|
| 194 |
-
- Math problems
|
| 195 |
-
- Creative writing
|
| 196 |
-
- Theoretical explanations
|
| 197 |
-
|
| 198 |
-
### 💭 Understanding Thinking Mode
|
| 199 |
-
|
| 200 |
-
Some models output `<think>...</think>` blocks:
|
| 201 |
-
|
| 202 |
-
```
|
| 203 |
-
<think>
|
| 204 |
-
Let me break this down step by step...
|
| 205 |
-
First, I need to consider...
|
| 206 |
-
</think>
|
| 207 |
-
|
| 208 |
-
Here's the answer: ...
|
| 209 |
-
```
|
| 210 |
-
|
| 211 |
-
**In the UI:**
|
| 212 |
-
- Thinking shows as "💭 Thought"
|
| 213 |
-
- Answer shows separately
|
| 214 |
-
- Helps you see the reasoning process
|
| 215 |
-
|
| 216 |
-
**Best for:**
|
| 217 |
-
- Complex math problems
|
| 218 |
-
- Multi-step reasoning
|
| 219 |
-
- Debugging logic
|
| 220 |
-
- Learning how AI thinks
|
| 221 |
-
|
| 222 |
-
## Troubleshooting
|
| 223 |
-
|
| 224 |
-
### Generation is Slow
|
| 225 |
-
- Try a smaller model
|
| 226 |
-
- Reduce Max Tokens
|
| 227 |
-
- Disable web search if not needed
|
| 228 |
-
- Clear chat history
|
| 229 |
-
|
| 230 |
-
### Responses are Repetitive
|
| 231 |
-
- Increase Repetition Penalty
|
| 232 |
-
- Reduce Temperature slightly
|
| 233 |
-
- Try different model
|
| 234 |
-
|
| 235 |
-
### Responses are Random/Nonsensical
|
| 236 |
-
- Decrease Temperature
|
| 237 |
-
- Reduce Top-P
|
| 238 |
-
- Reduce Top-K
|
| 239 |
-
- Try more stable model
|
| 240 |
-
|
| 241 |
-
### Web Search Not Working
|
| 242 |
-
- Check timeout isn't too short
|
| 243 |
-
- Verify internet connection
|
| 244 |
-
- Try increasing Max Results
|
| 245 |
-
- Check search query in debug panel
|
| 246 |
-
|
| 247 |
-
### Cancel Button Doesn't Work
|
| 248 |
-
- Wait a moment (might be processing)
|
| 249 |
-
- Refresh page if persists
|
| 250 |
-
- Check browser console for errors
|
| 251 |
-
|
| 252 |
-
## Keyboard Shortcuts
|
| 253 |
-
|
| 254 |
-
- **Enter**: Send message
|
| 255 |
-
- **Shift+Enter**: New line in input
|
| 256 |
-
- **Ctrl+C**: Copy (when text selected)
|
| 257 |
-
- **Ctrl+A**: Select all in input
|
| 258 |
-
|
| 259 |
-
## Best Practices
|
| 260 |
-
|
| 261 |
-
### For Beginners
|
| 262 |
-
1. Start with example prompts
|
| 263 |
-
2. Use default settings initially
|
| 264 |
-
3. Try 2-4 different models
|
| 265 |
-
4. Gradually explore advanced settings
|
| 266 |
-
5. Read responses fully before replying
|
| 267 |
-
|
| 268 |
-
### For Power Users
|
| 269 |
-
1. Create custom system prompts
|
| 270 |
-
2. Fine-tune parameters per task
|
| 271 |
-
3. Use debug panel for prompt engineering
|
| 272 |
-
4. Experiment with model combinations
|
| 273 |
-
5. Utilize web search strategically
|
| 274 |
-
|
| 275 |
-
### For Developers
|
| 276 |
-
1. Study the debug output
|
| 277 |
-
2. Test code generation thoroughly
|
| 278 |
-
3. Use lower temperature for determinism
|
| 279 |
-
4. Compare multiple models
|
| 280 |
-
5. Save working configurations
|
| 281 |
-
|
| 282 |
-
## Privacy & Safety
|
| 283 |
-
|
| 284 |
-
- **No data collection**: Conversations not stored permanently
|
| 285 |
-
- **Model limitations**: May produce incorrect information
|
| 286 |
-
- **Verify important info**: Don't rely solely on AI for critical decisions
|
| 287 |
-
- **Web search**: Uses DuckDuckGo (privacy-focused)
|
| 288 |
-
- **Open source**: Code is transparent and auditable
|
| 289 |
-
|
| 290 |
-
## Support & Feedback
|
| 291 |
-
|
| 292 |
-
Found a bug? Have a suggestion?
|
| 293 |
-
- Check GitHub issues
|
| 294 |
-
- Submit feature requests
|
| 295 |
-
- Contribute improvements
|
| 296 |
-
- Share your use cases
|
| 297 |
-
|
| 298 |
-
---
|
| 299 |
-
|
| 300 |
-
**Happy chatting! 🎉**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|