Skip to content

Commit

Permalink
Update API doc (#182)
Browse files Browse the repository at this point in the history
* update and fix docs

* fix typo

* update docs, add default values and add stream to VAD options
  • Loading branch information
alielbekov authored Jan 9, 2025
1 parent ba977e2 commit 6ba6da8
Show file tree
Hide file tree
Showing 6 changed files with 187 additions and 135 deletions.
6 changes: 6 additions & 0 deletions docs/css/custom-overrides.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.md-typeset table td:nth-child(1) code,
.md-typeset table th:nth-child(1) code,
.md-typeset table td:nth-child(2) code,
.md-typeset table th:nth-child(2) code {
word-break: normal;
}
12 changes: 6 additions & 6 deletions docs/user-guide/algorithm.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ The VAD algorithm works as follows:

All of the main APIs accept certain common configuration parameters that modify the VAD algorithm.

* `positiveSpeechThreshold: number` - determines the threshold over which a probability is considered to indicate the presence of speech.
* `negativeSpeechThreshold: number` - determines the threshold under which a probability is considered to indicate the absence of speech.
* `redemptionFrames: number` - number of speech-negative frames to wait before ending a speech segment.
* `frameSamples: number` - the size of a frame in samples. For the older (default) Silero model, this should probably be 1536. For the new, Silero version 5 model, it should be 512.
* `preSpeechPadFrames: number` - number of audio frames to prepend to a speech segment.
* `minSpeechFrames: number` - minimum number of speech-positive frames for a speech segment.
* `positiveSpeechThreshold: number` - determines the threshold over which a probability is considered to indicate the presence of speech. default: `0.5`
* `negativeSpeechThreshold: number` - determines the threshold under which a probability is considered to indicate the absence of speech. default: `0.35`
* `redemptionFrames: number` - number of speech-negative frames to wait before ending a speech segment. default: `8`
* `frameSamples: number` - the size of a frame in samples. For the older (default) Silero model, this should probably be 1536. For the new, Silero version 5 model, it should be 512. default: `1536`
* `preSpeechPadFrames: number` - number of audio frames to prepend to a speech segment. default: `1`
* `minSpeechFrames: number` - minimum number of speech-positive frames for a speech segment. default: `3`
Loading

0 comments on commit 6ba6da8

Please sign in to comment.