Skip to content

Commit 920ebf4

Browse files
authored
docs: Update model property in useTextToSpeech documentation (#960)
## Description Docs does not build on next, this probably fixes it. ### Introduces a breaking change? - [ ] Yes - [x] No ### Type of change - [ ] Bug fix (change which fixes an issue) - [ ] New feature (change which adds functionality) - [ ] Documentation update (improves or adds clarity to existing documentation) - [x] Other (chores, tests, code style improvements etc.) ### Tested on - [ ] iOS - [ ] Android ### Testing instructions <!-- Provide step-by-step instructions on how to test your changes. Include setup details if necessary. --> ### Screenshots <!-- Add screenshots here, if applicable --> ### Related issues <!-- Link related issues here using #issue-number --> ### Checklist - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [x] I have updated the documentation accordingly - [x] My changes generate no new warnings ### Additional notes <!-- Include any additional information, assumptions, or context that reviewers might need to understand this PR. -->
1 parent e827156 commit 920ebf4

File tree

2 files changed

+2
-2
lines changed
  • docs/docs/03-hooks/01-natural-language-processing
  • packages/react-native-executorch/src/hooks/natural_language_processing

2 files changed

+2
-2
lines changed

docs/docs/03-hooks/01-natural-language-processing/useTextToSpeech.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ const handleSpeech = async (text: string) => {
6565

6666
`useTextToSpeech` takes [`TextToSpeechProps`](../../06-api-reference/interfaces/TextToSpeechProps.md) that consists of:
6767

68-
- `model` of type [`KokoroConfig`](../../06-api-reference/interfaces/KokoroConfig.md) containing the [`durationPredictorSource`](../../06-api-reference/interfaces/KokoroConfig.md#durationpredictorsource), [`synthesizerSource`](../../06-api-reference/interfaces/KokoroConfig.md#synthesizersource), and [`type`](../../06-api-reference/interfaces/KokoroConfig.md#type).
68+
- `model` of type [`KokoroConfig`](../../06-api-reference/interfaces/KokoroConfig.md) containing the [`durationPredictorSource`](../../06-api-reference/interfaces/KokoroConfig.md#durationpredictorsource), [`synthesizerSource`](../../06-api-reference/interfaces/KokoroConfig.md#synthesizersource), and [`modelName`](../../06-api-reference/interfaces/KokoroConfig.md#modelname).
6969
- An optional flag [`preventLoad`](../../06-api-reference/interfaces/TextToSpeechProps.md#preventload) which prevents auto-loading of the model.
7070
- [`voice`](../../06-api-reference/interfaces/TextToSpeechProps.md#preventload) of type [`VoiceConfig`](../../06-api-reference/interfaces/VoiceConfig.md) - configuration of specific voice used in TTS.
7171

packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils';
1515
* React hook for managing a Large Language Model (LLM) instance.
1616
*
1717
* @category Hooks
18-
* @param model - Object containing model, tokenizer, and tokenizer config sources.
18+
* @param props - Object containing model, tokenizer, and tokenizer config sources.
1919
* @returns An object implementing the `LLMTypeMultimodal` interface when `model.capabilities` is provided, otherwise `LLMType`.
2020
*/
2121
export function useLLM<C extends readonly LLMCapability[]>(

0 commit comments

Comments
 (0)