Update 0.6.6 (#6)

* Update README.md

* Get fix for libs version (#5)

* Update README.md

* Fix/lib verison (#4)

* fix: conflict version for onnxruntime

* Update README.md

* Create README.md for pypi

* Update USAGE.md

* Update _version.py

* fix: update logger in asr.py and model_downloader.py, add base tests, add README.hf.md

* feat: add pytest.

* fix: change dtypes.py, update logger.py

* fix: change README.

* feat: add silero-vad lib

* fix: silero-vad import utils

* feat: update new version of package.

---------

Co-authored-by: ashimohin <ashimohin@kbl-kr.ru>

Author: Alenkar

.gitignore

@@ -3,6 +3,4 @@
 /kairos_asr.egg-info
 .idea
 /train
-/docs/README.hf.md
 __pycache__/
-/docs/README.md

docs/README.hf.md

@@ -0,0 +1,93 @@
+ ![image](assets/logo.png)
+ 
+ # Kairos Automatic Speech Recognition (Hugging Face)
+ 
+ [GitHub: Alenkar/kairos-asr](https://github.com/Alenkar/kairos-asr)
+
+## 📄 Описание
+
+**Kairos ASR** — высокопроизводительная библиотека распознавания русской речи на базе [GigaAM-style RNN-T](https://github.com/salute-developers/GigaAM) и **ONNX**. Фокус: скорость, точность и простая интеграция в микросервисы и десктопы.
+
+Основные возможности:
+- Оптимизированный ONNX-инференс
+- **CPU** и **GPU (CUDA, extra `[gpu]`)**
+- Временные метки (**word-level**, **sentence-level**)
+- Итеративная обработка с прогрессом и ETA
+- Встроенный **Voice-Activity-Detection (VAD)**
+- Поддержка длинных аудио
+- Поддержка **Windows** и **Linux**
+
+## 📦 Файлы в этом репозитории HF
+
+Модельный репозиторий `Alenkar/KairosASR` содержит:
+- `kairos_asr_encoder.onnx`
+- `kairos_asr_decoder.onnx`
+- `kairos_asr_joint.onnx`
+- `kairos_asr_tokenizer.model`
+
+`kairos-asr` загружает эти файлы через `huggingface_hub` автоматически. Можно скачать вручную:
+
+```python
+from huggingface_hub import hf_hub_download
+
+path = hf_hub_download("Alenkar/KairosASR", "kairos_asr_encoder.onnx")
+print(path)
+```
+
+## ⚡ Быстрый старт
+
+```bash
+pip install kairos-asr[cpu]
+# для GPU: pip install kairos-asr[gpu]
+```
+
+Если нужна конкретная сборка Torch под вашу CUDA:
+
+```bash
+# пример под CUDA 12.1/12.2 (cu121)
+pip install torch==2.6.0 torchaudio==2.6.0 \
+  --index-url https://download.pytorch.org/whl/cu121 --upgrade
+```
+
+## 🚀 Использование (Python)
+
+Минимальный пример:
+
+```python
+from kairos_asr import KairosASR
+
+asr = KairosASR()  # авто-загрузка весов с HF
+result = asr.transcribe(wav_file="audio.wav")
+print(result.full_text)
+```
+
+Требования к аудио:
+- Любые форматы, поддерживаемые `ffmpeg`; ресемплинг до 16 kHz.
+- WAV PCM 16-bit mono (рекомендуется); стерео приводится к моно.
+- Длинные записи режутся Silero VAD на ~15–25 c (жёсткий лимит ~30 c) и объединяются.
+
+## 🖥️ Использование (CLI)
+
+Установите пакет, затем:
+
+```bash
+# Проверить окружение
+kairos-asr doctor
+
+# Список локальных/доступных моделей
+kairos-asr list
+
+# Скачать все модели заранее
+kairos-asr download
+
+# Перевести файл в текст
+kairos-asr transcribe <wav_file>
+```
+
+## ⚙️ Системные требования
+- `ffmpeg` должен быть доступен в `PATH` (загрузка и ресемплинг аудио).
+- Доступ в интернет при первом запуске: скачивание весов моделей. Для ускорения и избежания лимитов задайте `HF_TOKEN` (`huggingface-cli login` или экспорт переменной окружения).
+
+## Больше информации
+
+Для получения дополнительной информации об исходной модели смотрите ее [карточку модели](https://huggingface.co/ai-sage/GigaAM-v3).

docs/README.md

@@ -64,4 +64,4 @@ kairos-asr transcribe <wav_file>
 
 ## ⚙️ Системные требования
 - `ffmpeg` должен быть доступен в `PATH` (загрузка и ресемплинг аудио).
-- Доступ в интернет при первом запуске: скачивание весов с Hugging Face и модели Silero VAD через `torch.hub`. Для ускорения и избежания лимитов задайте `HF_TOKEN` (`huggingface-cli login` или экспорт переменной окружения).
+- Доступ в интернет при первом запуске: скачивание весов моделей. Для ускорения и избежания лимитов задайте `HF_TOKEN` (`huggingface-cli login` или экспорт переменной окружения).

docs/USAGE.md

@@ -24,24 +24,11 @@ print(asr.transcribe("audio.wav").full_text)
 и оптимизированы для **ONNX**-инференса.
 
 По умолчанию веса загружаются автоматически. При 
-необходимости можно указать путь вручную
-или управлять загрузками через утилиту `ModelDownloader`:
+необходимости можно указать путь вручную:
 ```python
 from kairos_asr import KairosASR
 
-weights_dir_path = "<ваш путь до весов>"
-
-encoder_path   = f"{weights_dir_path}/kairos_asr_encoder.onnx"
-decoder_path   = f"{weights_dir_path}/kairos_asr_decoder.onnx"
-joint_path     = f"{weights_dir_path}/kairos_asr_joint.onnx"
-tokenizer_path = f"{weights_dir_path}/kairos_asr_tokenizer.model"
-
-asr = KairosASR(
-    encoder_path=encoder_path,
-    decoder_path=decoder_path,
-    tokenizer_path=tokenizer_path,
-    joint_path=joint_path
-)
+asr = KairosASR(model_path="<ваш путь до весов>")
 ```
 
 Автозагрузка:
@@ -50,23 +37,21 @@ from kairos_asr import KairosASR
 asr = KairosASR()
 ```
 
-Явный контроль загрузок:
+Явный контроль загрузок через утилиту `ModelDownloader`:
 ```python
 from kairos_asr.models.utils.model_downloader import ModelDownloader
 
-downloader = ModelDownloader()
+downloader = ModelDownloader()  # также можно указать model_path="<ваш путь до весов>"
 
 # Скачать все модели
-paths = downloader.download_all_models()
-
-# Получить путь до конкретной модели
-encoder_path = downloader.get_model_path("encoder")
+paths = downloader.download_all()
 
 # Скачать конкретную модель
-encoder_path = downloader.download_model("encoder")
+encoder_path = downloader.download_file("encoder")
+
+# Получить путь до конкретной модели
+encoder_path = downloader.check_local_file("encoder")
 
-# Проверить наличие локально без загрузки
-has_tokenizer = downloader.check_file_exists_local("tokenizer")
 ```
 
 ## Требования к аудио (`wav_file`)

kairos_asr/__init__.py

@@ -5,18 +5,18 @@
     check_device,
     extract_sentences_from_words,
     setup_logging,
-    get_logger,
 )
 from .models import ModelDownloader
 
+setup_logging(logger_name="kairos_asr")
+
 __all__ = [
     "KairosASR",
     "__version__",
     "check_device",
     "extract_sentences_from_words",
     "setup_logging",
-    "get_logger",
     "dtypes",
     "audio_utils",
     "ModelDownloader",
-]
+]

kairos_asr/_version.py

@@ -1 +1 @@
-__version__ = "0.6.5"
+__version__ = "0.6.6"

kairos_asr/core/__init__.py

@@ -1,5 +1,5 @@
 from .asr import KairosASR
-from .data_classes import dtypes
+from . import dtypes
 
 
 __all__ = ["KairosASR", "dtypes"]