DOC: information about file format

2025-10-23 20:32:05 +02:00 · 2025-10-23 20:32:05 +02:00 · 0af379c465
commit 0af379c465
parent 9c5bb5df19
3 changed files with 14 additions and 5 deletions
--- a/docs/available_models.md
+++ b/docs/available_models.md
--- a/docs/models_compatible_formats.md
+++ b/docs/models_compatible_formats.md
@ -0,0 +1,14 @@
+# Model Path Formats
+
+The `--model-path` parameter accepts:
+
+## File Path
+- **`.pt` format only** (required for AlignAtt policy decoder)
+
+## Directory Path (recommended)
+Must contain:
+- **`.pt` file** (required for decoder)
+
+May optionally contain:
+- **`.bin` file** - faster-whisper model for encoder (requires faster-whisper)
+- **`weights.npz`** or **`weights.safetensors`** - for encoder (requires whisper-mlx)
--- a/whisperlivekit/simul_whisper/license_simulstreaming.py
+++ b/whisperlivekit/simul_whisper/license_simulstreaming.py
@ -1,5 +0,0 @@
-SIMULSTREAMING_LICENSE = f"""
-SimulStreaming backend is dual-licensed:
-• Non-Commercial Use: PolyForm Noncommercial License 1.0.0.
-• Commercial Use: Check SimulStreaming README (github.com/ufal/SimulStreaming) for more details.
-"""