157 lines
3.0 KiB
Markdown
157 lines
3.0 KiB
Markdown
# Quick Start Guide
|
|
|
|
## 1. Setup Audio Devices
|
|
|
|
```bash
|
|
# List available audio devices
|
|
./run_transcribe.sh --list-devices
|
|
```
|
|
|
|
Find your:
|
|
- **Microphone** - Your input device (e.g., "USB Microphone")
|
|
- **Monitor** - Speaker capture device (e.g., "Monitor of Built-in Audio")
|
|
|
|
---
|
|
|
|
## 2. Basic Usage
|
|
|
|
### Simple Transcription
|
|
```bash
|
|
# Auto-detect devices
|
|
./run_transcribe.sh --model medium --language en
|
|
|
|
# Specify devices
|
|
./run_transcribe.sh --mic "USB Mic" --monitor "Monitor"
|
|
```
|
|
|
|
### With File Output
|
|
```bash
|
|
./run_transcribe.sh --model medium --language en --output transcript.txt
|
|
```
|
|
|
|
### With LLM Analysis
|
|
```bash
|
|
./run_transcribe.sh --model medium --enable-llm --output enriched.txt
|
|
```
|
|
|
|
---
|
|
|
|
## 3. Language Examples
|
|
|
|
### Dutch (Nederlands)
|
|
```bash
|
|
./run_transcribe.sh --model medium --language nl --enable-llm
|
|
```
|
|
|
|
### Spanish
|
|
```bash
|
|
./run_transcribe.sh --model medium --language es
|
|
```
|
|
|
|
### French
|
|
```bash
|
|
./run_transcribe.sh --model medium --language fr
|
|
```
|
|
|
|
### German
|
|
```bash
|
|
./run_transcribe.sh --model medium --language de
|
|
```
|
|
|
|
---
|
|
|
|
## 4. Model Selection
|
|
|
|
| Model | Speed | Quality | Command |
|
|
|--------|----------|---------|----------------------------------|
|
|
| tiny | Fastest | Basic | `--model tiny` |
|
|
| base | Fast | Good | `--model base` |
|
|
| small | Moderate | Better | `--model small` |
|
|
| medium | Slow | Great | `--model medium` **(recommended)** |
|
|
| large | Slowest | Best | `--model large` |
|
|
|
|
---
|
|
|
|
## 5. Optimization Tips
|
|
|
|
### High Quality Transcription
|
|
```bash
|
|
./run_transcribe.sh --model large --interval 8 --min-duration 4
|
|
```
|
|
|
|
### Fast Real-Time
|
|
```bash
|
|
./run_transcribe.sh --model tiny --interval 3 --min-duration 2
|
|
```
|
|
|
|
### Best Dutch Transcription (Your Setup)
|
|
```bash
|
|
./run_transcribe.sh --model medium --interval 8 --min-duration 4 --enable-llm --language nl
|
|
```
|
|
|
|
---
|
|
|
|
## 6. LLM Configuration
|
|
|
|
### Default Model (qwen2.5:3b - Fast)
|
|
```bash
|
|
./run_transcribe.sh --enable-llm
|
|
```
|
|
|
|
### Larger Model (Better Analysis)
|
|
```bash
|
|
# Install model first
|
|
ollama pull llama3.2
|
|
|
|
# Use it
|
|
./run_transcribe.sh --enable-llm --llm-model llama3.2
|
|
```
|
|
|
|
---
|
|
|
|
## 7. Output Examples
|
|
|
|
### Console Output
|
|
```
|
|
🎤 [14:23:15] User speaking via microphone
|
|
🔊 [14:23:20] Audio from speakers
|
|
|
|
🎤 [14:23:25] The Earth orbits the Sun in 365 days.
|
|
✅ FACTUAL (0.98): Scientifically accurate.
|
|
❓ Questions:
|
|
1. Why do we need leap years?
|
|
2. How does orbital speed vary?
|
|
3. What affects Earth's orbit?
|
|
```
|
|
|
|
### File Output
|
|
Saved to `transcript.txt` or your specified file with timestamps and analysis.
|
|
|
|
---
|
|
|
|
## 8. Controls
|
|
|
|
- **Ctrl+C** - Stop transcription
|
|
- Processing happens every `--interval` seconds (default: 5s)
|
|
- Minimum `--min-duration` audio required (default: 2s)
|
|
|
|
---
|
|
|
|
## Troubleshooting
|
|
|
|
**No devices found:**
|
|
```bash
|
|
./run_transcribe.sh --list-devices
|
|
```
|
|
|
|
**Ollama errors:**
|
|
```bash
|
|
ollama serve
|
|
ollama pull qwen2.5:3b
|
|
```
|
|
|
|
**Force CPU (GPU issues):**
|
|
```bash
|
|
./run_transcribe.sh --force-cpu
|
|
```
|