From 0af379c465bb2bfe6c5642705bed073204166522 Mon Sep 17 00:00:00 2001 From: Quentin Fuxa Date: Thu, 23 Oct 2025 20:32:05 +0200 Subject: [PATCH] DOC: information about file format --- available_models.md => docs/available_models.md | 0 docs/models_compatible_formats.md | 14 ++++++++++++++ .../simul_whisper/license_simulstreaming.py | 5 ----- 3 files changed, 14 insertions(+), 5 deletions(-) rename available_models.md => docs/available_models.md (100%) create mode 100644 docs/models_compatible_formats.md delete mode 100644 whisperlivekit/simul_whisper/license_simulstreaming.py diff --git a/available_models.md b/docs/available_models.md similarity index 100% rename from available_models.md rename to docs/available_models.md diff --git a/docs/models_compatible_formats.md b/docs/models_compatible_formats.md new file mode 100644 index 0000000..fb34d8e --- /dev/null +++ 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) \ No newline at end of file diff --git a/whisperlivekit/simul_whisper/license_simulstreaming.py b/whisperlivekit/simul_whisper/license_simulstreaming.py deleted file mode 100644 index 142d312..0000000 --- a/whisperlivekit/simul_whisper/license_simulstreaming.py +++ /dev/null @@ -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. -""" \ No newline at end of file