From 412a478e2978d9a47d39bad2a3f5072231a250c7 Mon Sep 17 00:00:00 2001 From: Dimitrii Voronin <36505480+adamnsandle@users.noreply.github.com> Date: Tue, 9 Jul 2024 12:25:06 +0300 Subject: [PATCH] Update README.md --- README.md | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 719fa25..3d7cafa 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,34 @@ https://user-images.githubusercontent.com/36505480/144874384-95f80f6d-a4f1-42cc-
+ +

Fast start

+
+ +**Using pip**: +`pip install silero-vad` + +```python3 +from silero_vad import load_silero_vad, read_audio, get_speech_timestamps +model = load_silero_vad() +wav = read_audio('path_to_audio_file') # backend (sox, soundfile, or ffmpeg) required! +speech_timestamps = get_speech_timestamps(wav, model) +``` + +**Using torch.hub**: +```python3 +import torch +torch.set_num_threads(1) + +model, utils = torch.hub.load(repo_or_dir='snakers4/silero-vad', model='silero_vad') +(get_speech_timestamps, _, read_audio, _, _) = utils + +wav = read_audio('path_to_audio_file') # backend (sox, soundfile, or ffmpeg) required! +speech_timestamps = get_speech_timestamps(wav, model) +``` + +
+

Key Features


@@ -57,21 +85,7 @@ https://user-images.githubusercontent.com/36505480/144874384-95f80f6d-a4f1-42cc- Published under permissive license (MIT) Silero VAD has zero strings attached - no telemetry, no keys, no registration, no built-in expiration, no keys or vendor lock.
-

Fast start

-
-```python3 -import torch -torch.set_num_threads(1) - -model, utils = torch.hub.load(repo_or_dir='snakers4/silero-vad', model='silero_vad') -(get_speech_timestamps, _, read_audio, _, _) = utils - -wav = read_audio('path_to_audio_file') -speech_timestamps = get_speech_timestamps(wav, model) -``` - -

Typical Use Cases