* docs: deep audit — fix stale config keys, missing commands, and registry drift Cross-checked ~80 high-impact docs pages (getting-started, reference, top-level user-guide, user-guide/features) against the live registries: hermes_cli/commands.py COMMAND_REGISTRY (slash commands) hermes_cli/auth.py PROVIDER_REGISTRY (providers) hermes_cli/config.py DEFAULT_CONFIG (config keys) toolsets.py TOOLSETS (toolsets) tools/registry.py get_all_tool_names() (tools) python -m hermes_cli.main <subcmd> --help (CLI args) reference/ - cli-commands.md: drop duplicate hermes fallback row + duplicate section, add stepfun/lmstudio to --provider enum, expand auth/mcp/curator subcommand lists to match --help output (status/logout/spotify, login, archive/prune/ list-archived). - slash-commands.md: add missing /sessions and /reload-skills entries + correct the cross-platform Notes line. - tools-reference.md: drop bogus '68 tools' headline, drop fictional 'browser-cdp toolset' (these tools live in 'browser' and are runtime-gated), add missing 'kanban' and 'video' toolset sections, fix MCP example to use the real mcp_<server>_<tool> prefix. - toolsets-reference.md: list browser_cdp/browser_dialog inside the 'browser' row, add missing 'kanban' and 'video' toolset rows, drop the stale '38 tools' count for hermes-cli. - profile-commands.md: add missing install/update/info subcommands, document fish completion. - environment-variables.md: dedupe GMI_API_KEY/GMI_BASE_URL rows (kept the one with the correct gmi-serving.com default). - faq.md: Anthropic/Google/OpenAI examples — direct providers exist (not just via OpenRouter), refresh the OpenAI model list. getting-started/ - installation.md: PortableGit (not MinGit) is what the Windows installer fetches; document the 32-bit MinGit fallback. - installation.md / termux.md: installer prefers .[termux-all] then falls back to .[termux]. - nix-setup.md: Python 3.12 (not 3.11), Node.js 22 (not 20); fix invalid 'nix flake update --flake' invocation. - updating.md: 'hermes backup restore --state pre-update' doesn't exist — point at the snapshot/quick-snapshot flow; correct config key 'updates.pre_update_backup' (was 'update.backup'). user-guide/ - configuration.md: api_max_retries default 3 (not 2); display.runtime_footer is the real key (not display.runtime_metadata_footer); checkpoints defaults enabled=false / max_snapshots=20 (not true / 50). - configuring-models.md: 'hermes model list' / 'hermes model set ...' don't exist — hermes model is interactive only. - tui.md: busy_indicator -> tui_status_indicator with values kaomoji|emoji|unicode|ascii (not kawaii|minimal|dots|wings|none). - security.md: SSH backend keys (TERMINAL_SSH_HOST/USER/KEY) live in .env, not config.yaml. - windows-wsl-quickstart.md: there is no 'hermes api' subcommand — the OpenAI-compatible API server runs inside hermes gateway. user-guide/features/ - computer-use.md: approvals.mode (not security.approval_level); fix broken ./browser-use.md link to ./browser.md. - fallback-providers.md: top-level fallback_providers (not model.fallback_providers); the picker is subcommand-based, not modal. - api-server.md: API_SERVER_* are env vars — write to per-profile .env, not 'hermes config set' which targets YAML. - web-search.md: drop web_crawl as a registered tool (it isn't); deep-crawl modes are exposed through web_extract. - kanban.md: failure_limit default is 2, not '~5'. - plugins.md: drop hard-coded '33 providers' count. - honcho.md: fix unclosed quote in echo HONCHO_API_KEY snippet; document that 'hermes honcho' subcommand is gated on memory.provider=honcho; reconcile subcommand list with actual --help output. - memory-providers.md: legacy 'hermes honcho setup' redirect documented. Verified via 'npm run build' — site builds cleanly; broken-link count went from 149 to 146 (no regressions, fixed a few in passing). * docs: round 2 audit fixes + regenerate skill catalogs Follow-up to the previous commit on this branch: Round 2 manual fixes: - quickstart.md: KIMI_CODING_API_KEY mentioned alongside KIMI_API_KEY; voice-mode and ACP install commands rewritten — bare 'pip install ...' doesn't work for curl-installed setups (no pip on PATH, not in repo dir); replaced with 'cd ~/.hermes/hermes-agent && uv pip install -e ".[voice]"'. ACP already ships in [all] so the curl install includes it. - cli.md / configuration.md: 'auxiliary.compression.model' shown as 'google/gemini-3-flash-preview' (the doc's own claimed default); actual default is empty (= use main model). Reworded as 'leave empty (default) or pin a cheap model'. - built-in-plugins.md: added the bundled 'kanban/dashboard' plugin row that was missing from the table. Regenerated skill catalogs: - ran website/scripts/generate-skill-docs.py to refresh all 163 per-skill pages and both reference catalogs (skills-catalog.md, optional-skills-catalog.md). This adds the entries that were genuinely missing — productivity/teams-meeting-pipeline (bundled), optional/finance/* (entire category — 7 skills: 3-statement-model, comps-analysis, dcf-model, excel-author, lbo-model, merger-model, pptx-author), creative/hyperframes, creative/kanban-video-orchestrator, devops/watchers, productivity/shop-app, research/searxng-search, apple/macos-computer-use — and rewrites every other per-skill page from the current SKILL.md. Most diffs are tiny (one line of refreshed metadata). Validation: - 'npm run build' succeeded. - Broken-link count moved 146 -> 155 — the +9 are zh-Hans translation shells that lag every newly-added skill page (pre-existing pattern). No regressions on any en/ page.
337 lines
8.0 KiB
Markdown
337 lines
8.0 KiB
Markdown
---
|
||
title: "Whisper — OpenAI's general-purpose speech recognition model"
|
||
sidebar_label: "Whisper"
|
||
description: "OpenAI's general-purpose speech recognition model"
|
||
---
|
||
|
||
{/* This page is auto-generated from the skill's SKILL.md by website/scripts/generate-skill-docs.py. Edit the source SKILL.md, not this page. */}
|
||
|
||
# Whisper
|
||
|
||
OpenAI's general-purpose speech recognition model. Supports 99 languages, transcription, translation to English, and language identification. Six model sizes from tiny (39M params) to large (1550M params). Use for speech-to-text, podcast transcription, or multilingual audio processing. Best for robust, multilingual ASR.
|
||
|
||
## Skill metadata
|
||
|
||
| | |
|
||
|---|---|
|
||
| Source | Optional — install with `hermes skills install official/mlops/whisper` |
|
||
| Path | `optional-skills/mlops/whisper` |
|
||
| Version | `1.0.0` |
|
||
| Author | Orchestra Research |
|
||
| License | MIT |
|
||
| Dependencies | `openai-whisper`, `transformers`, `torch` |
|
||
| Platforms | linux, macos |
|
||
| Tags | `Whisper`, `Speech Recognition`, `ASR`, `Multimodal`, `Multilingual`, `OpenAI`, `Speech-To-Text`, `Transcription`, `Translation`, `Audio Processing` |
|
||
|
||
## Reference: full SKILL.md
|
||
|
||
:::info
|
||
The following is the complete skill definition that Hermes loads when this skill is triggered. This is what the agent sees as instructions when the skill is active.
|
||
:::
|
||
|
||
# Whisper - Robust Speech Recognition
|
||
|
||
OpenAI's multilingual speech recognition model.
|
||
|
||
## When to use Whisper
|
||
|
||
**Use when:**
|
||
- Speech-to-text transcription (99 languages)
|
||
- Podcast/video transcription
|
||
- Meeting notes automation
|
||
- Translation to English
|
||
- Noisy audio transcription
|
||
- Multilingual audio processing
|
||
|
||
**Metrics**:
|
||
- **72,900+ GitHub stars**
|
||
- 99 languages supported
|
||
- Trained on 680,000 hours of audio
|
||
- MIT License
|
||
|
||
**Use alternatives instead**:
|
||
- **AssemblyAI**: Managed API, speaker diarization
|
||
- **Deepgram**: Real-time streaming ASR
|
||
- **Google Speech-to-Text**: Cloud-based
|
||
|
||
## Quick start
|
||
|
||
### Installation
|
||
|
||
```bash
|
||
# Requires Python 3.8-3.11
|
||
pip install -U openai-whisper
|
||
|
||
# Requires ffmpeg
|
||
# macOS: brew install ffmpeg
|
||
# Ubuntu: sudo apt install ffmpeg
|
||
# Windows: choco install ffmpeg
|
||
```
|
||
|
||
### Basic transcription
|
||
|
||
```python
|
||
import whisper
|
||
|
||
# Load model
|
||
model = whisper.load_model("base")
|
||
|
||
# Transcribe
|
||
result = model.transcribe("audio.mp3")
|
||
|
||
# Print text
|
||
print(result["text"])
|
||
|
||
# Access segments
|
||
for segment in result["segments"]:
|
||
print(f"[{segment['start']:.2f}s - {segment['end']:.2f}s] {segment['text']}")
|
||
```
|
||
|
||
## Model sizes
|
||
|
||
```python
|
||
# Available models
|
||
models = ["tiny", "base", "small", "medium", "large", "turbo"]
|
||
|
||
# Load specific model
|
||
model = whisper.load_model("turbo") # Fastest, good quality
|
||
```
|
||
|
||
| Model | Parameters | English-only | Multilingual | Speed | VRAM |
|
||
|-------|------------|--------------|--------------|-------|------|
|
||
| tiny | 39M | ✓ | ✓ | ~32x | ~1 GB |
|
||
| base | 74M | ✓ | ✓ | ~16x | ~1 GB |
|
||
| small | 244M | ✓ | ✓ | ~6x | ~2 GB |
|
||
| medium | 769M | ✓ | ✓ | ~2x | ~5 GB |
|
||
| large | 1550M | ✗ | ✓ | 1x | ~10 GB |
|
||
| turbo | 809M | ✗ | ✓ | ~8x | ~6 GB |
|
||
|
||
**Recommendation**: Use `turbo` for best speed/quality, `base` for prototyping
|
||
|
||
## Transcription options
|
||
|
||
### Language specification
|
||
|
||
```python
|
||
# Auto-detect language
|
||
result = model.transcribe("audio.mp3")
|
||
|
||
# Specify language (faster)
|
||
result = model.transcribe("audio.mp3", language="en")
|
||
|
||
# Supported: en, es, fr, de, it, pt, ru, ja, ko, zh, and 89 more
|
||
```
|
||
|
||
### Task selection
|
||
|
||
```python
|
||
# Transcription (default)
|
||
result = model.transcribe("audio.mp3", task="transcribe")
|
||
|
||
# Translation to English
|
||
result = model.transcribe("spanish.mp3", task="translate")
|
||
# Input: Spanish audio → Output: English text
|
||
```
|
||
|
||
### Initial prompt
|
||
|
||
```python
|
||
# Improve accuracy with context
|
||
result = model.transcribe(
|
||
"audio.mp3",
|
||
initial_prompt="This is a technical podcast about machine learning and AI."
|
||
)
|
||
|
||
# Helps with:
|
||
# - Technical terms
|
||
# - Proper nouns
|
||
# - Domain-specific vocabulary
|
||
```
|
||
|
||
### Timestamps
|
||
|
||
```python
|
||
# Word-level timestamps
|
||
result = model.transcribe("audio.mp3", word_timestamps=True)
|
||
|
||
for segment in result["segments"]:
|
||
for word in segment["words"]:
|
||
print(f"{word['word']} ({word['start']:.2f}s - {word['end']:.2f}s)")
|
||
```
|
||
|
||
### Temperature fallback
|
||
|
||
```python
|
||
# Retry with different temperatures if confidence low
|
||
result = model.transcribe(
|
||
"audio.mp3",
|
||
temperature=(0.0, 0.2, 0.4, 0.6, 0.8, 1.0)
|
||
)
|
||
```
|
||
|
||
## Command line usage
|
||
|
||
```bash
|
||
# Basic transcription
|
||
whisper audio.mp3
|
||
|
||
# Specify model
|
||
whisper audio.mp3 --model turbo
|
||
|
||
# Output formats
|
||
whisper audio.mp3 --output_format txt # Plain text
|
||
whisper audio.mp3 --output_format srt # Subtitles
|
||
whisper audio.mp3 --output_format vtt # WebVTT
|
||
whisper audio.mp3 --output_format json # JSON with timestamps
|
||
|
||
# Language
|
||
whisper audio.mp3 --language Spanish
|
||
|
||
# Translation
|
||
whisper spanish.mp3 --task translate
|
||
```
|
||
|
||
## Batch processing
|
||
|
||
```python
|
||
import os
|
||
|
||
audio_files = ["file1.mp3", "file2.mp3", "file3.mp3"]
|
||
|
||
for audio_file in audio_files:
|
||
print(f"Transcribing {audio_file}...")
|
||
result = model.transcribe(audio_file)
|
||
|
||
# Save to file
|
||
output_file = audio_file.replace(".mp3", ".txt")
|
||
with open(output_file, "w") as f:
|
||
f.write(result["text"])
|
||
```
|
||
|
||
## Real-time transcription
|
||
|
||
```python
|
||
# For streaming audio, use faster-whisper
|
||
# pip install faster-whisper
|
||
|
||
from faster_whisper import WhisperModel
|
||
|
||
model = WhisperModel("base", device="cuda", compute_type="float16")
|
||
|
||
# Transcribe with streaming
|
||
segments, info = model.transcribe("audio.mp3", beam_size=5)
|
||
|
||
for segment in segments:
|
||
print(f"[{segment.start:.2f}s -> {segment.end:.2f}s] {segment.text}")
|
||
```
|
||
|
||
## GPU acceleration
|
||
|
||
```python
|
||
import whisper
|
||
|
||
# Automatically uses GPU if available
|
||
model = whisper.load_model("turbo")
|
||
|
||
# Force CPU
|
||
model = whisper.load_model("turbo", device="cpu")
|
||
|
||
# Force GPU
|
||
model = whisper.load_model("turbo", device="cuda")
|
||
|
||
# 10-20× faster on GPU
|
||
```
|
||
|
||
## Integration with other tools
|
||
|
||
### Subtitle generation
|
||
|
||
```bash
|
||
# Generate SRT subtitles
|
||
whisper video.mp4 --output_format srt --language English
|
||
|
||
# Output: video.srt
|
||
```
|
||
|
||
### With LangChain
|
||
|
||
```python
|
||
from langchain.document_loaders import WhisperTranscriptionLoader
|
||
|
||
loader = WhisperTranscriptionLoader(file_path="audio.mp3")
|
||
docs = loader.load()
|
||
|
||
# Use transcription in RAG
|
||
from langchain_chroma import Chroma
|
||
from langchain_openai import OpenAIEmbeddings
|
||
|
||
vectorstore = Chroma.from_documents(docs, OpenAIEmbeddings())
|
||
```
|
||
|
||
### Extract audio from video
|
||
|
||
```bash
|
||
# Use ffmpeg to extract audio
|
||
ffmpeg -i video.mp4 -vn -acodec pcm_s16le audio.wav
|
||
|
||
# Then transcribe
|
||
whisper audio.wav
|
||
```
|
||
|
||
## Best practices
|
||
|
||
1. **Use turbo model** - Best speed/quality for English
|
||
2. **Specify language** - Faster than auto-detect
|
||
3. **Add initial prompt** - Improves technical terms
|
||
4. **Use GPU** - 10-20× faster
|
||
5. **Batch process** - More efficient
|
||
6. **Convert to WAV** - Better compatibility
|
||
7. **Split long audio** - <30 min chunks
|
||
8. **Check language support** - Quality varies by language
|
||
9. **Use faster-whisper** - 4× faster than openai-whisper
|
||
10. **Monitor VRAM** - Scale model size to hardware
|
||
|
||
## Performance
|
||
|
||
| Model | Real-time factor (CPU) | Real-time factor (GPU) |
|
||
|-------|------------------------|------------------------|
|
||
| tiny | ~0.32 | ~0.01 |
|
||
| base | ~0.16 | ~0.01 |
|
||
| turbo | ~0.08 | ~0.01 |
|
||
| large | ~1.0 | ~0.05 |
|
||
|
||
*Real-time factor: 0.1 = 10× faster than real-time*
|
||
|
||
## Language support
|
||
|
||
Top-supported languages:
|
||
- English (en)
|
||
- Spanish (es)
|
||
- French (fr)
|
||
- German (de)
|
||
- Italian (it)
|
||
- Portuguese (pt)
|
||
- Russian (ru)
|
||
- Japanese (ja)
|
||
- Korean (ko)
|
||
- Chinese (zh)
|
||
|
||
Full list: 99 languages total
|
||
|
||
## Limitations
|
||
|
||
1. **Hallucinations** - May repeat or invent text
|
||
2. **Long-form accuracy** - Degrades on >30 min audio
|
||
3. **Speaker identification** - No diarization
|
||
4. **Accents** - Quality varies
|
||
5. **Background noise** - Can affect accuracy
|
||
6. **Real-time latency** - Not suitable for live captioning
|
||
|
||
## Resources
|
||
|
||
- **GitHub**: https://github.com/openai/whisper ⭐ 72,900+
|
||
- **Paper**: https://arxiv.org/abs/2212.04356
|
||
- **Model Card**: https://github.com/openai/whisper/blob/main/model-card.md
|
||
- **Colab**: Available in repo
|
||
- **License**: MIT
|