Skip to content

Commit 0ac2ab2

Browse files
committed
Add info about constants, improve styling
1 parent 72ac2eb commit 0ac2ab2

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/docs/speech-to-text/speech-to-text.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,22 @@ try {
3535
Given that STT models need to take in a specified sequence length, there is a need to chunk the input audio. Chunking audio may result in cutting speech mid-sentence, which might be hard to understand for the model. To make it work, we employed an algorithm that uses overlapping audio chunks which might introduce some overhead, but gives way better results.
3636

3737
### Arguments
38-
**`encoderSource`**
39-
A string that specifies the location of a .pte file for the encoder. For further information on passing model sources, check out [Loading Models](https://docs.swmansion.com/react-native-executorch/docs/fundamentals/loading-models).
38+
**`modelName`**
39+
A literal of `"moonshine" | "whisper"` which serves as an identifier for which model should be used.
4040

41-
`decoderSource?`
42-
Analogous to the encoderSource, this takes in a string which is a source for the decoder part of the model. Defaults to our [HuggingFace repositories]().
41+
**`encoderSource?`**
42+
A string that specifies the location of a .pte file for the encoder. For further information on passing model sources, check out [Loading Models](https://docs.swmansion.com/react-native-executorch/docs/fundamentals/loading-models). Defaults to (constants)[https://github.com/software-mansion/react-native-executorch/blob/main/src/constants/modelUrls.ts] for given model.
4343

44-
`tokenizerSource?`
45-
A string that specifies the location to the tokenizer for the model. This works just as the encoder and decoder do. Defaults to our [HuggingFace repositories]().
44+
**`decoderSource?`**
45+
Analogous to the encoderSource, this takes in a string which is a source for the decoder part of the model. Defaults to [constants](https://github.com/software-mansion/react-native-executorch/blob/main/src/constants/modelUrls.ts) for given model.
4646

47-
`modelName?`
48-
A literal of `"moonshine" | "whisper"` which serves as an identifier for which model should be used. Defaults to our [HuggingFace repositories]().
47+
**`tokenizerSource?`**
48+
A string that specifies the location to the tokenizer for the model. This works just as the encoder and decoder do. Defaults to [constants](https://github.com/software-mansion/react-native-executorch/blob/main/src/constants/modelUrls.ts) for given model.
4949

50-
`overlapSeconds?`
50+
**`overlapSeconds?`**
5151
Specifies the length of overlap between each audio chunk.
5252

53-
`windowSize?`
53+
**`windowSize?`**
5454
Specifies the size of each audio chunk.
5555

5656
### Returns

0 commit comments

Comments
 (0)