docs: update references to loading models to specify loading resources

jakmro · jakmro · commit bdfc9417b88c · 2025-08-04T11:47:17.000+02:00
diff --git a/docs/docs/02-hooks/01-natural-language-processing/useLLM.md b/docs/docs/02-hooks/01-natural-language-processing/useLLM.md
@@ -60,7 +60,7 @@ The code snippet above fetches the model from the specified URL, loads it into m
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) section.
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ### Returns
 
diff --git a/docs/docs/02-hooks/01-natural-language-processing/useSpeechToText.md b/docs/docs/02-hooks/01-natural-language-processing/useSpeechToText.md
@@ -84,7 +84,7 @@ Given that STT models can process audio no longer than 30 seconds, there is a ne
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ### Returns
 
diff --git a/docs/docs/02-hooks/01-natural-language-processing/useTextEmbeddings.md b/docs/docs/02-hooks/01-natural-language-processing/useTextEmbeddings.md
@@ -45,7 +45,7 @@ try {
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ### Returns
 
diff --git a/docs/docs/02-hooks/01-natural-language-processing/useTokenizer.md b/docs/docs/02-hooks/01-natural-language-processing/useTokenizer.md
@@ -52,7 +52,7 @@ try {
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ### Returns
 
diff --git a/docs/docs/02-hooks/02-computer-vision/useClassification.md b/docs/docs/02-hooks/02-computer-vision/useClassification.md
@@ -32,10 +32,12 @@ try {
 
 **`model`** - Object containing the model source.
 
-- **`modelSource`** - A string that specifies the location of the model binary. For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+- **`modelSource`** - A string that specifies the location of the model binary.
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+
 ### Returns
 
 | Field              | Type                                                         | Description                                                                                              |
diff --git a/docs/docs/02-hooks/02-computer-vision/useImageEmbeddings.md b/docs/docs/02-hooks/02-computer-vision/useImageEmbeddings.md
@@ -43,10 +43,12 @@ try {
 
 **`model`** - Object containing the model source.
 
-- **`modelSource`** - A string that specifies the location of the model binary. For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+- **`modelSource`** - A string that specifies the location of the model binary.
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+
 ### Returns
 
 | Field              | Type                                        | Description                                                                                   |
diff --git a/docs/docs/02-hooks/02-computer-vision/useImageSegmentation.md b/docs/docs/02-hooks/02-computer-vision/useImageSegmentation.md
@@ -31,10 +31,12 @@ try {
 
 **`model`** - Object containing the model source.
 
-- **`modelSource`** - A string that specifies the location of the model binary. For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+- **`modelSource`** - A string that specifies the location of the model binary.
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+
 ### Returns
 
 | Field              | Type                                                                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
diff --git a/docs/docs/02-hooks/02-computer-vision/useOCR.md b/docs/docs/02-hooks/02-computer-vision/useOCR.md
@@ -128,7 +128,7 @@ interface OCRDetection {
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) section.
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ### Returns
 
diff --git a/docs/docs/02-hooks/02-computer-vision/useObjectDetection.md b/docs/docs/02-hooks/02-computer-vision/useObjectDetection.md
@@ -55,10 +55,11 @@ interface Detection {
 **`model`** - Object containing the model source.
 
 - **`modelSource`** - A string that specifies the path to the model file. You can download the model from our [HuggingFace repository](https://huggingface.co/software-mansion/react-native-executorch-ssdlite320-mobilenet-v3-large/tree/main).
-  For more information on that topic, you can check out the [Loading models](../../01-fundamentals/02-loading-models.md) page.
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+
 ### Returns
 
 The hook returns an object with the following properties:
diff --git a/docs/docs/02-hooks/02-computer-vision/useStyleTransfer.md b/docs/docs/02-hooks/02-computer-vision/useStyleTransfer.md
@@ -31,10 +31,12 @@ try {
 
 **`model`** - Object containing the model source.
 
-- **`modelSource`** - A string that specifies the location of the model binary. For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+- **`modelSource`** - A string that specifies the location of the model binary.
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+
 ### Returns
 
 | Field              | Type                                 | Description                                                                                              |
diff --git a/docs/docs/02-hooks/02-computer-vision/useVerticalOCR.md b/docs/docs/02-hooks/02-computer-vision/useVerticalOCR.md
@@ -142,7 +142,7 @@ interface OCRDetection {
 
 **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) section.
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ### Returns
 
diff --git a/docs/docs/02-hooks/03-executorch-bindings/useExecutorchModule.md b/docs/docs/02-hooks/03-executorch-bindings/useExecutorchModule.md
@@ -20,7 +20,9 @@ const executorchModule = useExecutorchModule({
 });
 ```
 
-The `modelSource` parameter expects a location string pointing to the model binary. For more details on how to specify model sources, refer to the [loading models](../../01-fundamentals/02-loading-models.md) documentation.
+The `modelSource` parameter expects a location string pointing to the model binary.
+
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ### Arguments
 
diff --git a/docs/docs/03-typescript-api/01-natural-language-processing/LLMModule.md b/docs/docs/03-typescript-api/01-natural-language-processing/LLMModule.md
@@ -33,7 +33,7 @@ llm.delete();
 | Method             | Type                                                                                                                                                                                       | Description                                                                                                                                                                                                                                                                                                                                                                 |
 | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `constructor`      | `({tokenCallback?: (token: string) => void, responseCallback?: (response: string) => void, messageHistoryCallback?: (messageHistory: Message[]) => void})`                                 | Creates a new instance of LLMModule with optional callbacks.                                                                                                                                                                                                                                                                                                                |
-| `load`             | `(model: { modelSource: ResourceSource; tokenizerSource: ResourceSource; tokenizerConfigSource: ResourceSource }, onDownloadProgressCallback?: (progress: number) => void): Promise<void>` | Loads the model. Checkout the [loading the model](#loading-the-model) section for details.                                                                                                                                                                                                                                                                                  |
+| `load`             | `(model: { modelSource: ResourceSource; tokenizerSource: ResourceSource; tokenizerConfigSource: ResourceSource }, onDownloadProgressCallback?: (progress: number) => void): Promise<void>` | Loads the model.                                                                                                                                                                                                                                                                                                                                                            |
 | `setTokenCallback` | `{tokenCallback: (token: string) => void}) => void`                                                                                                                                        | Sets new token callback.                                                                                                                                                                                                                                                                                                                                                    |
 | `generate`         | `(messages: Message[], tools?: LLMTool[]) => Promise<string>`                                                                                                                              | Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context.                                                                                                                                                                                                                                                                          |
 | `forward`          | `(input: string) => Promise<string>`                                                                                                                                                       | Runs model inference with raw input string. You need to provide entire conversation and prompt (in correct format and with special tokens!) in input string to this method. It doesn't manage conversation context. It is intended for users that need access to the model itself without any wrapper. If you want a simple chat with model the consider using`sendMessage` |
@@ -102,6 +102,8 @@ Then, to load the model, use the `load` method. It accepts an object with the fo
 
 This method returns a promise, which can resolve to an error or void.
 
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
+
 ## Listening for download progress
 
 To subscribe to the download progress event, you can pass the `onDownloadProgressCallback` function to the `load` method. This function is called whenever the download progress changes.
diff --git a/docs/docs/03-typescript-api/01-natural-language-processing/SpeechToTextModule.md b/docs/docs/03-typescript-api/01-natural-language-processing/SpeechToTextModule.md
@@ -66,6 +66,12 @@ enum STREAMING_ACTION {
   STOP,
 }
 
+enum AvailableModels {
+  WHISPER = 'whisper',
+  MOONSHINE = 'moonshine',
+  WHISPER_MULTILINGUAL = 'whisperMultilingual',
+}
+
 enum SpeechToTextLanguage {
   Afrikaans = 'af',
   Albanian = 'sq',
@@ -161,7 +167,7 @@ To create a new instance of SpeechToTextModule, use the constructor with optiona
 
 Then, to load the model, use the `load` method. It accepts an object with the following fields:
 
-**`model`** - Object containing the model source.
+**`model`** - Object containing the following fields:
 
 - **`modelName`** - Identifier for which model to use ('whisper', 'moonshine', or 'whisperMultilingual').
 
@@ -173,7 +179,9 @@ Then, to load the model, use the `load` method. It accepts an object with the fo
 
 **`onDownloadProgressCallback`** - (Optional) Function that will be called on download progress.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. This method returns a promise, which can resolve to an error or void.
+This method returns a promise, which can resolve to an error or void.
+
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ## Running the model
 
diff --git a/docs/docs/03-typescript-api/01-natural-language-processing/TextEmbeddingsModule.md b/docs/docs/03-typescript-api/01-natural-language-processing/TextEmbeddingsModule.md
@@ -14,9 +14,7 @@ import {
 } from 'react-native-executorch';
 
 // Loading the model
-await TextEmbeddingsModule.load(ALL_MINILM_L6_V2, (progress) =>
-  console.log(progress)
-);
+await TextEmbeddingsModule.load(ALL_MINILM_L6_V2);
 
 // Running the model
 const embedding = await TextEmbeddingsModule.forward('Hello World!');
@@ -50,7 +48,9 @@ To load the model, use the `load` method. It accepts an object:
 
 **`onDownloadProgressCallback`** - (Optional) Function called on download progress.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. This method returns a promise, which can resolve to an error or void.
+This method returns a promise, which can resolve to an error or void.
+
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ## Running the model
 
diff --git a/docs/docs/03-typescript-api/02-computer-vision/ClassificationModule.md b/docs/docs/03-typescript-api/02-computer-vision/ClassificationModule.md
@@ -50,7 +50,9 @@ To load the model, create a new instance of the module and use the `load` method
 
 **`onDownloadProgressCallback`** - (Optional) Function called on download progress.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. This method returns a promise, which can resolve to an error or void.
+This method returns a promise, which can resolve to an error or void.
+
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ## Running the model
 
diff --git a/docs/docs/03-typescript-api/02-computer-vision/ImageEmbeddingsModule.md b/docs/docs/03-typescript-api/02-computer-vision/ImageEmbeddingsModule.md
@@ -48,7 +48,9 @@ To load the model, use the `load` method. It accepts an object:
 
 **`onDownloadProgressCallback`** - (Optional) Function called on download progress.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. This method returns a promise, which can resolve to an error or void.
+This method returns a promise, which can resolve to an error or void.
+
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ## Running the model
 
diff --git a/docs/docs/03-typescript-api/02-computer-vision/ImageSegmentationModule.md b/docs/docs/03-typescript-api/02-computer-vision/ImageSegmentationModule.md
@@ -50,7 +50,9 @@ To load the model, create a new instance of the module and use the `load` method
 
 **`onDownloadProgressCallback`** - (Optional) Function called on download progress.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. This method returns a promise, which can resolve to an error or void.
+This method returns a promise, which can resolve to an error or void.
+
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ## Running the model
 
diff --git a/docs/docs/03-typescript-api/02-computer-vision/OCRModule.md b/docs/docs/03-typescript-api/02-computer-vision/OCRModule.md
@@ -115,15 +115,17 @@ To load the model, use the `load` method. It accepts an object:
 
 **`model`** - Object containing the model source.
 
-- **`detectorSource`** - A string that specifies the location of the detector binary. For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) section.
+- **`detectorSource`** - A string that specifies the location of the detector binary.
 - **`recognizerLarge`** - A string that specifies the location of the recognizer binary file which accepts input images with a width of 512 pixels.
 - **`recognizerMedium`** - A string that specifies the location of the recognizer binary file which accepts input images with a width of 256 pixels.
 - **`recognizerSmall`** - A string that specifies the location of the recognizer binary file which accepts input images with a width of 128 pixels.
 - **`language`** - A parameter that specifies the language of the text to be recognized by the OCR.
 
 **`onDownloadProgressCallback`** - (Optional) Function called on download progress.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) section. This method returns a promise, which can resolve to an error or void.
+This method returns a promise, which can resolve to an error or void.
+
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ## Running the model
 
diff --git a/docs/docs/03-typescript-api/02-computer-vision/ObjectDetectionModule.md b/docs/docs/03-typescript-api/02-computer-vision/ObjectDetectionModule.md
@@ -63,7 +63,9 @@ To load the model, create a new instance of the module and use the `load` method
 
 **`onDownloadProgressCallback`** - (Optional) Function called on download progress.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. This method returns a promise, which can resolve to an error or void.
+This method returns a promise, which can resolve to an error or void.
+
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ## Running the model
 
diff --git a/docs/docs/03-typescript-api/02-computer-vision/StyleTransferModule.md b/docs/docs/03-typescript-api/02-computer-vision/StyleTransferModule.md
@@ -50,7 +50,9 @@ To load the model, create a new instance of the module and use the `load` method
 
 **`onDownloadProgressCallback`** - (Optional) Function called on download progress.
 
-For more information, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. This method returns a promise, which can resolve to an error or void.
+This method returns a promise, which can resolve to an error or void.
+
+For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page.
 
 ## Running the model
 
diff --git a/docs/docs/03-typescript-api/02-computer-vision/VerticalOCRModule.md b/docs/docs/03-typescript-api/02-computer-vision/VerticalOCRModule.md
diff --git a/docs/docs/03-typescript-api/03-executorch-bindings/ExecutorchModule.md b/docs/docs/03-typescript-api/03-executorch-bindings/ExecutorchModule.md
