diff --git a/.github/workflows/api-reference-up-to-date-check.yml b/.github/workflows/api-reference-up-to-date-check.yml new file mode 100644 index 0000000000..ee32457a59 --- /dev/null +++ b/.github/workflows/api-reference-up-to-date-check.yml @@ -0,0 +1,50 @@ +name: Check if API reference is up-to-date + +on: + push: + branches: + - main + paths: + - 'docs/**' + - '.github/workflows/api-reference-up-to-date-check.yml' + pull_request: + branches: + - main + paths: + - 'docs/**' + - '.github/workflows/api-reference-up-to-date-check.yml' + workflow_dispatch: +jobs: + check: + if: github.repository == 'software-mansion/react-native-executorch' + runs-on: ubuntu-latest + concurrency: + group: api-reference-up-to-date-${{ github.ref }} + cancel-in-progress: true + env: + WORKING_DIRECTORY: docs + steps: + - name: Checkout repository + uses: actions/checkout@v3 + with: + ref: ${{ github.event.pull_request.head.sha }} + - name: Use Node.js 20 + uses: actions/setup-node@v4 + with: + node-version: 20 + - name: Install root dependencies + run: yarn install --immutable + - name: Install node docs dependencies + working-directory: ${{ env.WORKING_DIRECTORY }} + run: yarn install --immutable + - name: Check TypeDoc is up-to-date + working-directory: ${{ env.WORKING_DIRECTORY }} + run: | + yarn docusaurus generate-typedoc + yarn prettier-api-reference + git status + git diff + if ! git diff --quiet; then + echo "Differences found. Look at the 'git diff' output above." + exit 1 + fi \ No newline at end of file diff --git a/RELEASE.md b/RELEASE.md index e281667b5e..c31d77ccf7 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -10,7 +10,7 @@ The release process of new minor version consists of the following steps: 4. Create a new release branch `release/{MAJOR}.{MINOR}`and push it to the remote. 5. Stability tests are performed on the release branch and all fixes to the new-found issues are pushed into the main branch and cherry-picked into the release branch. This allows for further development on the main branch without interfering with the release process. 6. Once all tests are passed, tag the release branch with proper version tag `v{MAJOR}.{MINOR}.0` and run `npm publish`. -7. Create versioned docs by running from repo root `(cd docs && yarn docusaurus docs:version {MAJOR}.{MINOR}.x)` (the 'x' part is intentional and is not to be substituted). Also, make sure that all the links in `api-reference` are not broken. +7. Create versioned docs by running from repo root `(cd docs && yarn docs:version {MAJOR}.{MINOR}.x)` (the 'x' part is intentional and is not to be substituted). Also, make sure that all the links in `api-reference` are not broken. 8. Create a PR with the updated docs. 9. Create the release notes on GitHub. 10. Update README.md with release video, if available. diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index dd488f3a32..f39a1ae9eb 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,6 @@ # Class: ClassificationModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L13) +Defined in: [modules/computer_vision/ClassificationModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L13) Module for image classification tasks. @@ -28,7 +28,7 @@ Module for image classification tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L51) +Defined in: [modules/computer_vision/ClassificationModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L51) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -84,7 +84,7 @@ The classification result. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L21) +Defined in: [modules/computer_vision/ClassificationModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L21) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index 322c95d696..992deeaee8 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -1,6 +1,6 @@ # Class: ExecutorchModule -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L14) +Defined in: [modules/general/ExecutorchModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L14) General module for executing custom Executorch models. @@ -28,7 +28,7 @@ General module for executing custom Executorch models. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L51) +Defined in: [modules/general/ExecutorchModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L51) Executes the model's forward pass, where input is an array of `TensorPtr` objects. If the inference is successful, an array of tensor pointers is returned. @@ -85,7 +85,7 @@ An array of output tensor pointers. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -114,7 +114,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -148,7 +148,7 @@ The input shape as an array of numbers. > **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L22) +Defined in: [modules/general/ExecutorchModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L22) Loads the model, where `modelSource` is a string, number, or object that specifies the location of the model binary. Optionally accepts a download progress callback. diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md index 87473b12f8..68595c61cc 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: ImageEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L13) +Defined in: [modules/computer_vision/ImageEmbeddingsModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L13) Module for generating image embeddings from input images. @@ -28,7 +28,7 @@ Module for generating image embeddings from input images. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L50) +Defined in: [modules/computer_vision/ImageEmbeddingsModule.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L50) Executes the model's forward pass. Returns an embedding array for a given sentence. @@ -84,7 +84,7 @@ A Float32Array containing the image embeddings. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L20) +Defined in: [modules/computer_vision/ImageEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L20) Loads the model, where `modelSource` is a string that specifies the location of the model binary. diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md index f6b6eb290d..b395640ac6 100644 --- a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -1,26 +1,23 @@ -# Class: ImageSegmentationModule +# Class: ImageSegmentationModule\ -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L14) +Defined in: [modules/computer_vision/ImageSegmentationModule.ts:60](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L60) -Module for image segmentation tasks. +Generic image segmentation module with type-safe label maps. +Use a model name (e.g. `'deeplab-v3'`) as the generic parameter for built-in models, +or a custom label enum for custom configs. ## Extends - `BaseModule` -## Constructors +## Type Parameters -### Constructor +### T -> **new ImageSegmentationModule**(): `ImageSegmentationModule` +`T` _extends_ [`SegmentationModelName`](../type-aliases/SegmentationModelName.md) \| [`LabelEnum`](../type-aliases/LabelEnum.md) -#### Returns - -`ImageSegmentationModule` - -#### Inherited from - -`BaseModule.constructor` +Either a built-in model name (`'deeplab-v3'`, `'selfie-segmentation'`) +or a custom [LabelEnum](../type-aliases/LabelEnum.md) label map. ## Properties @@ -28,7 +25,7 @@ Module for image segmentation tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +39,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,11 +55,17 @@ Unloads the model from memory. ### forward() -> **forward**(`imageSource`, `classesOfInterest?`, `resizeToInput?`): `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> +> **forward**\<`K`\>(`imageSource`, `classesOfInterest`, `resizeToInput`): `Promise`\<`Record`\<`"ARGMAX"`, `Int32Array`\<`ArrayBufferLike`\>\> & `Record`\<`K`, `Float32Array`\<`ArrayBufferLike`\>\>\> + +Defined in: [modules/computer_vision/ImageSegmentationModule.ts:176](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L176) + +Executes the model's forward pass to perform semantic segmentation on the provided image. + +#### Type Parameters -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L54) +##### K -Executes the model's forward pass +`K` _extends_ `string` \| `number` \| `symbol` #### Parameters @@ -70,25 +73,29 @@ Executes the model's forward pass `string` -a fetchable resource or a Base64-encoded string. +A string representing the image source (e.g., a file path, URI, or Base64-encoded string). -##### classesOfInterest? +##### classesOfInterest -[`DeeplabLabel`](../enumerations/DeeplabLabel.md)[] +`K`[] = `[]` -an optional list of DeeplabLabel used to indicate additional arrays of probabilities to output (see section "Running the model"). The default is an empty list. +An optional list of label keys indicating which per-class probability masks to include in the output. `ARGMAX` is always returned regardless. -##### resizeToInput? +##### resizeToInput -`boolean` +`boolean` = `true` -an optional boolean to indicate whether the output should be resized to the original input image dimensions. If `false`, returns the model output without any resizing (see section "Running the model"). Defaults to `true`. +Whether to resize the output masks to the original input image dimensions. If `false`, returns the raw model output dimensions. Defaults to `true`. #### Returns -`Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> +`Promise`\<`Record`\<`"ARGMAX"`, `Int32Array`\<`ArrayBufferLike`\>\> & `Record`\<`K`, `Float32Array`\<`ArrayBufferLike`\>\>\> -A dictionary where keys are `DeeplabLabel` and values are arrays of probabilities for each pixel belonging to the corresponding class. +A Promise resolving to an object with an `'ARGMAX'` key mapped to an `Int32Array` of per-pixel class indices, and each requested class label mapped to a `Float32Array` of per-pixel probabilities. + +#### Throws + +If the model is not loaded. --- @@ -96,7 +103,7 @@ A dictionary where keys are `DeeplabLabel` and values are arrays of probabilitie > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -125,7 +132,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -157,33 +164,113 @@ The input shape as an array of numbers. ### load() -> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> +> **load**(): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L22) +Defined in: [modules/computer_vision/ImageSegmentationModule.ts:76](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L76) -Loads the model, where `modelSource` is a string that specifies the location of the model binary. -To track the download progress, supply a callback function `onDownloadProgressCallback`. +#### Returns -#### Parameters +`Promise`\<`void`\> -##### model +#### Overrides -Object containing `modelSource`. +`BaseModule.load` -###### modelSource +--- + +### fromCustomConfig() + +> `static` **fromCustomConfig**\<`L`\>(`modelSource`, `config`, `onDownloadProgress`): `Promise`\<`ImageSegmentationModule`\<`L`\>\> + +Defined in: [modules/computer_vision/ImageSegmentationModule.ts:142](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L142) + +Creates a segmentation instance with a user-provided label map and custom config. +Use this when working with a custom-exported segmentation model that is not one of the built-in models. + +#### Type Parameters + +##### L + +`L` _extends_ `Readonly`\<`Record`\<`string`, `string` \| `number`\>\> + +#### Parameters + +##### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) -##### onDownloadProgressCallback +A fetchable resource pointing to the model binary. + +##### config + +[`SegmentationConfig`](../type-aliases/SegmentationConfig.md)\<`L`\> + +A [SegmentationConfig](../type-aliases/SegmentationConfig.md) object with the label map and optional preprocessing parameters. + +##### onDownloadProgress (`progress`) => `void` -Optional callback to monitor download progress. +Optional callback to monitor download progress, receiving a value between 0 and 1. #### Returns -`Promise`\<`void`\> +`Promise`\<`ImageSegmentationModule`\<`L`\>\> -#### Overrides +A Promise resolving to an `ImageSegmentationModule` instance typed to the provided label map. -`BaseModule.load` +#### Example + +```ts +const MyLabels = { BACKGROUND: 0, FOREGROUND: 1 } as const; +const segmentation = await ImageSegmentationModule.fromCustomConfig( + 'https://example.com/custom_model.pte', + { labelMap: MyLabels } +); +``` + +--- + +### fromModelName() + +> `static` **fromModelName**\<`C`\>(`config`, `onDownloadProgress`): `Promise`\<`ImageSegmentationModule`\<[`ModelNameOf`](../type-aliases/ModelNameOf.md)\<`C`\>\>\> + +Defined in: [modules/computer_vision/ImageSegmentationModule.ts:95](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L95) + +Creates a segmentation instance for a built-in model. +The config object is discriminated by `modelName` — each model can require different fields. + +#### Type Parameters + +##### C + +`C` _extends_ [`ModelSources`](../type-aliases/ModelSources.md) + +#### Parameters + +##### config + +`C` + +A [ModelSources](../type-aliases/ModelSources.md) object specifying which model to load and where to fetch it from. + +##### onDownloadProgress + +(`progress`) => `void` + +Optional callback to monitor download progress, receiving a value between 0 and 1. + +#### Returns + +`Promise`\<`ImageSegmentationModule`\<[`ModelNameOf`](../type-aliases/ModelNameOf.md)\<`C`\>\>\> + +A Promise resolving to an `ImageSegmentationModule` instance typed to the chosen model's label map. + +#### Example + +```ts +const segmentation = await ImageSegmentationModule.fromModelName({ + modelName: 'deeplab-v3', + modelSource: 'https://example.com/deeplab.pte', +}); +``` diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md index 4919005159..50c769b9ea 100644 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -1,6 +1,6 @@ # Class: LLMModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L10) +Defined in: [modules/natural_language_processing/LLMModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L10) Module for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Module for managing a Large Language Model (LLM) instance. > **new LLMModule**(`optionalCallbacks`): `LLMModule` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L20) +Defined in: [modules/natural_language_processing/LLMModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L20) Creates a new instance of `LLMModule` with optional callbacks. @@ -45,7 +45,7 @@ A new LLMModule instance. > **configure**(`config`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L87) +Defined in: [modules/natural_language_processing/LLMModule.ts:87](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L87) Configures chat and tool calling and generation settings. See [Configuring the model](https://docs.swmansion.com/react-native-executorch/docs/hooks/natural-language-processing/useLLM#configuring-the-model) for details. @@ -68,7 +68,7 @@ Configuration object containing `chatConfig`, `toolsConfig`, and `generationConf > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:184](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L184) +Defined in: [modules/natural_language_processing/LLMModule.ts:184](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L184) Method to delete the model from memory. Note you cannot delete model while it's generating. @@ -84,7 +84,7 @@ You need to interrupt it first and make sure model stopped generation. > **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:140](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L140) +Defined in: [modules/natural_language_processing/LLMModule.ts:140](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L140) Deletes all messages starting with message on `index` position. After deletion it will call `messageHistoryCallback()` containing new history. @@ -110,7 +110,7 @@ The index of the message to delete from history. > **forward**(`input`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:104](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L104) +Defined in: [modules/natural_language_processing/LLMModule.ts:104](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L104) 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. @@ -137,7 +137,7 @@ The generated response as a string. > **generate**(`messages`, `tools?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:115](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L115) +Defined in: [modules/natural_language_processing/LLMModule.ts:115](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L115) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -167,7 +167,7 @@ The generated response as a string. > **getGeneratedTokenCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:157](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L157) +Defined in: [modules/natural_language_processing/LLMModule.ts:157](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L157) Returns the number of tokens generated in the last response. @@ -183,7 +183,7 @@ The count of generated tokens. > **getPromptTokensCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:166](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L166) +Defined in: [modules/natural_language_processing/LLMModule.ts:166](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L166) Returns the number of prompt tokens in the last message. @@ -199,7 +199,7 @@ The count of prompt token. > **getTotalTokensCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:175](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L175) +Defined in: [modules/natural_language_processing/LLMModule.ts:175](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L175) Returns the number of total tokens from the previous generation. This is a sum of prompt tokens and generated tokens. @@ -215,7 +215,7 @@ The count of prompt and generated tokens. > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:148](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L148) +Defined in: [modules/natural_language_processing/LLMModule.ts:148](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L148) Interrupts model generation. It may return one more token after interrupt. @@ -229,7 +229,7 @@ Interrupts model generation. It may return one more token after interrupt. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L49) +Defined in: [modules/natural_language_processing/LLMModule.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L49) Loads the LLM model and tokenizer. @@ -273,7 +273,7 @@ Optional callback to track download progress (value between 0 and 1). > **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:127](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L127) +Defined in: [modules/natural_language_processing/LLMModule.ts:127](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L127) Method to add user message to conversation. After model responds it will call `messageHistoryCallback()` containing both user message and model response. @@ -299,7 +299,7 @@ The message string to send. > **setTokenCallback**(`tokenCallback`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:73](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L73) +Defined in: [modules/natural_language_processing/LLMModule.ts:73](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L73) Sets new token callback invoked on every token batch. diff --git a/docs/docs/06-api-reference/classes/Logger.md b/docs/docs/06-api-reference/classes/Logger.md index 3c887ddc40..ca2df23f39 100644 --- a/docs/docs/06-api-reference/classes/Logger.md +++ b/docs/docs/06-api-reference/classes/Logger.md @@ -1,6 +1,6 @@ # Class: Logger -Defined in: [packages/react-native-executorch/src/common/Logger.ts:5](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/common/Logger.ts#L5) +Defined in: [common/Logger.ts:5](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/common/Logger.ts#L5) High level wrapper that prefixes `console.` with [React Native ExecuTorch] tag. @@ -20,7 +20,7 @@ High level wrapper that prefixes `console.` with [React Native ExecuTor > `static` **debug**(...`data`): `void` -Defined in: [packages/react-native-executorch/src/common/Logger.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/common/Logger.ts#L12) +Defined in: [common/Logger.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/common/Logger.ts#L12) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/common/Logger.ts:12](https://g > `static` **error**(...`data`): `void` -Defined in: [packages/react-native-executorch/src/common/Logger.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/common/Logger.ts#L24) +Defined in: [common/Logger.ts:24](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/common/Logger.ts#L24) #### Parameters @@ -56,7 +56,7 @@ Defined in: [packages/react-native-executorch/src/common/Logger.ts:24](https://g > `static` **info**(...`data`): `void` -Defined in: [packages/react-native-executorch/src/common/Logger.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/common/Logger.ts#L16) +Defined in: [common/Logger.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/common/Logger.ts#L16) #### Parameters @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/common/Logger.ts:16](https://g > `static` **log**(...`data`): `void` -Defined in: [packages/react-native-executorch/src/common/Logger.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/common/Logger.ts#L8) +Defined in: [common/Logger.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/common/Logger.ts#L8) #### Parameters @@ -92,7 +92,7 @@ Defined in: [packages/react-native-executorch/src/common/Logger.ts:8](https://gi > `static` **warn**(...`data`): `void` -Defined in: [packages/react-native-executorch/src/common/Logger.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/common/Logger.ts#L20) +Defined in: [common/Logger.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/common/Logger.ts#L20) #### Parameters diff --git a/docs/docs/06-api-reference/classes/MessageCountContextStrategy.md b/docs/docs/06-api-reference/classes/MessageCountContextStrategy.md index 59635ab8b6..51759ca759 100644 --- a/docs/docs/06-api-reference/classes/MessageCountContextStrategy.md +++ b/docs/docs/06-api-reference/classes/MessageCountContextStrategy.md @@ -1,6 +1,6 @@ # Class: MessageCountContextStrategy -Defined in: [packages/react-native-executorch/src/utils/llms/context_strategy/MessageCountContextStrategy.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/llms/context_strategy/MessageCountContextStrategy.ts#L9) +Defined in: [utils/llms/context_strategy/MessageCountContextStrategy.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llms/context_strategy/MessageCountContextStrategy.ts#L9) A simple context strategy that retains a fixed number of the most recent messages. This strategy trims the conversation history based purely on the message count. @@ -15,7 +15,7 @@ This strategy trims the conversation history based purely on the message count. > **new MessageCountContextStrategy**(`windowLength`): `MessageCountContextStrategy` -Defined in: [packages/react-native-executorch/src/utils/llms/context_strategy/MessageCountContextStrategy.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/llms/context_strategy/MessageCountContextStrategy.ts#L14) +Defined in: [utils/llms/context_strategy/MessageCountContextStrategy.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llms/context_strategy/MessageCountContextStrategy.ts#L14) Initializes the MessageCountContextStrategy. @@ -39,7 +39,7 @@ The maximum number of recent messages to retain in the context. Defaults to 5. > **buildContext**(`systemPrompt`, `history`, `_maxContextLength`, `_getTokenCount`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/utils/llms/context_strategy/MessageCountContextStrategy.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/llms/context_strategy/MessageCountContextStrategy.ts#L25) +Defined in: [utils/llms/context_strategy/MessageCountContextStrategy.ts:25](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llms/context_strategy/MessageCountContextStrategy.ts#L25) Builds the context by slicing the history to retain only the most recent `windowLength` messages. diff --git a/docs/docs/06-api-reference/classes/NoopContextStrategy.md b/docs/docs/06-api-reference/classes/NoopContextStrategy.md index d92c1ef1b7..10183ecbc5 100644 --- a/docs/docs/06-api-reference/classes/NoopContextStrategy.md +++ b/docs/docs/06-api-reference/classes/NoopContextStrategy.md @@ -1,6 +1,6 @@ # Class: NoopContextStrategy -Defined in: packages/react-native-executorch/src/utils/llms/context_strategy/NoopContextStrategy.ts:10 +Defined in: [utils/llms/context_strategy/NoopContextStrategy.ts:10](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llms/context_strategy/NoopContextStrategy.ts#L10) A context strategy that performs no filtering or trimming of the message history. @@ -27,7 +27,7 @@ A context strategy that performs no filtering or trimming of the message history > **buildContext**(`systemPrompt`, `history`, `_maxContextLength`, `_getTokenCount`): [`Message`](../interfaces/Message.md)[] -Defined in: packages/react-native-executorch/src/utils/llms/context_strategy/NoopContextStrategy.ts:20 +Defined in: [utils/llms/context_strategy/NoopContextStrategy.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llms/context_strategy/NoopContextStrategy.ts#L20) Builds the context by prepending the system prompt to the entire unfiltered history. diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md index 5ec39d1bf3..87486e94e7 100644 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -1,6 +1,6 @@ # Class: OCRModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) +Defined in: [modules/computer_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) Module for Optical Character Recognition (OCR) tasks. @@ -10,7 +10,7 @@ Module for Optical Character Recognition (OCR) tasks. > **new OCRModule**(): `OCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L15) +Defined in: [modules/computer_vision/OCRModule.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L15) #### Returns @@ -22,7 +22,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRMod > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:62](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L62) +Defined in: [modules/computer_vision/OCRModule.ts:62](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L62) Release the memory held by the module. Calling `forward` afterwards is invalid. Note that you cannot delete model while it's generating. @@ -37,7 +37,7 @@ Note that you cannot delete model while it's generating. > **forward**(`imageSource`): `Promise`\<[`OCRDetection`](../interfaces/OCRDetection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L54) +Defined in: [modules/computer_vision/OCRModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L54) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -61,7 +61,7 @@ The OCR result as a `OCRDetection[]`. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L27) +Defined in: [modules/computer_vision/OCRModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L27) Loads the model, where `detectorSource` is a string that specifies the location of the detector binary, `recognizerSource` is a string that specifies the location of the recognizer binary, diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index 99836f1e0b..38fd14f562 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -1,6 +1,6 @@ # Class: ObjectDetectionModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L14) +Defined in: [modules/computer_vision/ObjectDetectionModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L14) Module for object detection tasks. @@ -28,7 +28,7 @@ Module for object detection tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L54) +Defined in: [modules/computer_vision/ObjectDetectionModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L54) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. `detectionThreshold` can be supplied to alter the sensitivity of the detection. @@ -91,7 +91,7 @@ An array of Detection objects representing detected items in the image. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -120,7 +120,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -154,7 +154,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L22) +Defined in: [modules/computer_vision/ObjectDetectionModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L22) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md index 40716f36eb..ef2ba689a7 100644 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -1,6 +1,6 @@ # Class: ResourceFetcher -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L53) +Defined in: [utils/ResourceFetcher.ts:53](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L53) This module provides functions to download and work with downloaded files stored in the application's document directory inside the `react-native-executorch/` directory. These utilities can help you manage your storage and clean up the downloaded files when they are no longer needed. @@ -21,7 +21,7 @@ These utilities can help you manage your storage and clean up the downloaded fil > `static` **fs**: `object` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L128) +Defined in: [utils/ResourceFetcher.ts:128](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L128) Filesystem utilities for reading downloaded resources. @@ -60,7 +60,7 @@ Currently supports reading file contents as strings for configuration files. > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:105](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L105) +Defined in: [utils/ResourceFetcher.ts:105](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L105) Fetches resources (remote URLs, local files or embedded assets), downloads or stores them locally for use by React Native ExecuTorch. @@ -91,7 +91,7 @@ If the fetch was interrupted, it returns a promise which resolves to `null`. > `static` **getAdapter**(): [`ResourceFetcherAdapter`](../interfaces/ResourceFetcherAdapter.md) -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L87) +Defined in: [utils/ResourceFetcher.ts:87](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L87) Gets the current resource fetcher adapter instance. @@ -115,7 +115,7 @@ If no adapter has been set via [setAdapter](#setadapter). > `static` **resetAdapter**(): `void` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:74](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L74) +Defined in: [utils/ResourceFetcher.ts:74](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L74) Resets the resource fetcher adapter to null. @@ -133,7 +133,7 @@ Resets the resource fetcher adapter to null. > `static` **setAdapter**(`adapter`): `void` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L64) +Defined in: [utils/ResourceFetcher.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L64) Sets a custom resource fetcher adapter for resource operations. diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md index f5a5d57c6b..9566d83f9b 100644 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -1,6 +1,6 @@ # Class: RnExecutorchError -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:6](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/errorUtils.ts#L6) +Defined in: [errors/errorUtils.ts:6](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/errorUtils.ts#L6) Custom error class for React Native ExecuTorch errors. @@ -14,7 +14,7 @@ Custom error class for React Native ExecuTorch errors. > **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/errorUtils.ts#L17) +Defined in: [errors/errorUtils.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/errorUtils.ts#L17) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:17](https > `optional` **cause**: `unknown` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/errorUtils.ts#L15) +Defined in: [errors/errorUtils.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/errorUtils.ts#L15) The original cause of the error, if any. @@ -58,188 +58,6 @@ The original cause of the error, if any. > **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/errorUtils.ts#L10) +Defined in: [errors/errorUtils.ts:10](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/errorUtils.ts#L10) The error code representing the type of error. - ---- - -### message - -> **message**: `string` - -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -`Error.message` - ---- - -### name - -> **name**: `string` - -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -`Error.name` - ---- - -### stack? - -> `optional` **stack**: `string` - -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -`Error.stack` - ---- - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: node_modules/@types/node/globals.d.ts:68 - -The `Error.stackTraceLimit` property specifies the number of stack frames -collected by a stack trace (whether generated by `new Error().stack` or -`Error.captureStackTrace(obj)`). - -The default value is `10` but may be set to any valid JavaScript number. Changes -will affect any stack trace captured _after_ the value has been changed. - -If set to a non-number value, or set to a negative number, stack traces will -not capture any frames. - -#### Inherited from - -`Error.stackTraceLimit` - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: node_modules/@types/node/globals.d.ts:52 - -Creates a `.stack` property on `targetObject`, which when accessed returns -a string representing the location in the code at which -`Error.captureStackTrace()` was called. - -```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` -``` - -The first line of the trace will be prefixed with -`${myObject.name}: ${myObject.message}`. - -The optional `constructorOpt` argument accepts a function. If given, all frames -above `constructorOpt`, including `constructorOpt`, will be omitted from the -generated stack trace. - -The `constructorOpt` argument is useful for hiding implementation -details of error generation from the user. For instance: - -```js -function a() { - b(); -} - -function b() { - c(); -} - -function c() { - // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; - - // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; -} - -a(); -``` - -#### Parameters - -##### targetObject - -`object` - -##### constructorOpt? - -`Function` - -#### Returns - -`void` - -#### Inherited from - -`Error.captureStackTrace` - ---- - -### isError() - -> `static` **isError**(`error`): `error is Error` - -Defined in: docs/node_modules/typescript/lib/lib.esnext.error.d.ts:23 - -Indicates whether the argument provided is a built-in Error instance or not. - -#### Parameters - -##### error - -`unknown` - -#### Returns - -`error is Error` - -#### Inherited from - -`Error.isError` - ---- - -### prepareStackTrace() - -> `static` **prepareStackTrace**(`err`, `stackTraces`): `any` - -Defined in: node_modules/@types/node/globals.d.ts:56 - -#### Parameters - -##### err - -`Error` - -##### stackTraces - -`CallSite`[] - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -`Error.prepareStackTrace` diff --git a/docs/docs/06-api-reference/classes/SlidingWindowContextStrategy.md b/docs/docs/06-api-reference/classes/SlidingWindowContextStrategy.md index 92bf244dba..7d420dd82e 100644 --- a/docs/docs/06-api-reference/classes/SlidingWindowContextStrategy.md +++ b/docs/docs/06-api-reference/classes/SlidingWindowContextStrategy.md @@ -1,6 +1,6 @@ # Class: SlidingWindowContextStrategy -Defined in: [packages/react-native-executorch/src/utils/llms/context_strategy/SlidingWindowContextStrategy.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/llms/context_strategy/SlidingWindowContextStrategy.ts#L12) +Defined in: [utils/llms/context_strategy/SlidingWindowContextStrategy.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llms/context_strategy/SlidingWindowContextStrategy.ts#L12) An advanced, token-aware context strategy that dynamically trims the message history to ensure it fits within the model's physical context limits. @@ -19,7 +19,7 @@ to ensure it fits within the model's physical context limits. > **new SlidingWindowContextStrategy**(`bufferTokens`, `allowOrphanedAssistantMessages`): `SlidingWindowContextStrategy` -Defined in: [packages/react-native-executorch/src/utils/llms/context_strategy/SlidingWindowContextStrategy.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/llms/context_strategy/SlidingWindowContextStrategy.ts#L19) +Defined in: [utils/llms/context_strategy/SlidingWindowContextStrategy.ts:19](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llms/context_strategy/SlidingWindowContextStrategy.ts#L19) Initializes the SlidingWindowContextStrategy. @@ -48,7 +48,7 @@ If false, the strategy will ensure that an assistant message is not left without > **buildContext**(`systemPrompt`, `history`, `maxContextLength`, `getTokenCount`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/utils/llms/context_strategy/SlidingWindowContextStrategy.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/llms/context_strategy/SlidingWindowContextStrategy.ts#L34) +Defined in: [utils/llms/context_strategy/SlidingWindowContextStrategy.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llms/context_strategy/SlidingWindowContextStrategy.ts#L34) Builds the context by recursively evicting the oldest messages until the total token count is safely within the defined budget. diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md index d00af6a96e..0ef1ebce21 100644 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -1,6 +1,6 @@ # Class: SpeechToTextModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L16) +Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L16) Module for Speech to Text (STT) functionalities. @@ -20,7 +20,7 @@ Module for Speech to Text (STT) functionalities. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L91) +Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L91) Runs the decoder of the model. @@ -50,7 +50,7 @@ Decoded output. > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L69) +Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L69) Unloads the model from memory. @@ -64,7 +64,7 @@ Unloads the model from memory. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L80) +Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L80) Runs the encoding part of the model on the provided waveform. Returns the encoded waveform as a Float32Array. @@ -89,7 +89,7 @@ The encoded output. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27) +Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27) Loads the model specified by the config object. `onDownloadProgressCallback` allows you to monitor the current progress of the model download. @@ -118,7 +118,7 @@ Optional callback to monitor download progress. > **stream**(`options`): `AsyncGenerator`\<\{ `committed`: [`TranscriptionResult`](../interfaces/TranscriptionResult.md); `nonCommitted`: [`TranscriptionResult`](../interfaces/TranscriptionResult.md); \}\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:133](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L133) +Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:133](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L133) Starts a streaming transcription session. Yields objects with `committed` and `nonCommitted` transcriptions. @@ -148,7 +148,7 @@ An async generator yielding transcription updates. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:206](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L206) +Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:206](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L206) Inserts a new audio chunk into the streaming transcription session. @@ -170,7 +170,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:213](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L213) +Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:213](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L213) Stops the current streaming transcription session. @@ -184,7 +184,7 @@ Stops the current streaming transcription session. > **transcribe**(`waveform`, `options`): `Promise`\<[`TranscriptionResult`](../interfaces/TranscriptionResult.md)\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:109](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L109) +Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:109](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L109) Starts a transcription process for a given input array (16kHz waveform). For multilingual models, specify the language in `options`. diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index 7101a3a8bc..1efc27c021 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,6 @@ # Class: StyleTransferModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L13) +Defined in: [modules/computer_vision/StyleTransferModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L13) Module for style transfer tasks. @@ -28,7 +28,7 @@ Module for style transfer tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L51) +Defined in: [modules/computer_vision/StyleTransferModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L51) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -84,7 +84,7 @@ The stylized image as a Base64-encoded string. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L21) +Defined in: [modules/computer_vision/StyleTransferModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L21) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index ffdfddc51e..72053896bf 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: TextEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L13) +Defined in: [modules/natural_language_processing/TextEmbeddingsModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L13) Module for generating text embeddings from input text. @@ -28,7 +28,7 @@ Module for generating text embeddings from input text. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L60) +Defined in: [modules/natural_language_processing/TextEmbeddingsModule.ts:60](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L60) Executes the model's forward pass, where `input` is a text that will be embedded. @@ -84,7 +84,7 @@ A Float32Array containing the vector embeddings. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L22) +Defined in: [modules/natural_language_processing/TextEmbeddingsModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L22) Loads the model and tokenizer specified by the config object. diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index fc9f59969f..2450c09c37 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -1,6 +1,6 @@ # Class: TextToImageModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L15) +Defined in: [modules/computer_vision/TextToImageModule.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L15) Module for text-to-image generation tasks. @@ -14,7 +14,7 @@ Module for text-to-image generation tasks. > **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L23) +Defined in: [modules/computer_vision/TextToImageModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L23) Creates a new instance of `TextToImageModule` with optional callback on inference step. @@ -40,7 +40,7 @@ Optional callback function that receives the current step index during inference > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -54,7 +54,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -72,7 +72,7 @@ Unloads the model from memory. > **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:106](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L106) +Defined in: [modules/computer_vision/TextToImageModule.ts:106](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L106) Runs the model to generate an image described by `input`, and conditioned by `seed`, performing `numSteps` inference steps. The resulting image, with dimensions `imageSize`×`imageSize` pixels, is returned as a base64-encoded string. @@ -115,7 +115,7 @@ A Base64-encoded string representing the generated PNG image. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -144,7 +144,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -178,7 +178,7 @@ The input shape as an array of numbers. > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:133](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L133) +Defined in: [modules/computer_vision/TextToImageModule.ts:133](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L133) Interrupts model generation. The model is stopped in the nearest step. @@ -192,7 +192,7 @@ Interrupts model generation. The model is stopped in the nearest step. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:36](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L36) +Defined in: [modules/computer_vision/TextToImageModule.ts:36](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L36) Loads the model from specified resources. diff --git a/docs/docs/06-api-reference/classes/TextToSpeechModule.md b/docs/docs/06-api-reference/classes/TextToSpeechModule.md index ea2ac20d65..5a10399f81 100644 --- a/docs/docs/06-api-reference/classes/TextToSpeechModule.md +++ b/docs/docs/06-api-reference/classes/TextToSpeechModule.md @@ -1,6 +1,6 @@ # Class: TextToSpeechModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L17) +Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L17) Module for Text to Speech (TTS) functionalities. @@ -20,7 +20,7 @@ Module for Text to Speech (TTS) functionalities. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L21) +Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L21) Native module instance @@ -30,7 +30,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:182](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L182) +Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:182](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L182) Unloads the model from memory. @@ -44,7 +44,7 @@ Unloads the model from memory. > **forward**(`text`, `speed`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:109](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L109) +Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:109](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L109) Synthesizes the provided text into speech. Returns a promise that resolves to the full audio waveform as a `Float32Array`. @@ -75,7 +75,7 @@ A promise resolving to the synthesized audio waveform. > **load**(`config`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L30) +Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L30) Loads the model and voice assets specified by the config object. `onDownloadProgressCallback` allows you to monitor the current progress. @@ -104,7 +104,7 @@ Optional callback to monitor download progress. > **stream**(`input`): `AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:127](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L127) +Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:127](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L127) Starts a streaming synthesis session. Yields audio chunks as they are generated. @@ -128,7 +128,7 @@ An async generator yielding Float32Array audio chunks. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts:175](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L175) +Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:175](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L175) Stops the streaming process if there is any ongoing. diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md index d885c4ef45..2e1dd045cc 100644 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -1,6 +1,6 @@ # Class: TokenizerModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L12) +Defined in: [modules/natural_language_processing/TokenizerModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L12) Module for Tokenizer functionalities. @@ -20,7 +20,7 @@ Module for Tokenizer functionalities. > **nativeModule**: `any` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L16) +Defined in: [modules/natural_language_processing/TokenizerModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L16) Native module instance @@ -30,7 +30,7 @@ Native module instance > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L65) +Defined in: [modules/natural_language_processing/TokenizerModule.ts:65](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L65) Converts an array of token IDs into a string. @@ -60,7 +60,7 @@ The decoded string. > **encode**(`input`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L54) +Defined in: [modules/natural_language_processing/TokenizerModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L54) Converts a string into an array of token IDs. @@ -84,7 +84,7 @@ An array of token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L80) +Defined in: [modules/natural_language_processing/TokenizerModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L80) Returns the size of the tokenizer's vocabulary. @@ -100,7 +100,7 @@ The vocabulary size. > **idToToken**(`tokenId`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:90](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L90) +Defined in: [modules/natural_language_processing/TokenizerModule.ts:90](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L90) Returns the token associated to the ID. @@ -124,7 +124,7 @@ The token string associated to ID. > **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L25) +Defined in: [modules/natural_language_processing/TokenizerModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L25) Loads the tokenizer from the specified source. `tokenizerSource` is a string that points to the location of the tokenizer JSON file. @@ -155,7 +155,7 @@ Optional callback to monitor download progress. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L100) +Defined in: [modules/natural_language_processing/TokenizerModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L100) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index dc7b007065..f37c5239e9 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -1,6 +1,6 @@ # Class: VADModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L14) +Defined in: [modules/natural_language_processing/VADModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L14) Module for Voice Activity Detection (VAD) functionalities. @@ -28,7 +28,7 @@ Module for Voice Activity Detection (VAD) functionalities. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L50) +Defined in: [modules/natural_language_processing/VADModule.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L50) Executes the model's forward pass, where `waveform` is a Float32Array representing the audio signal (16kHz). @@ -84,7 +84,7 @@ A promise resolving to an array of detected speech segments. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L22) +Defined in: [modules/natural_language_processing/VADModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L22) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md index 9a53450c4f..144a413596 100644 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -1,6 +1,6 @@ # Class: VerticalOCRModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) +Defined in: [modules/computer_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) Module for Vertical Optical Character Recognition (Vertical OCR) tasks. @@ -10,7 +10,7 @@ Module for Vertical Optical Character Recognition (Vertical OCR) tasks. > **new VerticalOCRModule**(): `VerticalOCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L15) +Defined in: [modules/computer_vision/VerticalOCRModule.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L15) #### Returns @@ -22,7 +22,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Vertic > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L65) +Defined in: [modules/computer_vision/VerticalOCRModule.ts:65](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L65) Release the memory held by the module. Calling `forward` afterwards is invalid. Note that you cannot delete model while it's generating. @@ -37,7 +37,7 @@ Note that you cannot delete model while it's generating. > **forward**(`imageSource`): `Promise`\<[`OCRDetection`](../interfaces/OCRDetection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L57) +Defined in: [modules/computer_vision/VerticalOCRModule.ts:57](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L57) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -61,7 +61,7 @@ The OCR result as a `OCRDetection[]`. > **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L28) +Defined in: [modules/computer_vision/VerticalOCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L28) Loads the model, where `detectorSource` is a string that specifies the location of the detector binary, `recognizerSource` is a string that specifies the location of the recognizer binary, diff --git a/docs/docs/06-api-reference/enumerations/CocoLabel.md b/docs/docs/06-api-reference/enumerations/CocoLabel.md index 61f780f3bb..b94e3e9c68 100644 --- a/docs/docs/06-api-reference/enumerations/CocoLabel.md +++ b/docs/docs/06-api-reference/enumerations/CocoLabel.md @@ -1,6 +1,6 @@ # Enumeration: CocoLabel -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L39) +Defined in: [types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L39) COCO dataset class labels used for object detection. @@ -10,7 +10,7 @@ COCO dataset class labels used for object detection. > **AIRPLANE**: `5` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L44) +Defined in: [types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L44) --- @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](h > **APPLE**: `53` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L91) +Defined in: [types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L91) --- @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](h > **BACKPACK**: `27` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L66) +Defined in: [types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L66) --- @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](h > **BANANA**: `52` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L90) +Defined in: [types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L90) --- @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](h > **BASEBALL**: `39` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L78) +Defined in: [types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L78) --- @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](h > **BEAR**: `23` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L62) +Defined in: [types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L62) --- @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](h > **BED**: `65` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L103) +Defined in: [types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L103) --- @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103]( > **BENCH**: `15` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L54) +Defined in: [types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L54) --- @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](h > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L41) +Defined in: [types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L41) --- @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](h > **BIRD**: `16` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L55) +Defined in: [types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L55) --- @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](h > **BLENDER**: `83` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L121) +Defined in: [types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L121) --- @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121]( > **BOAT**: `9` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L48) +Defined in: [types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L48) --- @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](h > **BOOK**: `84` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L122) +Defined in: [types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L122) --- @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122]( > **BOTTLE**: `44` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L82) +Defined in: [types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L82) --- @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](h > **BOWL**: `51` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L89) +Defined in: [types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L89) --- @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](h > **BROCCOLI**: `56` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L94) +Defined in: [types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L94) --- @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](h > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L45) +Defined in: [types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L45) --- @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](h > **CAKE**: `61` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L99) +Defined in: [types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L99) --- @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](h > **CAR**: `3` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L42) +Defined in: [types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L42) --- @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](h > **CARROT**: `57` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L95) +Defined in: [types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L95) --- @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](h > **CAT**: `17` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L56) +Defined in: [types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L56) --- @@ -178,7 +178,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](h > **CELL_PHONE**: `77` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L115) +Defined in: [types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L115) --- @@ -186,7 +186,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115]( > **CHAIR**: `62` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L100) +Defined in: [types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L100) --- @@ -194,7 +194,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100]( > **CLOCK**: `85` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L123) +Defined in: [types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L123) --- @@ -202,7 +202,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123]( > **COUCH**: `63` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L101) +Defined in: [types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L101) --- @@ -210,7 +210,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101]( > **COW**: `21` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L60) +Defined in: [types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L60) --- @@ -218,7 +218,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](h > **CUP**: `47` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L85) +Defined in: [types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L85) --- @@ -226,7 +226,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](h > **DESK**: `69` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L107) +Defined in: [types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L107) --- @@ -234,7 +234,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107]( > **DINING_TABLE**: `67` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L105) +Defined in: [types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L105) --- @@ -242,7 +242,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105]( > **DOG**: `18` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L57) +Defined in: [types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L57) --- @@ -250,7 +250,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](h > **DONUT**: `60` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L98) +Defined in: [types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L98) --- @@ -258,7 +258,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](h > **DOOR**: `71` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L109) +Defined in: [types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L109) --- @@ -266,7 +266,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109]( > **ELEPHANT**: `22` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L61) +Defined in: [types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L61) --- @@ -274,7 +274,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](h > **EYE**: `30` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L69) +Defined in: [types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L69) --- @@ -282,7 +282,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](h > **FIRE_HYDRANT**: `11` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L50) +Defined in: [types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L50) --- @@ -290,7 +290,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](h > **FORK**: `48` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L86) +Defined in: [types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L86) --- @@ -298,7 +298,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](h > **FRISBEE**: `34` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L73) +Defined in: [types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L73) --- @@ -306,7 +306,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](h > **GIRAFFE**: `25` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L64) +Defined in: [types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L64) --- @@ -314,7 +314,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](h > **HAIR_BRUSH**: `91` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:129](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L129) +Defined in: [types/objectDetection.ts:129](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L129) --- @@ -322,7 +322,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:129]( > **HAIR_DRIER**: `89` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:127](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L127) +Defined in: [types/objectDetection.ts:127](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L127) --- @@ -330,7 +330,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:127]( > **HANDBAG**: `31` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L70) +Defined in: [types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L70) --- @@ -338,7 +338,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](h > **HAT**: `26` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L65) +Defined in: [types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L65) --- @@ -346,7 +346,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](h > **HORSE**: `19` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L58) +Defined in: [types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L58) --- @@ -354,7 +354,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](h > **HOT_DOG**: `58` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L96) +Defined in: [types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L96) --- @@ -362,7 +362,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](h > **KEYBOARD**: `76` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L114) +Defined in: [types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L114) --- @@ -370,7 +370,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114]( > **KITE**: `38` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L77) +Defined in: [types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L77) --- @@ -378,7 +378,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](h > **KNIFE**: `49` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L87) +Defined in: [types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L87) --- @@ -386,7 +386,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](h > **LAPTOP**: `73` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L111) +Defined in: [types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L111) --- @@ -394,7 +394,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111]( > **MICROWAVE**: `78` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L116) +Defined in: [types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L116) --- @@ -402,7 +402,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116]( > **MIRROR**: `66` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L104) +Defined in: [types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L104) --- @@ -410,7 +410,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104]( > **MOTORCYCLE**: `4` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L43) +Defined in: [types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L43) --- @@ -418,7 +418,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](h > **MOUSE**: `74` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L112) +Defined in: [types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L112) --- @@ -426,7 +426,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112]( > **ORANGE**: `55` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L93) +Defined in: [types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L93) --- @@ -434,7 +434,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](h > **OVEN**: `79` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L117) +Defined in: [types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L117) --- @@ -442,7 +442,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117]( > **PARKING**: `14` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L53) +Defined in: [types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L53) --- @@ -450,7 +450,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](h > **PERSON**: `1` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L40) +Defined in: [types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L40) --- @@ -458,7 +458,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](h > **PIZZA**: `59` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L97) +Defined in: [types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L97) --- @@ -466,7 +466,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](h > **PLATE**: `45` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L83) +Defined in: [types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L83) --- @@ -474,7 +474,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](h > **POTTED_PLANT**: `64` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L102) +Defined in: [types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L102) --- @@ -482,7 +482,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102]( > **REFRIGERATOR**: `82` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L120) +Defined in: [types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L120) --- @@ -490,7 +490,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120]( > **REMOTE**: `75` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L113) +Defined in: [types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L113) --- @@ -498,7 +498,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113]( > **SANDWICH**: `54` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L92) +Defined in: [types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L92) --- @@ -506,7 +506,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](h > **SCISSORS**: `87` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L125) +Defined in: [types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L125) --- @@ -514,7 +514,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125]( > **SHEEP**: `20` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L59) +Defined in: [types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L59) --- @@ -522,7 +522,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](h > **SHOE**: `29` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L68) +Defined in: [types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L68) --- @@ -530,7 +530,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](h > **SINK**: `81` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L119) +Defined in: [types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L119) --- @@ -538,7 +538,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119]( > **SKATEBOARD**: `41` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L79) +Defined in: [types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L79) --- @@ -546,7 +546,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](h > **SKIS**: `35` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L74) +Defined in: [types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L74) --- @@ -554,7 +554,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](h > **SNOWBOARD**: `36` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L75) +Defined in: [types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L75) --- @@ -562,7 +562,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](h > **SPOON**: `50` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L88) +Defined in: [types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L88) --- @@ -570,7 +570,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](h > **SPORTS**: `37` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L76) +Defined in: [types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L76) --- @@ -578,7 +578,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](h > **STOP_SIGN**: `13` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L52) +Defined in: [types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L52) --- @@ -586,7 +586,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](h > **STREET_SIGN**: `12` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L51) +Defined in: [types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L51) --- @@ -594,7 +594,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](h > **SUITCASE**: `33` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L72) +Defined in: [types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L72) --- @@ -602,7 +602,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](h > **SURFBOARD**: `42` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L80) +Defined in: [types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L80) --- @@ -610,7 +610,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](h > **TEDDY_BEAR**: `88` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:126](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L126) +Defined in: [types/objectDetection.ts:126](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L126) --- @@ -618,7 +618,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:126]( > **TENNIS_RACKET**: `43` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L81) +Defined in: [types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L81) --- @@ -626,7 +626,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](h > **TIE**: `32` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L71) +Defined in: [types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L71) --- @@ -634,7 +634,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](h > **TOASTER**: `80` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L118) +Defined in: [types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L118) --- @@ -642,7 +642,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118]( > **TOILET**: `70` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L108) +Defined in: [types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L108) --- @@ -650,7 +650,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108]( > **TOOTHBRUSH**: `90` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L128) +Defined in: [types/objectDetection.ts:128](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L128) --- @@ -658,7 +658,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:128]( > **TRAFFIC_LIGHT**: `10` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L49) +Defined in: [types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L49) --- @@ -666,7 +666,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](h > **TRAIN**: `7` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L46) +Defined in: [types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L46) --- @@ -674,7 +674,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](h > **TRUCK**: `8` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L47) +Defined in: [types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L47) --- @@ -682,7 +682,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](h > **TV**: `72` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L110) +Defined in: [types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L110) --- @@ -690,7 +690,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110]( > **UMBRELLA**: `28` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L67) +Defined in: [types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L67) --- @@ -698,7 +698,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](h > **VASE**: `86` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L124) +Defined in: [types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L124) --- @@ -706,7 +706,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124]( > **WINDOW**: `68` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L106) +Defined in: [types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L106) --- @@ -714,7 +714,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106]( > **WINE_GLASS**: `46` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L84) +Defined in: [types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L84) --- @@ -722,4 +722,4 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](h > **ZEBRA**: `24` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L63) +Defined in: [types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L63) diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md index 5e31a8868e..4463fd1cf1 100644 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -1,6 +1,6 @@ # Enumeration: DeeplabLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) +Defined in: [types/imageSegmentation.ts:51](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L51) Labels used in the DeepLab image segmentation model. @@ -10,15 +10,7 @@ Labels used in the DeepLab image segmentation model. > **AEROPLANE**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) - ---- - -### ARGMAX - -> **ARGMAX**: `21` - -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:31](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L31) +Defined in: [types/imageSegmentation.ts:53](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L53) --- @@ -26,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:31] > **BACKGROUND**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) +Defined in: [types/imageSegmentation.ts:52](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L52) --- @@ -34,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10] > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) +Defined in: [types/imageSegmentation.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L54) --- @@ -42,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12] > **BIRD**: `3` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) +Defined in: [types/imageSegmentation.ts:55](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L55) --- @@ -50,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13] > **BOAT**: `4` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) +Defined in: [types/imageSegmentation.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L56) --- @@ -58,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14] > **BOTTLE**: `5` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [types/imageSegmentation.ts:57](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L57) --- @@ -66,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15] > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [types/imageSegmentation.ts:58](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L58) --- @@ -74,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16] > **CAR**: `7` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [types/imageSegmentation.ts:59](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L59) --- @@ -82,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17] > **CAT**: `8` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) +Defined in: [types/imageSegmentation.ts:60](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L60) --- @@ -90,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18] > **CHAIR**: `9` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) +Defined in: [types/imageSegmentation.ts:61](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L61) --- @@ -98,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19] > **COW**: `10` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) +Defined in: [types/imageSegmentation.ts:62](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L62) --- @@ -106,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20] > **DININGTABLE**: `11` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) +Defined in: [types/imageSegmentation.ts:63](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L63) --- @@ -114,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21] > **DOG**: `12` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) +Defined in: [types/imageSegmentation.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L64) --- @@ -122,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22] > **HORSE**: `13` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) +Defined in: [types/imageSegmentation.ts:65](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L65) --- @@ -130,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23] > **MOTORBIKE**: `14` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) +Defined in: [types/imageSegmentation.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L66) --- @@ -138,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24] > **PERSON**: `15` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) +Defined in: [types/imageSegmentation.ts:67](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L67) --- @@ -146,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25] > **POTTEDPLANT**: `16` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) +Defined in: [types/imageSegmentation.ts:68](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L68) --- @@ -154,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26] > **SHEEP**: `17` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) +Defined in: [types/imageSegmentation.ts:69](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L69) --- @@ -162,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27] > **SOFA**: `18` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L28) +Defined in: [types/imageSegmentation.ts:70](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L70) --- @@ -170,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:28] > **TRAIN**: `19` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L29) +Defined in: [types/imageSegmentation.ts:71](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L71) --- @@ -178,4 +170,4 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:29] > **TVMONITOR**: `20` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L30) +Defined in: [types/imageSegmentation.ts:72](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L72) diff --git a/docs/docs/06-api-reference/enumerations/DownloadStatus.md b/docs/docs/06-api-reference/enumerations/DownloadStatus.md index 076248493c..0bc7add107 100644 --- a/docs/docs/06-api-reference/enumerations/DownloadStatus.md +++ b/docs/docs/06-api-reference/enumerations/DownloadStatus.md @@ -1,6 +1,6 @@ # Enumeration: DownloadStatus -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L23) +Defined in: [utils/ResourceFetcherUtils.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L23) Download status of the file. @@ -10,7 +10,7 @@ Download status of the file. > **ONGOING**: `0` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L27) +Defined in: [utils/ResourceFetcherUtils.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L27) Download is still in progress. @@ -20,6 +20,6 @@ Download is still in progress. > **PAUSED**: `1` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L32) +Defined in: [utils/ResourceFetcherUtils.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L32) Download is paused. diff --git a/docs/docs/06-api-reference/enumerations/HTTP_CODE.md b/docs/docs/06-api-reference/enumerations/HTTP_CODE.md index 632eb95e3d..213a2ba898 100644 --- a/docs/docs/06-api-reference/enumerations/HTTP_CODE.md +++ b/docs/docs/06-api-reference/enumerations/HTTP_CODE.md @@ -1,6 +1,6 @@ # Enumeration: HTTP_CODE -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L8) +Defined in: [utils/ResourceFetcherUtils.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L8) Http status codes @@ -10,7 +10,7 @@ Http status codes > **OK**: `200` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L11) +Defined in: [utils/ResourceFetcherUtils.ts:11](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L11) - Everything is ok. @@ -20,6 +20,6 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts: > **PARTIAL_CONTENT**: `206` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L15) +Defined in: [utils/ResourceFetcherUtils.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L15) - Server has fulfilled a client request for a specific part of a resource, instead of sending the entire file. diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md index b4657184f8..c5cdde4795 100644 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -1,6 +1,6 @@ # Enumeration: RnExecutorchErrorCode -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) +Defined in: [errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https: > **AccessFailed**: `34` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:156](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L156) +Defined in: [errors/ErrorCodes.ts:156](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L156) Could not access a resource. @@ -18,7 +18,7 @@ Could not access a resource. > **DelegateInvalidCompatibility**: `48` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:172](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L172) +Defined in: [errors/ErrorCodes.ts:172](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L172) Init stage: Backend receives an incompatible delegate version. @@ -28,7 +28,7 @@ Init stage: Backend receives an incompatible delegate version. > **DelegateInvalidHandle**: `50` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:180](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L180) +Defined in: [errors/ErrorCodes.ts:180](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L180) Execute stage: The handle is invalid. @@ -38,7 +38,7 @@ Execute stage: The handle is invalid. > **DelegateMemoryAllocationFailed**: `49` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:176](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L176) +Defined in: [errors/ErrorCodes.ts:176](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L176) Init stage: Backend fails to allocate memory. @@ -48,7 +48,7 @@ Init stage: Backend fails to allocate memory. > **DownloadInterrupted**: `118` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) +Defined in: [errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) Thrown when the number of downloaded files is unexpected, due to download interruptions. @@ -58,7 +58,7 @@ Thrown when the number of downloaded files is unexpected, due to download interr > **EndOfMethod**: `3` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:124](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L124) +Defined in: [errors/ErrorCodes.ts:124](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L124) Status indicating there are no more steps of execution to run @@ -68,7 +68,7 @@ Status indicating there are no more steps of execution to run > **FileReadFailed**: `114` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) +Defined in: [errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. @@ -78,7 +78,7 @@ Thrown when a file read operation failed. This could be invalid image url passed > **FileWriteFailed**: `103` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) +Defined in: [errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) An error ocurred when saving a file. This could be, for instance a result image from an image model. @@ -88,7 +88,7 @@ An error ocurred when saving a file. This could be, for instance a result image > **Internal**: `1` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) +Defined in: [errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) An internal error occurred. @@ -98,7 +98,7 @@ An internal error occurred. > **InvalidArgument**: `18` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:136](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L136) +Defined in: [errors/ErrorCodes.ts:136](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L136) User provided an invalid argument. @@ -108,7 +108,7 @@ User provided an invalid argument. > **InvalidConfig**: `112` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) +Defined in: [errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. @@ -118,7 +118,7 @@ Thrown when config parameters passed to a model are invalid. For example, when L > **InvalidExternalData**: `36` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:164](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L164) +Defined in: [errors/ErrorCodes.ts:164](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L164) Error caused by the contents of external data. @@ -128,7 +128,7 @@ Error caused by the contents of external data. > **InvalidModelOutput**: `115` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) +Defined in: [errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) Thrown when the size of model output is unexpected. @@ -138,7 +138,7 @@ Thrown when the size of model output is unexpected. > **InvalidModelSource**: `255` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) +Defined in: [errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) Thrown when the type of model source passed by the user is invalid. @@ -148,7 +148,7 @@ Thrown when the type of model source passed by the user is invalid. > **InvalidProgram**: `35` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:160](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L160) +Defined in: [errors/ErrorCodes.ts:160](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L160) Error caused by the contents of a program. @@ -158,7 +158,7 @@ Error caused by the contents of a program. > **InvalidState**: `2` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:120](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L120) +Defined in: [errors/ErrorCodes.ts:120](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L120) Status indicating the executor is in an invalid state for a targeted operation. @@ -168,7 +168,7 @@ Status indicating the executor is in an invalid state for a targeted operation. > **InvalidType**: `19` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:140](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L140) +Defined in: [errors/ErrorCodes.ts:140](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L140) Object is an invalid type for the operation. @@ -178,7 +178,7 @@ Object is an invalid type for the operation. > **InvalidUserInput**: `117` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) +Defined in: [errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). @@ -188,7 +188,7 @@ Thrown when the input passed to our APIs is invalid, for example when passing an > **LanguageNotSupported**: `105` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) +Defined in: [errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. @@ -198,7 +198,7 @@ Thrown when a language is passed to a multi-language model that is not supported > **MemoryAllocationFailed**: `33` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:152](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L152) +Defined in: [errors/ErrorCodes.ts:152](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L152) Could not allocate the requested memory. @@ -208,7 +208,7 @@ Could not allocate the requested memory. > **MissingDataChunk**: `161` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) +Defined in: [errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) Thrown when streaming transcription is attempted but audio data chunk is missing. @@ -218,7 +218,7 @@ Thrown when streaming transcription is attempted but audio data chunk is missing > **ModelGenerating**: `104` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) +Defined in: [errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. @@ -228,7 +228,7 @@ Thrown when a user tries to run a model that is currently processing. It is only > **ModuleNotLoaded**: `102` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) +Defined in: [errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. @@ -238,7 +238,7 @@ Thrown when a user tries to run a model that is not yet downloaded or loaded int > **MultilingualConfiguration**: `160` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) +Defined in: [errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. @@ -248,7 +248,7 @@ Thrown when there's a configuration mismatch between multilingual and language s > **NotFound**: `32` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:148](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L148) +Defined in: [errors/ErrorCodes.ts:148](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L148) Requested resource could not be found. @@ -258,7 +258,7 @@ Requested resource could not be found. > **NotImplemented**: `17` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:132](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L132) +Defined in: [errors/ErrorCodes.ts:132](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L132) Operation is not yet implemented. @@ -268,7 +268,7 @@ Operation is not yet implemented. > **NotSupported**: `16` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L128) +Defined in: [errors/ErrorCodes.ts:128](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L128) Operation is not supported in the current context. @@ -278,7 +278,7 @@ Operation is not supported in the current context. > **Ok**: `0` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) +Defined in: [errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) Status indicating a successful operation. @@ -288,7 +288,7 @@ Status indicating a successful operation. > **OperatorMissing**: `20` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:144](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L144) +Defined in: [errors/ErrorCodes.ts:144](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L144) Operator(s) missing in the operator registry. @@ -298,7 +298,7 @@ Operator(s) missing in the operator registry. > **OutOfResources**: `37` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:168](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L168) +Defined in: [errors/ErrorCodes.ts:168](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L168) Does not have enough resources to perform the requested operation. @@ -308,7 +308,7 @@ Does not have enough resources to perform the requested operation. > **ResourceFetcherAdapterNotInitialized**: `186` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) +Defined in: [errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) Thrown when trying to load resources without fetcher initialization. @@ -318,7 +318,7 @@ Thrown when trying to load resources without fetcher initialization. > **ResourceFetcherAlreadyOngoing**: `183` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) +Defined in: [errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) Thrown when trying to resume a download that is already ongoing. @@ -328,7 +328,7 @@ Thrown when trying to resume a download that is already ongoing. > **ResourceFetcherAlreadyPaused**: `182` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) +Defined in: [errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) Thrown when trying to pause a download that is already paused. @@ -338,7 +338,7 @@ Thrown when trying to pause a download that is already paused. > **ResourceFetcherDownloadFailed**: `180` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) +Defined in: [errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. @@ -348,7 +348,7 @@ Thrown when a resource fails to download. This could be due to invalid URL, or f > **ResourceFetcherDownloadInProgress**: `181` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) +Defined in: [errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) Thrown when a user tries to trigger a download that's already in progress. @@ -358,7 +358,7 @@ Thrown when a user tries to trigger a download that's already in progress. > **ResourceFetcherMissingUri**: `185` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) +Defined in: [errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) Thrown when required URI information is missing for a download operation. @@ -368,7 +368,7 @@ Thrown when required URI information is missing for a download operation. > **ResourceFetcherNotActive**: `184` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) +Defined in: [errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) Thrown when trying to pause, resume, or cancel a download that is not active. @@ -378,7 +378,7 @@ Thrown when trying to pause, resume, or cancel a download that is not active. > **StreamingInProgress**: `163` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) +Defined in: [errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) Thrown when trying to start a new streaming session while another is already in progress. @@ -388,7 +388,7 @@ Thrown when trying to start a new streaming session while another is already in > **StreamingNotStarted**: `162` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) +Defined in: [errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) Thrown when trying to stop or insert data into a stream that hasn't been started. @@ -398,7 +398,7 @@ Thrown when trying to stop or insert data into a stream that hasn't been started > **ThreadPoolError**: `113` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) +Defined in: [errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) Thrown when React Native ExecuTorch threadpool problem occurs. @@ -408,7 +408,7 @@ Thrown when React Native ExecuTorch threadpool problem occurs. > **TokenizerError**: `167` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) +Defined in: [errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) Thrown when an error occurs with the tokenizer or tokenization process. @@ -418,7 +418,7 @@ Thrown when an error occurs with the tokenizer or tokenization process. > **UnexpectedNumInputs**: `97` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) +Defined in: [errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) Thrown when the number of passed inputs to the model is different than the model metadata specifies. @@ -428,7 +428,7 @@ Thrown when the number of passed inputs to the model is different than the model > **UnknownError**: `101` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) +Defined in: [errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. @@ -438,6 +438,6 @@ An umbrella-error that is thrown usually when something unexpected happens, for > **WrongDimensions**: `116` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) +Defined in: [errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md index 4804a3948b..bcd1869e08 100644 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -1,6 +1,6 @@ # Enumeration: ScalarType -Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L17) +Defined in: [types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L17) Enum representing the scalar types of tensors. @@ -10,7 +10,7 @@ Enum representing the scalar types of tensors. > **BITS16**: `22` -Defined in: [packages/react-native-executorch/src/types/common.ts:77](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L77) +Defined in: [types/common.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L77) Raw Bits type. @@ -20,7 +20,7 @@ Raw Bits type. > **BOOL**: `11` -Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L53) +Defined in: [types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L53) Boolean type. @@ -30,7 +30,7 @@ Boolean type. > **BYTE**: `0` -Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L21) +Defined in: [types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L21) Byte type (8-bit unsigned integer). @@ -40,7 +40,7 @@ Byte type (8-bit unsigned integer). > **CHAR**: `1` -Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L25) +Defined in: [types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L25) Character type (8-bit signed integer). @@ -50,7 +50,7 @@ Character type (8-bit signed integer). > **DOUBLE**: `7` -Defined in: [packages/react-native-executorch/src/types/common.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L49) +Defined in: [types/common.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L49) Double-precision floating point type (64-bit). @@ -60,7 +60,7 @@ Double-precision floating point type (64-bit). > **FLOAT**: `6` -Defined in: [packages/react-native-executorch/src/types/common.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L45) +Defined in: [types/common.ts:45](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L45) Single-precision floating point type (32-bit). @@ -70,7 +70,7 @@ Single-precision floating point type (32-bit). > **FLOAT8E4M3FN**: `24` -Defined in: [packages/react-native-executorch/src/types/common.ts:85](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L85) +Defined in: [types/common.ts:85](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L85) Quantized 8-bit floating point type: Sign bit, 4 Exponent bits, 3 Mantissa bits. @@ -80,7 +80,7 @@ Quantized 8-bit floating point type: Sign bit, 4 Exponent bits, 3 Mantissa bits. > **FLOAT8E4M3FNUZ**: `26` -Defined in: [packages/react-native-executorch/src/types/common.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L93) +Defined in: [types/common.ts:93](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L93) Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 4 Exponent bits, 3 Mantissa bits. @@ -90,7 +90,7 @@ Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 4 Exp > **FLOAT8E5M2**: `23` -Defined in: [packages/react-native-executorch/src/types/common.ts:81](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L81) +Defined in: [types/common.ts:81](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L81) Quantized 8-bit floating point type: Sign bit, 5 Exponent bits, 2 Mantissa bits. @@ -100,7 +100,7 @@ Quantized 8-bit floating point type: Sign bit, 5 Exponent bits, 2 Mantissa bits. > **FLOAT8E5M2FNUZ**: `25` -Defined in: [packages/react-native-executorch/src/types/common.ts:89](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L89) +Defined in: [types/common.ts:89](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L89) Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 5 Exponent bits, 2 Mantissa bits. @@ -110,7 +110,7 @@ Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 5 Exp > **HALF**: `5` -Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L41) +Defined in: [types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L41) Half-precision floating point type (16-bit). @@ -120,7 +120,7 @@ Half-precision floating point type (16-bit). > **INT**: `3` -Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L33) +Defined in: [types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L33) Integer type (32-bit signed integer). @@ -130,7 +130,7 @@ Integer type (32-bit signed integer). > **LONG**: `4` -Defined in: [packages/react-native-executorch/src/types/common.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L37) +Defined in: [types/common.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L37) Long integer type (64-bit signed integer). @@ -140,7 +140,7 @@ Long integer type (64-bit signed integer). > **QINT32**: `14` -Defined in: [packages/react-native-executorch/src/types/common.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L65) +Defined in: [types/common.ts:65](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L65) Quantized 32-bit signed integer type. @@ -150,7 +150,7 @@ Quantized 32-bit signed integer type. > **QINT8**: `12` -Defined in: [packages/react-native-executorch/src/types/common.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L57) +Defined in: [types/common.ts:57](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L57) Quantized 8-bit signed integer type. @@ -160,7 +160,7 @@ Quantized 8-bit signed integer type. > **QUINT2X4**: `17` -Defined in: [packages/react-native-executorch/src/types/common.ts:73](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L73) +Defined in: [types/common.ts:73](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L73) Packed Quantized Unsigned 2-bit Integer type (4 numbers in 1 byte). @@ -170,7 +170,7 @@ Packed Quantized Unsigned 2-bit Integer type (4 numbers in 1 byte). > **QUINT4X2**: `16` -Defined in: [packages/react-native-executorch/src/types/common.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L69) +Defined in: [types/common.ts:69](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L69) Packed Quantized Unsigned 4-bit Integers type (2 number in 1 byte). @@ -180,7 +180,7 @@ Packed Quantized Unsigned 4-bit Integers type (2 number in 1 byte). > **QUINT8**: `13` -Defined in: [packages/react-native-executorch/src/types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L61) +Defined in: [types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L61) Quantized 8-bit unsigned integer type. @@ -190,7 +190,7 @@ Quantized 8-bit unsigned integer type. > **SHORT**: `2` -Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L29) +Defined in: [types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L29) Short integer type (16-bit signed integer). @@ -200,7 +200,7 @@ Short integer type (16-bit signed integer). > **UINT16**: `27` -Defined in: [packages/react-native-executorch/src/types/common.ts:97](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L97) +Defined in: [types/common.ts:97](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L97) Unsigned 16-bit integer type. @@ -210,7 +210,7 @@ Unsigned 16-bit integer type. > **UINT32**: `28` -Defined in: [packages/react-native-executorch/src/types/common.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L101) +Defined in: [types/common.ts:101](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L101) Unsigned 32-bit integer type. @@ -220,6 +220,6 @@ Unsigned 32-bit integer type. > **UINT64**: `29` -Defined in: [packages/react-native-executorch/src/types/common.ts:105](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L105) +Defined in: [types/common.ts:105](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L105) Unsigned 64-bit integer type. diff --git a/docs/docs/06-api-reference/enumerations/SelfieSegmentationLabel.md b/docs/docs/06-api-reference/enumerations/SelfieSegmentationLabel.md index 912d29f5d5..373b9bc1ff 100644 --- a/docs/docs/06-api-reference/enumerations/SelfieSegmentationLabel.md +++ b/docs/docs/06-api-reference/enumerations/SelfieSegmentationLabel.md @@ -1,6 +1,6 @@ # Enumeration: SelfieSegmentationLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:81](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/imageSegmentation.ts#L81) +Defined in: [types/imageSegmentation.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L80) Labels used in the selfie image segmentation model. @@ -10,7 +10,7 @@ Labels used in the selfie image segmentation model. > **BACKGROUND**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:83](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/imageSegmentation.ts#L83) +Defined in: [types/imageSegmentation.ts:82](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L82) --- @@ -18,4 +18,4 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:83] > **SELFIE**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:82](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/imageSegmentation.ts#L82) +Defined in: [types/imageSegmentation.ts:81](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L81) diff --git a/docs/docs/06-api-reference/enumerations/SourceType.md b/docs/docs/06-api-reference/enumerations/SourceType.md index cca7d05fa1..97308c82cc 100644 --- a/docs/docs/06-api-reference/enumerations/SourceType.md +++ b/docs/docs/06-api-reference/enumerations/SourceType.md @@ -1,6 +1,6 @@ # Enumeration: SourceType -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L40) +Defined in: [utils/ResourceFetcherUtils.ts:40](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L40) Types of sources that can be downloaded @@ -10,7 +10,7 @@ Types of sources that can be downloaded > **DEV_MODE_FILE**: `3` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:59](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L59) +Defined in: [utils/ResourceFetcherUtils.ts:59](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L59) Represents a file served via the metro bundler during development. @@ -20,7 +20,7 @@ Represents a file served via the metro bundler during development. > **LOCAL_FILE**: `1` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L49) +Defined in: [utils/ResourceFetcherUtils.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L49) Represents a file stored locally on the filesystem. @@ -30,7 +30,7 @@ Represents a file stored locally on the filesystem. > **OBJECT**: `0` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L44) +Defined in: [utils/ResourceFetcherUtils.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L44) Represents a raw object or data structure. @@ -40,7 +40,7 @@ Represents a raw object or data structure. > **RELEASE_MODE_FILE**: `2` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L54) +Defined in: [utils/ResourceFetcherUtils.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L54) Represents a file bundled with the application in release mode. @@ -50,6 +50,6 @@ Represents a file bundled with the application in release mode. > **REMOTE_FILE**: `4` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L64) +Defined in: [utils/ResourceFetcherUtils.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L64) Represents a file located at a remote URL. diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md index 56327a1a9d..33c0ddb967 100644 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -2,7 +2,7 @@ > **DEFAULT_STRUCTURED_OUTPUT_PROMPT**(`structuredOutputSchema`): `string` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) +Defined in: [constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) Generates a default structured output prompt based on the provided JSON schema. diff --git a/docs/docs/06-api-reference/functions/cleanupExecutorch.md b/docs/docs/06-api-reference/functions/cleanupExecutorch.md index 23261043cb..6a971e98ac 100644 --- a/docs/docs/06-api-reference/functions/cleanupExecutorch.md +++ b/docs/docs/06-api-reference/functions/cleanupExecutorch.md @@ -2,7 +2,7 @@ > **cleanupExecutorch**(): `void` -Defined in: [packages/react-native-executorch/src/index.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/index.ts#L32) +Defined in: [index.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/index.ts#L32) Function that cleans current setup of fetching resources. diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md index 85c31dcc3b..10ffeda0cb 100644 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -2,7 +2,7 @@ > **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> -Defined in: [packages/react-native-executorch/src/utils/llm.ts:102](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/llm.ts#L102) +Defined in: [utils/llm.ts:102](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llm.ts#L102) Fixes and validates structured output from LLMs against a provided schema. diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md index 11cb90541f..6d8b0fba68 100644 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -2,7 +2,7 @@ > **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` -Defined in: [packages/react-native-executorch/src/utils/llm.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/llm.ts#L64) +Defined in: [utils/llm.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llm.ts#L64) Generates a structured output prompt based on the provided schema. diff --git a/docs/docs/06-api-reference/functions/initExecutorch.md b/docs/docs/06-api-reference/functions/initExecutorch.md index 5a712b3680..3dec5e8c27 100644 --- a/docs/docs/06-api-reference/functions/initExecutorch.md +++ b/docs/docs/06-api-reference/functions/initExecutorch.md @@ -2,7 +2,7 @@ > **initExecutorch**(`config`): `void` -Defined in: [packages/react-native-executorch/src/index.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/index.ts#L23) +Defined in: [index.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/index.ts#L23) Function that setups the provided resource fetcher. diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md index 962ad3c81d..20f882cc23 100644 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -2,7 +2,7 @@ > **useClassification**(`ClassificationProps`): [`ClassificationType`](../interfaces/ClassificationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L15) +Defined in: [hooks/computer_vision/useClassification.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L15) React hook for managing a Classification model instance. diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md index c5e73a2f45..5e6b54ffea 100644 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -2,7 +2,7 @@ > **useExecutorchModule**(`executorchModuleProps`): [`ExecutorchModuleType`](../interfaces/ExecutorchModuleType.md) -Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L15) +Defined in: [hooks/general/useExecutorchModule.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L15) React hook for managing an arbitrary Executorch module instance. diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md index c8d1030c62..e0dcea7397 100644 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -2,7 +2,7 @@ > **useImageEmbeddings**(`ImageEmbeddingsProps`): [`ImageEmbeddingsType`](../interfaces/ImageEmbeddingsType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L15) +Defined in: [hooks/computer_vision/useImageEmbeddings.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L15) React hook for managing an Image Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md index f358559f1d..7aacae6aae 100644 --- a/docs/docs/06-api-reference/functions/useImageSegmentation.md +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -1,21 +1,37 @@ # Function: useImageSegmentation() -> **useImageSegmentation**(`ImageSegmentationProps`): [`ImageSegmentationType`](../interfaces/ImageSegmentationType.md) +> **useImageSegmentation**\<`C`\>(`props`): [`ImageSegmentationType`](../interfaces/ImageSegmentationType.md)\<[`SegmentationLabels`](../type-aliases/SegmentationLabels.md)\<[`ModelNameOf`](../type-aliases/ModelNameOf.md)\<`C`\>\>\> -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L15) +Defined in: [hooks/computer_vision/useImageSegmentation.ts:31](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L31) React hook for managing an Image Segmentation model instance. +## Type Parameters + +### C + +`C` _extends_ [`ModelSources`](../type-aliases/ModelSources.md) + +A [ModelSources](../type-aliases/ModelSources.md) config specifying which built-in model to load. + ## Parameters -### ImageSegmentationProps +### props -[`ImageSegmentationProps`](../interfaces/ImageSegmentationProps.md) +[`ImageSegmentationProps`](../interfaces/ImageSegmentationProps.md)\<`C`\> -Configuration object containing `model` source and optional `preventLoad` flag. +Configuration object containing `model` config and optional `preventLoad` flag. ## Returns -[`ImageSegmentationType`](../interfaces/ImageSegmentationType.md) +[`ImageSegmentationType`](../interfaces/ImageSegmentationType.md)\<[`SegmentationLabels`](../type-aliases/SegmentationLabels.md)\<[`ModelNameOf`](../type-aliases/ModelNameOf.md)\<`C`\>\>\> + +An object with model state (`error`, `isReady`, `isGenerating`, `downloadProgress`) and a typed `forward` function. + +## Example -Ready to use Image Segmentation model. +```ts +const { isReady, forward } = useImageSegmentation({ + model: { modelName: 'deeplab-v3', modelSource: DEEPLAB_V3_RESNET50 }, +}); +``` diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md index ef94aa3e41..f62640d900 100644 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -2,7 +2,7 @@ > **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L19) +Defined in: [hooks/natural_language_processing/useLLM.ts:19](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L19) React hook for managing a Large Language Model (LLM) instance. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md index 243c352ee4..3ebe2e2c95 100644 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -2,7 +2,7 @@ > **useOCR**(`OCRProps`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L13) +Defined in: [hooks/computer_vision/useOCR.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L13) React hook for managing an OCR instance. diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md index 9a07cac03d..8cc0ba4197 100644 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -2,7 +2,7 @@ > **useObjectDetection**(`ObjectDetectionProps`): [`ObjectDetectionType`](../interfaces/ObjectDetectionType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L15) +Defined in: [hooks/computer_vision/useObjectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L15) React hook for managing an Object Detection model instance. diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md index f475de756a..3eff9a1c3d 100644 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -2,7 +2,7 @@ > **useSpeechToText**(`speechToTextProps`): [`SpeechToTextType`](../interfaces/SpeechToTextType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L19) +Defined in: [hooks/natural_language_processing/useSpeechToText.ts:19](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L19) React hook for managing a Speech to Text (STT) instance. diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md index 9d8ba91a9b..c312d8310e 100644 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -2,7 +2,7 @@ > **useStyleTransfer**(`StyleTransferProps`): [`StyleTransferType`](../interfaces/StyleTransferType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L15) +Defined in: [hooks/computer_vision/useStyleTransfer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L15) React hook for managing a Style Transfer model instance. diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md index 43dd3e0567..d693af6773 100644 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -2,7 +2,7 @@ > **useTextEmbeddings**(`TextEmbeddingsProps`): [`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L15) +Defined in: [hooks/natural_language_processing/useTextEmbeddings.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L15) React hook for managing a Text Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md index 861883bb0b..1faf63005a 100644 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -2,7 +2,7 @@ > **useTextToImage**(`TextToImageProps`): [`TextToImageType`](../interfaces/TextToImageType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L14) +Defined in: [hooks/computer_vision/useTextToImage.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L14) React hook for managing a Text to Image instance. diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md index daa12fce71..61a1c4e645 100644 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -2,7 +2,7 @@ > **useTextToSpeech**(`TextToSpeechProps`): [`TextToSpeechType`](../interfaces/TextToSpeechType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L19) +Defined in: [hooks/natural_language_processing/useTextToSpeech.ts:19](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L19) React hook for managing Text to Speech instance. diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md index 424fc3a7ff..cf8dc784e6 100644 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -2,7 +2,7 @@ > **useTokenizer**(`tokenizerProps`): [`TokenizerType`](../interfaces/TokenizerType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) +Defined in: [hooks/natural_language_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) React hook for managing a Tokenizer instance. diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md index 8159d31deb..eda7a330a9 100644 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -2,7 +2,7 @@ > **useVAD**(`VADProps`): [`VADType`](../interfaces/VADType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L12) +Defined in: [hooks/natural_language_processing/useVAD.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L12) React hook for managing a VAD model instance. diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md index 9a32cc77a7..36c765214a 100644 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -2,7 +2,7 @@ > **useVerticalOCR**(`VerticalOCRProps`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L13) +Defined in: [hooks/computer_vision/useVerticalOCR.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L13) React hook for managing a Vertical OCR instance. diff --git a/docs/docs/06-api-reference/index.md b/docs/docs/06-api-reference/index.md index 1323d925b0..a75ed60803 100644 --- a/docs/docs/06-api-reference/index.md +++ b/docs/docs/06-api-reference/index.md @@ -38,6 +38,7 @@ ## Models - Image Segmentation - [DEEPLAB_V3_RESNET50](variables/DEEPLAB_V3_RESNET50.md) +- [SELFIE_SEGMENTATION](variables/SELFIE_SEGMENTATION.md) ## Models - LMM @@ -202,6 +203,7 @@ - [DownloadStatus](enumerations/DownloadStatus.md) - [HTTP_CODE](enumerations/HTTP_CODE.md) - [ScalarType](enumerations/ScalarType.md) +- [SelfieSegmentationLabel](enumerations/SelfieSegmentationLabel.md) - [SourceType](enumerations/SourceType.md) - [Bbox](interfaces/Bbox.md) - [ChatConfig](interfaces/ChatConfig.md) @@ -256,13 +258,20 @@ - [VerticalOCRProps](interfaces/VerticalOCRProps.md) - [VoiceConfig](interfaces/VoiceConfig.md) - [Word](interfaces/Word.md) +- [LabelEnum](type-aliases/LabelEnum.md) - [LLMTool](type-aliases/LLMTool.md) - [MessageRole](type-aliases/MessageRole.md) +- [ModelNameOf](type-aliases/ModelNameOf.md) +- [ModelSources](type-aliases/ModelSources.md) - [OCRLanguage](type-aliases/OCRLanguage.md) - [ResourceSource](type-aliases/ResourceSource.md) +- [SegmentationConfig](type-aliases/SegmentationConfig.md) +- [SegmentationLabels](type-aliases/SegmentationLabels.md) +- [SegmentationModelName](type-aliases/SegmentationModelName.md) - [SpeechToTextLanguage](type-aliases/SpeechToTextLanguage.md) - [TensorBuffer](type-aliases/TensorBuffer.md) - [TextToSpeechLanguage](type-aliases/TextToSpeechLanguage.md) +- [Triple](type-aliases/Triple.md) - [SPECIAL_TOKENS](variables/SPECIAL_TOKENS.md) ## Typescript API diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md index 04ad35f902..98fec21a8c 100644 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -1,6 +1,6 @@ # Interface: Bbox -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L13) +Defined in: [types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L13) Represents a bounding box for a detected object in an image. @@ -10,7 +10,7 @@ Represents a bounding box for a detected object in an image. > **x1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L14) +Defined in: [types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L14) The x-coordinate of the bottom-left corner of the bounding box. @@ -20,7 +20,7 @@ The x-coordinate of the bottom-left corner of the bounding box. > **x2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L15) +Defined in: [types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L15) The x-coordinate of the top-right corner of the bounding box. @@ -30,7 +30,7 @@ The x-coordinate of the top-right corner of the bounding box. > **y1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L16) +Defined in: [types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L16) The y-coordinate of the bottom-left corner of the bounding box. @@ -40,6 +40,6 @@ The y-coordinate of the bottom-left corner of the bounding box. > **y2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L17) +Defined in: [types/objectDetection.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L17) The y-coordinate of the top-right corner of the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md index a77d0b6771..1c4f07504f 100644 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -1,6 +1,6 @@ # Interface: ChatConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:218](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L218) +Defined in: [types/llm.ts:218](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L218) Object configuring chat management. @@ -10,7 +10,7 @@ Object configuring chat management. > **contextStrategy**: [`ContextStrategy`](ContextStrategy.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:221](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L221) +Defined in: [types/llm.ts:221](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L221) Defines a strategy for managing the conversation context window and message history. @@ -20,7 +20,7 @@ Defines a strategy for managing the conversation context window and message hist > **initialMessageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:219](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L219) +Defined in: [types/llm.ts:219](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L219) An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. @@ -30,6 +30,6 @@ An array of `Message` objects that represent the conversation history. This can > **systemPrompt**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:220](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L220) +Defined in: [types/llm.ts:220](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L220) Often used to tell the model what is its purpose, for example - "Be a helpful translator". diff --git a/docs/docs/06-api-reference/interfaces/ClassificationProps.md b/docs/docs/06-api-reference/interfaces/ClassificationProps.md index b985ad189d..899c70f06c 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationProps.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationProps.md @@ -1,6 +1,6 @@ # Interface: ClassificationProps -Defined in: [packages/react-native-executorch/src/types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/classification.ts#L12) +Defined in: [types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L12) Props for the `useClassification` hook. @@ -10,7 +10,7 @@ Props for the `useClassification` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/classification.ts#L13) +Defined in: [types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L13) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/classification.ts#L14) +Defined in: [types/classification.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L14) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ClassificationType.md b/docs/docs/06-api-reference/interfaces/ClassificationType.md index a7f7136292..01fc48dd1a 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationType.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationType.md @@ -1,6 +1,6 @@ # Interface: ClassificationType -Defined in: [packages/react-native-executorch/src/types/classification.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/classification.ts#L23) +Defined in: [types/classification.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L23) Return type for the `useClassification` hook. Manages the state and operations for Computer Vision image classification. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image classification. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/classification.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/classification.ts#L42) +Defined in: [types/classification.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L42) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/classification.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/classification.ts#L27) +Defined in: [types/classification.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L27) Contains the error object if the model failed to load, download, or encountered a runtime error during classification. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: [packages/react-native-executorch/src/types/classification.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/classification.ts#L50) +Defined in: [types/classification.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L50) Executes the model's forward pass to classify the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/classification.ts#L37) +Defined in: [types/classification.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L37) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/classification.ts#L32) +Defined in: [types/classification.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L32) Indicates whether the classification model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ContextStrategy.md b/docs/docs/06-api-reference/interfaces/ContextStrategy.md index 66afd79b0c..2e4d7d9b08 100644 --- a/docs/docs/06-api-reference/interfaces/ContextStrategy.md +++ b/docs/docs/06-api-reference/interfaces/ContextStrategy.md @@ -1,6 +1,6 @@ # Interface: ContextStrategy -Defined in: [packages/react-native-executorch/src/types/llm.ts:259](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L259) +Defined in: [types/llm.ts:259](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L259) Defines a strategy for managing the conversation context window and message history. @@ -10,7 +10,7 @@ Defines a strategy for managing the conversation context window and message hist > **buildContext**(`systemPrompt`, `history`, `maxContextLength`, `getTokenCount`): [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:268](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L268) +Defined in: [types/llm.ts:268](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L268) Constructs the final array of messages to be sent to the model for the current inference step. diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md index 3a41eeee8b..d0e0414715 100644 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -1,6 +1,6 @@ # Interface: DecodingOptions -Defined in: [packages/react-native-executorch/src/types/stt.ts:195](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L195) +Defined in: [types/stt.ts:195](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L195) Options for decoding speech to text. @@ -10,7 +10,7 @@ Options for decoding speech to text. > `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:196](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L196) +Defined in: [types/stt.ts:196](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L196) Optional language code to guide the transcription. @@ -20,7 +20,7 @@ Optional language code to guide the transcription. > `optional` **verbose**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:197](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L197) +Defined in: [types/stt.ts:197](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L197) Optional flag. If set, transcription result is presented with timestamps and with additional parameters. For more details please refer to `TranscriptionResult`. diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md index 10dd03d1d3..55bfa2a2c0 100644 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -1,6 +1,6 @@ # Interface: Detection -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L28) +Defined in: [types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L28) Represents a detected object within an image, including its bounding box, label, and confidence score. @@ -10,7 +10,7 @@ Represents a detected object within an image, including its bounding box, label, > **bbox**: [`Bbox`](Bbox.md) -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L29) +Defined in: [types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L29) The bounding box of the detected object, defined by its top-left (x1, y1) and bottom-right (x2, y2) coordinates. @@ -18,9 +18,9 @@ The bounding box of the detected object, defined by its top-left (x1, y1) and bo ### label -> **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` +> **label**: `"BICYCLE"` \| `"BIRD"` \| `"BOAT"` \| `"BOTTLE"` \| `"BUS"` \| `"CAR"` \| `"CAT"` \| `"CHAIR"` \| `"COW"` \| `"DOG"` \| `"HORSE"` \| `"PERSON"` \| `"SHEEP"` \| `"TRAIN"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"TRUCK"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L30) +Defined in: [types/objectDetection.ts:30](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L30) The class label of the detected object, represented as a key from the `CocoLabel` enum. @@ -30,6 +30,6 @@ The class label of the detected object, represented as a key from the `CocoLabel > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:31](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L31) +Defined in: [types/objectDetection.ts:31](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L31) The confidence score of the detection, typically ranging from 0 to 1. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchConfig.md b/docs/docs/06-api-reference/interfaces/ExecutorchConfig.md index f7f7c7f9b4..a3c18901c8 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchConfig.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchConfig.md @@ -1,6 +1,6 @@ # Interface: ExecutorchConfig -Defined in: [packages/react-native-executorch/src/index.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/index.ts#L13) +Defined in: [index.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/index.ts#L13) Configuration that goes to the `initExecutorch`. You can pass either bare React Native or Expo configuration. @@ -11,4 +11,4 @@ You can pass either bare React Native or Expo configuration. > **resourceFetcher**: [`ResourceFetcherAdapter`](ResourceFetcherAdapter.md) -Defined in: [packages/react-native-executorch/src/index.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/index.ts#L14) +Defined in: [index.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/index.ts#L14) diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md index e1e4877f40..7f649d985e 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleProps -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/executorchModule.ts#L11) +Defined in: [types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/executorchModule.ts#L11) Props for the `useExecutorchModule` hook. @@ -10,7 +10,7 @@ Props for the `useExecutorchModule` hook. > **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/executorchModule.ts#L12) +Defined in: [types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/executorchModule.ts#L12) The source of the ExecuTorch model binary. @@ -20,6 +20,6 @@ The source of the ExecuTorch model binary. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/executorchModule.ts#L13) +Defined in: [types/executorchModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/executorchModule.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md index 855dc175bd..675cd1cb80 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleType -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/executorchModule.ts#L22) +Defined in: [types/executorchModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/executorchModule.ts#L22) Return type for the `useExecutorchModule` hook. Manages the state and core execution methods for a general ExecuTorch model. @@ -11,7 +11,7 @@ Manages the state and core execution methods for a general ExecuTorch model. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/executorchModule.ts#L41) +Defined in: [types/executorchModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/executorchModule.ts#L41) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/executorchModule.ts#L26) +Defined in: [types/executorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/executorchModule.ts#L26) Contains the error object if the model failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`inputTensor`) => `Promise`\<[`TensorPtr`](TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/executorchModule.ts#L49) +Defined in: [types/executorchModule.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/executorchModule.ts#L49) Executes the model's forward pass with the provided input tensors. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another request. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:36](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/executorchModule.ts#L36) +Defined in: [types/executorchModule.ts:36](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/executorchModule.ts#L36) Indicates whether the model is currently processing a forward pass. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing a forward pass. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/executorchModule.ts#L31) +Defined in: [types/executorchModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/executorchModule.ts#L31) Indicates whether the ExecuTorch model binary has successfully loaded into memory and is ready for inference. diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md index fdf12780df..c1b06fbd99 100644 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -1,6 +1,6 @@ # Interface: GenerationConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:247](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L247) +Defined in: [types/llm.ts:247](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L247) Object configuring generation settings. @@ -10,7 +10,7 @@ Object configuring generation settings. > `optional` **batchTimeInterval**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:251](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L251) +Defined in: [types/llm.ts:251](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L251) Upper limit on the time interval between consecutive token batches. @@ -20,7 +20,7 @@ Upper limit on the time interval between consecutive token batches. > `optional` **outputTokenBatchSize**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:250](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L250) +Defined in: [types/llm.ts:250](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L250) Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). @@ -30,7 +30,7 @@ Soft upper limit on the number of tokens in each token batch (in certain cases t > `optional` **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:248](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L248) +Defined in: [types/llm.ts:248](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L248) Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. @@ -40,6 +40,6 @@ Scales output logits by the inverse of temperature. Controls the randomness / cr > `optional` **topp**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:249](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L249) +Defined in: [types/llm.ts:249](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L249) Only samples from the smallest set of tokens whose cumulative probability exceeds topp. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md index bbbc614191..ddb620e360 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) +Defined in: [types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) Props for the `useImageEmbeddings` hook. @@ -10,7 +10,7 @@ Props for the `useImageEmbeddings` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) +Defined in: [types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageEmbeddings.ts#L14) +Defined in: [types/imageEmbeddings.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L14) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md index c53b2abe4a..e52068d919 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageEmbeddings.ts#L23) +Defined in: [types/imageEmbeddings.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L23) Return type for the `useImageEmbeddings` hook. Manages the state and operations for generating image embeddings (feature vectors) used in Computer Vision tasks. @@ -11,7 +11,7 @@ Manages the state and operations for generating image embeddings (feature vector > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageEmbeddings.ts#L42) +Defined in: [types/imageEmbeddings.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L42) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageEmbeddings.ts#L27) +Defined in: [types/imageEmbeddings.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L27) Contains the error object if the model failed to load, download, or encountered a runtime error during embedding generation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageEmbeddings.ts#L50) +Defined in: [types/imageEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L50) Executes the model's forward pass to generate embeddings (a feature vector) for the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageEmbeddings.ts#L37) +Defined in: [types/imageEmbeddings.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L37) Indicates whether the model is currently generating embeddings for an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently generating embeddings for an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageEmbeddings.ts#L32) +Defined in: [types/imageEmbeddings.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L32) Indicates whether the image embeddings model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md index 62626f2f52..5e00a5ec9c 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md @@ -1,22 +1,26 @@ -# Interface: ImageSegmentationProps +# Interface: ImageSegmentationProps\ -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:43](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L43) +Defined in: [types/imageSegmentation.ts:94](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L94) Props for the `useImageSegmentation` hook. -## Properties +## Type Parameters -### model +### C + +`C` _extends_ [`ModelSources`](../type-aliases/ModelSources.md) -> **model**: `object` +A [ModelSources](../type-aliases/ModelSources.md) config specifying which built-in model to load. -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L44) +## Properties + +### model -An object containing the model source. +> **model**: `C` -#### modelSource +Defined in: [types/imageSegmentation.ts:95](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L95) -> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) +The model config containing `modelName` and `modelSource`. --- @@ -24,6 +28,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L45) +Defined in: [types/imageSegmentation.ts:96](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L96) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md index 1465e2e380..4f1140d1db 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md @@ -1,9 +1,17 @@ -# Interface: ImageSegmentationType +# Interface: ImageSegmentationType\ -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L54) +Defined in: [types/imageSegmentation.ts:107](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L107) Return type for the `useImageSegmentation` hook. -Manages the state and operations for Computer Vision image segmentation (e.g., DeepLab). +Manages the state and operations for image segmentation models. + +## Type Parameters + +### L + +`L` _extends_ [`LabelEnum`](../type-aliases/LabelEnum.md) + +The [LabelEnum](../type-aliases/LabelEnum.md) representing the model's class labels. ## Properties @@ -11,7 +19,7 @@ Manages the state and operations for Computer Vision image segmentation (e.g., D > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:73](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L73) +Defined in: [types/imageSegmentation.ts:126](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L126) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +29,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L58) +Defined in: [types/imageSegmentation.ts:111](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L111) Contains the error object if the model failed to load, download, or encountered a runtime error during segmentation. @@ -29,12 +37,18 @@ Contains the error object if the model failed to load, download, or encountered ### forward() -> **forward**: (`imageSource`, `classesOfInterest?`, `resizeToInput?`) => `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> +> **forward**: \<`K`\>(`imageSource`, `classesOfInterest?`, `resizeToInput?`) => `Promise`\<`Record`\<`"ARGMAX"`, `Int32Array`\<`ArrayBufferLike`\>\> & `Record`\<`K`, `Float32Array`\<`ArrayBufferLike`\>\>\> -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:83](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L83) +Defined in: [types/imageSegmentation.ts:136](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L136) Executes the model's forward pass to perform semantic segmentation on the provided image. +#### Type Parameters + +##### K + +`K` _extends_ `string` \| `number` \| `symbol` + #### Parameters ##### imageSource @@ -45,21 +59,21 @@ A string representing the image source (e.g., a file path, URI, or base64 string ##### classesOfInterest? -[`DeeplabLabel`](../enumerations/DeeplabLabel.md)[] +`K`[] -An optional array of `DeeplabLabel` enums. If provided, the model will only return segmentation masks for these specific classes. +An optional array of label keys indicating which per-class probability masks to include in the output. `ARGMAX` is always returned regardless. ##### resizeToInput? `boolean` -an optional boolean to indicate whether the output should be resized to the original input image dimensions. If `false`, returns the model output without any resizing (see section "Running the model"). Defaults to `true`. +Whether to resize the output masks to the original input image dimensions. If `false`, returns the raw model output dimensions. Defaults to `true`. #### Returns -`Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> +`Promise`\<`Record`\<`"ARGMAX"`, `Int32Array`\<`ArrayBufferLike`\>\> & `Record`\<`K`, `Float32Array`\<`ArrayBufferLike`\>\>\> -A Promise that resolves to an object mapping each detected `DeeplabLabel` to its corresponding segmentation mask (represented as a flattened array of numbers). +A Promise resolving to an object with an `'ARGMAX'` `Int32Array` of per-pixel class indices, and each requested class label mapped to a `Float32Array` of per-pixel probabilities. #### Throws @@ -71,7 +85,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L68) +Defined in: [types/imageSegmentation.ts:121](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L121) Indicates whether the model is currently processing an image. @@ -81,6 +95,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:63](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/imageSegmentation.ts#L63) +Defined in: [types/imageSegmentation.ts:116](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L116) Indicates whether the segmentation model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/KokoroConfig.md b/docs/docs/06-api-reference/interfaces/KokoroConfig.md index 71910ffd5e..11ec077cfa 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroConfig.md +++ b/docs/docs/06-api-reference/interfaces/KokoroConfig.md @@ -1,6 +1,6 @@ # Interface: KokoroConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L50) +Defined in: [types/tts.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L50) Kokoro model configuration. Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. @@ -11,7 +11,7 @@ Only the core Kokoro model sources, as phonemizer sources are included in voice > **durationPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:52](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L52) +Defined in: [types/tts.ts:52](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L52) source to Kokoro's duration predictor model binary @@ -21,7 +21,7 @@ source to Kokoro's duration predictor model binary > **synthesizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L53) +Defined in: [types/tts.ts:53](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L53) source to Kokoro's synthesizer model binary @@ -31,6 +31,6 @@ source to Kokoro's synthesizer model binary > **type**: `"kokoro"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L51) +Defined in: [types/tts.ts:51](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L51) model type identifier diff --git a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md index c2ea14bb54..52c50e189d 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md +++ b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md @@ -1,6 +1,6 @@ # Interface: KokoroVoiceExtras -Defined in: [packages/react-native-executorch/src/types/tts.ts:36](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L36) +Defined in: [types/tts.ts:36](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L36) Kokoro-specific voice extra props @@ -10,7 +10,7 @@ Kokoro-specific voice extra props > **lexiconSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:38](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L38) +Defined in: [types/tts.ts:38](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L38) source to Kokoro's lexicon binary @@ -20,6 +20,6 @@ source to Kokoro's lexicon binary > **taggerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L37) +Defined in: [types/tts.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L37) source to Kokoro's tagger model binary diff --git a/docs/docs/06-api-reference/interfaces/LLMConfig.md b/docs/docs/06-api-reference/interfaces/LLMConfig.md index 9e11de2219..b3cf6c6254 100644 --- a/docs/docs/06-api-reference/interfaces/LLMConfig.md +++ b/docs/docs/06-api-reference/interfaces/LLMConfig.md @@ -1,6 +1,6 @@ # Interface: LLMConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:133](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L133) +Defined in: [types/llm.ts:133](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L133) Configuration object for initializing and customizing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Configuration object for initializing and customizing a Large Language Model (LL > `optional` **chatConfig**: `Partial`\<[`ChatConfig`](ChatConfig.md)\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L143) +Defined in: [types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L143) Object configuring chat management, contains following properties: @@ -26,7 +26,7 @@ Object configuring chat management, contains following properties: > `optional` **generationConfig**: [`GenerationConfig`](GenerationConfig.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:167](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L167) +Defined in: [types/llm.ts:167](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L167) Object configuring generation settings. @@ -44,7 +44,7 @@ Object configuring generation settings. > `optional` **toolsConfig**: [`ToolsConfig`](ToolsConfig.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L154) +Defined in: [types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L154) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: diff --git a/docs/docs/06-api-reference/interfaces/LLMProps.md b/docs/docs/06-api-reference/interfaces/LLMProps.md index 38a4fdbae2..74ee2c1014 100644 --- a/docs/docs/06-api-reference/interfaces/LLMProps.md +++ b/docs/docs/06-api-reference/interfaces/LLMProps.md @@ -1,6 +1,6 @@ # Interface: LLMProps -Defined in: [packages/react-native-executorch/src/types/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L9) +Defined in: [types/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L9) Properties for initializing and configuring a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Properties for initializing and configuring a Large Language Model (LLM) instanc > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L10) +Defined in: [types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L10) #### modelSource @@ -36,6 +36,6 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://githu > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L27) +Defined in: [types/llm.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L27) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md index 32cd62e8eb..16f5cbf888 100644 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -1,6 +1,6 @@ # Interface: LLMType -Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L35) +Defined in: [types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L35) React hook for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ React hook for managing a Large Language Model (LLM) instance. > **configure**: (`configuration`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:77](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L77) +Defined in: [types/llm.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L77) Configures chat and tool calling. See [Configuring the model](https://docs.swmansion.com/react-native-executorch/docs/hooks/natural-language-processing/useLLM#configuring-the-model) for details. @@ -33,7 +33,7 @@ Configuration object containing `chatConfig`, `toolsConfig`, and `generationConf > **deleteMessage**: (`index`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:120](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L120) +Defined in: [types/llm.ts:120](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L120) Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. @@ -55,7 +55,7 @@ The index of the message to delete from history. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L64) +Defined in: [types/llm.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L64) Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. @@ -65,7 +65,7 @@ Represents the download progress as a value between 0 and 1, indicating the exte > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/llm.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L69) +Defined in: [types/llm.ts:69](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L69) Contains the error message if the model failed to load. @@ -75,7 +75,7 @@ Contains the error message if the model failed to load. > **generate**: (`messages`, `tools?`) => `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:92](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L92) +Defined in: [types/llm.ts:92](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L92) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -105,7 +105,7 @@ The generated tokens as `string`. > **getGeneratedTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L84) +Defined in: [types/llm.ts:84](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L84) Returns the number of tokens generated so far in the current generation. @@ -121,7 +121,7 @@ The count of generated tokens. > **getPromptTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:104](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L104) +Defined in: [types/llm.ts:104](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L104) Returns the number of prompt tokens in the last message. @@ -137,7 +137,7 @@ The count of prompt token. > **getTotalTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:98](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L98) +Defined in: [types/llm.ts:98](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L98) Returns the number of total tokens from the previous generation.This is a sum of prompt tokens and generated tokens. @@ -153,7 +153,7 @@ The count of prompt and generated tokens. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:125](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L125) +Defined in: [types/llm.ts:125](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L125) Function to interrupt the current inference. @@ -167,7 +167,7 @@ Function to interrupt the current inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L59) +Defined in: [types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L59) Indicates whether the model is currently generating a response. @@ -177,7 +177,7 @@ Indicates whether the model is currently generating a response. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L54) +Defined in: [types/llm.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L54) Indicates whether the model is ready. @@ -187,7 +187,7 @@ Indicates whether the model is ready. > **messageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L39) +Defined in: [types/llm.ts:39](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L39) History containing all messages in conversation. This field is updated after model responds to sendMessage. @@ -197,7 +197,7 @@ History containing all messages in conversation. This field is updated after mod > **response**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L44) +Defined in: [types/llm.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L44) State of the generated response. This field is updated with each token generated by the model. @@ -207,7 +207,7 @@ State of the generated response. This field is updated with each token generated > **sendMessage**: (`message`) => `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:113](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L113) +Defined in: [types/llm.ts:113](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L113) Function to add user message to conversation. After model responds, `messageHistory` will be updated with both user message and model response. @@ -232,6 +232,6 @@ The model's response as a `string`. > **token**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L49) +Defined in: [types/llm.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L49) The most recently generated token. diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md index 9c8a1fe3cb..85821e43e9 100644 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -1,6 +1,6 @@ # Interface: Message -Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L184) +Defined in: [types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L184) Represents a message in the conversation. @@ -10,7 +10,7 @@ Represents a message in the conversation. > **content**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:186](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L186) +Defined in: [types/llm.ts:186](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L186) Content of the message. @@ -20,6 +20,6 @@ Content of the message. > **role**: [`MessageRole`](../type-aliases/MessageRole.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:185](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L185) +Defined in: [types/llm.ts:185](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L185) Role of the message sender of type `MessageRole`. diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md index 68cf836944..65b7d5edec 100644 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -1,6 +1,6 @@ # Interface: OCRDetection -Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L14) +Defined in: [types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L14) OCRDetection represents a single detected text instance in an image, including its bounding box, recognized text, and confidence score. @@ -11,7 +11,7 @@ including its bounding box, recognized text, and confidence score. > **bbox**: [`Point`](Point.md)[] -Defined in: [packages/react-native-executorch/src/types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L15) +Defined in: [types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L15) An array of points defining the bounding box around the detected text. @@ -21,7 +21,7 @@ An array of points defining the bounding box around the detected text. > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L17) +Defined in: [types/ocr.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L17) The confidence score of the OCR detection, ranging from 0 to 1. @@ -31,6 +31,6 @@ The confidence score of the OCR detection, ranging from 0 to 1. > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L16) +Defined in: [types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L16) The recognized text within the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/OCRProps.md b/docs/docs/06-api-reference/interfaces/OCRProps.md index bef9a36abe..f894705a51 100644 --- a/docs/docs/06-api-reference/interfaces/OCRProps.md +++ b/docs/docs/06-api-reference/interfaces/OCRProps.md @@ -1,6 +1,6 @@ # Interface: OCRProps -Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L37) +Defined in: [types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L37) Configuration properties for the `useOCR` hook. @@ -14,7 +14,7 @@ Configuration properties for the `useOCR` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L41) +Defined in: [types/ocr.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L41) Object containing the necessary model sources and configuration for the OCR pipeline. @@ -42,7 +42,7 @@ The language configuration enum for the OCR model (e.g., English, Polish, etc.). > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:62](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L62) +Defined in: [types/ocr.ts:62](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L62) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/OCRType.md b/docs/docs/06-api-reference/interfaces/OCRType.md index e12c199a65..4a32da9531 100644 --- a/docs/docs/06-api-reference/interfaces/OCRType.md +++ b/docs/docs/06-api-reference/interfaces/OCRType.md @@ -1,6 +1,6 @@ # Interface: OCRType -Defined in: [packages/react-native-executorch/src/types/ocr.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L84) +Defined in: [types/ocr.ts:84](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L84) Return type for the `useOCR` hook. Manages the state and operations for Optical Character Recognition (OCR). @@ -11,7 +11,7 @@ Manages the state and operations for Optical Character Recognition (OCR). > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L103) +Defined in: [types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L103) Represents the total download progress of the model binaries as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the total download progress of the model binaries as a value between > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:88](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L88) +Defined in: [types/ocr.ts:88](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L88) Contains the error object if the models failed to load, download, or encountered a runtime error during recognition. @@ -31,7 +31,7 @@ Contains the error object if the models failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<[`OCRDetection`](OCRDetection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/ocr.ts:111](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L111) +Defined in: [types/ocr.ts:111](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L111) Executes the OCR pipeline (detection and recognition) on the provided image. @@ -59,7 +59,7 @@ If the models are not loaded or are currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:98](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L98) +Defined in: [types/ocr.ts:98](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L98) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L93) +Defined in: [types/ocr.ts:93](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L93) Indicates whether both detector and recognizer models are loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md index ed3963919a..069c4d3e19 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionProps -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:140](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L140) +Defined in: [types/objectDetection.ts:140](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L140) Props for the `useObjectDetection` hook. @@ -10,7 +10,7 @@ Props for the `useObjectDetection` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:141](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L141) +Defined in: [types/objectDetection.ts:141](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L141) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:142](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L142) +Defined in: [types/objectDetection.ts:142](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L142) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md index 7fb4687b0c..a9f28e5cf1 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionType -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:151](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L151) +Defined in: [types/objectDetection.ts:151](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L151) Return type for the `useObjectDetection` hook. Manages the state and operations for Computer Vision object detection tasks. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision object detection tasks. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:170](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L170) +Defined in: [types/objectDetection.ts:170](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L170) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:155](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L155) +Defined in: [types/objectDetection.ts:155](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L155) Contains the error object if the model failed to load, download, or encountered a runtime error during detection. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `detectionThreshold?`) => `Promise`\<[`Detection`](Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:179](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L179) +Defined in: [types/objectDetection.ts:179](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L179) Executes the model's forward pass to detect objects within the provided image. @@ -65,7 +65,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:165](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L165) +Defined in: [types/objectDetection.ts:165](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L165) Indicates whether the model is currently processing an image. @@ -75,6 +75,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:160](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/objectDetection.ts#L160) +Defined in: [types/objectDetection.ts:160](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L160) Indicates whether the object detection model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/Point.md b/docs/docs/06-api-reference/interfaces/Point.md index d4dfd0875a..528835a889 100644 --- a/docs/docs/06-api-reference/interfaces/Point.md +++ b/docs/docs/06-api-reference/interfaces/Point.md @@ -1,6 +1,6 @@ # Interface: Point -Defined in: [packages/react-native-executorch/src/types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L27) +Defined in: [types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L27) Point represents a coordinate in 2D space. @@ -10,7 +10,7 @@ Point represents a coordinate in 2D space. > **x**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L28) +Defined in: [types/ocr.ts:28](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L28) The x-coordinate of the point. @@ -20,6 +20,6 @@ The x-coordinate of the point. > **y**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L29) +Defined in: [types/ocr.ts:29](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L29) The y-coordinate of the point. diff --git a/docs/docs/06-api-reference/interfaces/ResourceFetcherAdapter.md b/docs/docs/06-api-reference/interfaces/ResourceFetcherAdapter.md index 8e21f46cc7..d98b5015dd 100644 --- a/docs/docs/06-api-reference/interfaces/ResourceFetcherAdapter.md +++ b/docs/docs/06-api-reference/interfaces/ResourceFetcherAdapter.md @@ -1,6 +1,6 @@ # Interface: ResourceFetcherAdapter -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L18) +Defined in: [utils/ResourceFetcher.ts:18](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L18) Adapter interface for resource fetching operations. **Required Methods:** @@ -19,7 +19,7 @@ these two methods for the library to function correctly. > **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L30) +Defined in: [utils/ResourceFetcher.ts:30](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L30) Fetches resources (remote URLs, local files or embedded assets), downloads or stores them locally for use by React Native ExecuTorch. @@ -54,7 +54,7 @@ If the fetch was interrupted, it returns a promise which resolves to `null`. > **readAsString**(`path`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L44) +Defined in: [utils/ResourceFetcher.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L44) Read file contents as a string. diff --git a/docs/docs/06-api-reference/interfaces/ResourceSourceExtended.md b/docs/docs/06-api-reference/interfaces/ResourceSourceExtended.md index b3a4f8932e..0789456b56 100644 --- a/docs/docs/06-api-reference/interfaces/ResourceSourceExtended.md +++ b/docs/docs/06-api-reference/interfaces/ResourceSourceExtended.md @@ -1,6 +1,6 @@ # Interface: ResourceSourceExtended -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L72) +Defined in: [utils/ResourceFetcherUtils.ts:72](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L72) Extended interface for resource sources, tracking download state and file locations. @@ -10,7 +10,7 @@ Extended interface for resource sources, tracking download state and file locati > `optional` **cacheFileUri**: `string` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:106](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L106) +Defined in: [utils/ResourceFetcherUtils.ts:106](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L106) The URI where the file is cached. @@ -20,7 +20,7 @@ The URI where the file is cached. > `optional` **callback**: (`downloadProgress`) => `void` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:86](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L86) +Defined in: [utils/ResourceFetcherUtils.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L86) Optional callback to report download progress (0 to 1). @@ -40,7 +40,7 @@ Optional callback to report download progress (0 to 1). > `optional` **fileUri**: `string` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L101) +Defined in: [utils/ResourceFetcherUtils.ts:101](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L101) The local file URI where the resource is stored. @@ -50,7 +50,7 @@ The local file URI where the resource is stored. > `optional` **next**: `ResourceSourceExtended` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:111](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L111) +Defined in: [utils/ResourceFetcherUtils.ts:111](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L111) Reference to the next resource in a linked chain of resources. @@ -60,7 +60,7 @@ Reference to the next resource in a linked chain of resources. > **results**: `string`[] -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:91](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L91) +Defined in: [utils/ResourceFetcherUtils.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L91) Array of paths or identifiers for the resulting files. @@ -70,7 +70,7 @@ Array of paths or identifiers for the resulting files. > **source**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L76) +Defined in: [utils/ResourceFetcherUtils.ts:76](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L76) The original source definition. @@ -80,7 +80,7 @@ The original source definition. > **sourceType**: [`SourceType`](../enumerations/SourceType.md) -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:81](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L81) +Defined in: [utils/ResourceFetcherUtils.ts:81](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L81) The type of the source (local, remote, etc.). @@ -90,6 +90,6 @@ The type of the source (local, remote, etc.). > `optional` **uri**: `string` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:96](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L96) +Defined in: [utils/ResourceFetcherUtils.ts:96](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L96) The URI of the resource. diff --git a/docs/docs/06-api-reference/interfaces/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index cba0372c4c..19916521de 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,6 @@ # Interface: Segment -Defined in: [packages/react-native-executorch/src/types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L24) +Defined in: [types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L24) Represents a detected audio segment with start and end timestamps. @@ -10,7 +10,7 @@ Represents a detected audio segment with start and end timestamps. > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L26) +Defined in: [types/vad.ts:26](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L26) End time of the segment in seconds. @@ -20,6 +20,6 @@ End time of the segment in seconds. > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L25) +Defined in: [types/vad.ts:25](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L25) Start time of the segment in seconds. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md index e2475c765b..f919d07e36 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextModelConfig -Defined in: [packages/react-native-executorch/src/types/stt.ts:263](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L263) +Defined in: [types/stt.ts:263](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L263) Configuration for Speech to Text model. @@ -10,7 +10,7 @@ Configuration for Speech to Text model. > **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:277](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L277) +Defined in: [types/stt.ts:277](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L277) A string that specifies the location of a `.pte` file for the decoder. @@ -20,7 +20,7 @@ A string that specifies the location of a `.pte` file for the decoder. > **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:272](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L272) +Defined in: [types/stt.ts:272](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L272) A string that specifies the location of a `.pte` file for the encoder. @@ -30,7 +30,7 @@ A string that specifies the location of a `.pte` file for the encoder. > **isMultilingual**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:267](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L267) +Defined in: [types/stt.ts:267](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L267) A boolean flag indicating whether the model supports multiple languages. @@ -40,6 +40,6 @@ A boolean flag indicating whether the model supports multiple languages. > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:282](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L282) +Defined in: [types/stt.ts:282](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L282) A string that specifies the location to the tokenizer for the model. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextProps.md b/docs/docs/06-api-reference/interfaces/SpeechToTextProps.md index d3aa1671c1..735e8c5d12 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextProps.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextProps.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextProps -Defined in: [packages/react-native-executorch/src/types/stt.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L9) +Defined in: [types/stt.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L9) Configuration for Speech to Text model. @@ -10,7 +10,7 @@ Configuration for Speech to Text model. > **model**: [`SpeechToTextModelConfig`](SpeechToTextModelConfig.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L13) +Defined in: [types/stt.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L13) Configuration object containing model sources. @@ -20,6 +20,6 @@ Configuration object containing model sources. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L17) +Defined in: [types/stt.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L17) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md index cf61a2e8da..ef4ec766d9 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextType -Defined in: [packages/react-native-executorch/src/types/stt.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L25) +Defined in: [types/stt.ts:25](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L25) React hook for managing Speech to Text (STT) instance. @@ -10,7 +10,7 @@ React hook for managing Speech to Text (STT) instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L44) +Defined in: [types/stt.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L44) Tracks the progress of the model download process. @@ -20,7 +20,7 @@ Tracks the progress of the model download process. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/stt.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L29) +Defined in: [types/stt.ts:29](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L29) Contains the error message if the model failed to load. @@ -30,7 +30,7 @@ Contains the error message if the model failed to load. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L39) +Defined in: [types/stt.ts:39](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L39) Indicates whether the model is currently processing an inference. @@ -40,7 +40,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L34) +Defined in: [types/stt.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L34) Indicates whether the model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the model has successfully loaded and is ready for inference. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:59](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L59) +Defined in: [types/stt.ts:59](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L59) Runs the decoder of the model. @@ -80,7 +80,7 @@ A promise resolving to the decoded text. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L51) +Defined in: [types/stt.ts:51](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L51) Runs the encoding part of the model on the provided waveform. @@ -104,7 +104,7 @@ A promise resolving to the encoded data. > **stream**(`options?`): `AsyncGenerator`\<\{ `committed`: [`TranscriptionResult`](TranscriptionResult.md); `nonCommitted`: [`TranscriptionResult`](TranscriptionResult.md); \}, `void`, `unknown`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L84) +Defined in: [types/stt.ts:84](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L84) Starts a streaming transcription process. Use in combination with `streamInsert` to feed audio chunks and `streamStop` to end the stream. @@ -131,7 +131,7 @@ Both `committed` and `nonCommitted` are of type `TranscriptionResult` > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:97](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L97) +Defined in: [types/stt.ts:97](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L97) Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. @@ -153,7 +153,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:102](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L102) +Defined in: [types/stt.ts:102](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L102) Stops the ongoing streaming transcription process. @@ -167,7 +167,7 @@ Stops the ongoing streaming transcription process. > **transcribe**(`waveform`, `options?`): `Promise`\<[`TranscriptionResult`](TranscriptionResult.md)\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L71) +Defined in: [types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L71) Starts a transcription process for a given input array, which should be a waveform at 16kHz. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md index c5776564b0..97655a44b0 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md @@ -1,6 +1,6 @@ # Interface: StyleTransferProps -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/styleTransfer.ts#L12) +Defined in: [types/styleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L12) Configuration properties for the `useStyleTransfer` hook. @@ -10,7 +10,7 @@ Configuration properties for the `useStyleTransfer` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/styleTransfer.ts#L13) +Defined in: [types/styleTransfer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L13) Object containing the `modelSource` for the style transfer model. @@ -24,6 +24,6 @@ Object containing the `modelSource` for the style transfer model. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/styleTransfer.ts#L14) +Defined in: [types/styleTransfer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L14) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferType.md b/docs/docs/06-api-reference/interfaces/StyleTransferType.md index 6e85b1d944..4b50a43f72 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferType.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferType.md @@ -1,6 +1,6 @@ # Interface: StyleTransferType -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/styleTransfer.ts#L23) +Defined in: [types/styleTransfer.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L23) Return type for the `useStyleTransfer` hook. Manages the state and operations for applying artistic style transfer to images. @@ -11,7 +11,7 @@ Manages the state and operations for applying artistic style transfer to images. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/styleTransfer.ts#L42) +Defined in: [types/styleTransfer.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L42) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/styleTransfer.ts#L27) +Defined in: [types/styleTransfer.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L27) Contains the error object if the model failed to load, download, or encountered a runtime error during style transfer. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/styleTransfer.ts#L50) +Defined in: [types/styleTransfer.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L50) Executes the model's forward pass to apply the specific artistic style to the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/styleTransfer.ts#L37) +Defined in: [types/styleTransfer.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L37) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/styleTransfer.ts#L32) +Defined in: [types/styleTransfer.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L32) Indicates whether the style transfer model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md index ea991166a3..df80727f1d 100644 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -1,6 +1,6 @@ # Interface: TensorPtr -Defined in: [packages/react-native-executorch/src/types/common.ts:134](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L134) +Defined in: [types/common.ts:134](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L134) Represents a pointer to a tensor, including its data buffer, size dimensions, and scalar type. @@ -10,7 +10,7 @@ Represents a pointer to a tensor, including its data buffer, size dimensions, an > **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:135](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L135) +Defined in: [types/common.ts:135](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L135) The data buffer of the tensor. @@ -20,7 +20,7 @@ The data buffer of the tensor. > **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:137](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L137) +Defined in: [types/common.ts:137](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L137) The scalar type of the tensor, as defined in the `ScalarType` enum. @@ -30,6 +30,6 @@ The scalar type of the tensor, as defined in the `ScalarType` enum. > **sizes**: `number`[] -Defined in: [packages/react-native-executorch/src/types/common.ts:136](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L136) +Defined in: [types/common.ts:136](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L136) An array representing the size of each dimension of the tensor. diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md index c0050872f5..539d421e73 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) +Defined in: [types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) Props for the useTextEmbeddings hook. @@ -10,7 +10,7 @@ Props for the useTextEmbeddings hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/textEmbeddings.ts#L12) +Defined in: [types/textEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L12) An object containing the model and tokenizer sources. @@ -32,6 +32,6 @@ The source of the tokenizer JSON file. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/textEmbeddings.ts#L22) +Defined in: [types/textEmbeddings.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L22) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md index 11713cc62e..541d8bc09a 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/textEmbeddings.ts#L30) +Defined in: [types/textEmbeddings.ts:30](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L30) React hook state and methods for managing a Text Embeddings model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Text Embeddings model instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/textEmbeddings.ts#L49) +Defined in: [types/textEmbeddings.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L49) Tracks the progress of the model download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the model download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) +Defined in: [types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) Contains the error message if the model failed to load or during inference. @@ -30,7 +30,7 @@ Contains the error message if the model failed to load or during inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/textEmbeddings.ts#L44) +Defined in: [types/textEmbeddings.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L44) Indicates whether the model is currently generating embeddings. @@ -40,7 +40,7 @@ Indicates whether the model is currently generating embeddings. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/textEmbeddings.ts#L39) +Defined in: [types/textEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L39) Indicates whether the embeddings model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the embeddings model has successfully loaded and is ready for > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/textEmbeddings.ts#L57) +Defined in: [types/textEmbeddings.ts:57](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L57) Runs the text embeddings model on the provided input string. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageProps.md b/docs/docs/06-api-reference/interfaces/TextToImageProps.md index adca1f9fe7..88f61fb7b9 100644 --- a/docs/docs/06-api-reference/interfaces/TextToImageProps.md +++ b/docs/docs/06-api-reference/interfaces/TextToImageProps.md @@ -1,6 +1,6 @@ # Interface: TextToImageProps -Defined in: [packages/react-native-executorch/src/types/tti.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L9) +Defined in: [types/tti.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L9) Configuration properties for the `useTextToImage` hook. @@ -10,7 +10,7 @@ Configuration properties for the `useTextToImage` hook. > `optional` **inferenceCallback**: (`stepIdx`) => `void` -Defined in: [packages/react-native-executorch/src/types/tti.ts:31](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L31) +Defined in: [types/tti.ts:31](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L31) Optional callback function that is triggered after each diffusion inference step. Useful for updating a progress bar during image generation. @@ -33,7 +33,7 @@ The index of the current inference step. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/tti.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L13) +Defined in: [types/tti.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L13) Object containing the required model sources for the diffusion pipeline. @@ -73,7 +73,7 @@ Source for the UNet (noise predictor) model binary. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L37) +Defined in: [types/tti.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L37) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageType.md b/docs/docs/06-api-reference/interfaces/TextToImageType.md index 4cf362a7a1..5d29900ce2 100644 --- a/docs/docs/06-api-reference/interfaces/TextToImageType.md +++ b/docs/docs/06-api-reference/interfaces/TextToImageType.md @@ -1,6 +1,6 @@ # Interface: TextToImageType -Defined in: [packages/react-native-executorch/src/types/tti.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L46) +Defined in: [types/tti.ts:46](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L46) Return type for the `useTextToImage` hook. Manages the state and operations for generating images from text prompts using a diffusion model pipeline. @@ -11,7 +11,7 @@ Manages the state and operations for generating images from text prompts using a > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tti.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L65) +Defined in: [types/tti.ts:65](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L65) Represents the total download progress of all the model binaries combined, as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the total download progress of all the model binaries combined, as a > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tti.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L50) +Defined in: [types/tti.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L50) Contains the error object if any of the pipeline models failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if any of the pipeline models failed to load, download > **generate**: (`input`, `imageSize?`, `numSteps?`, `seed?`) => `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tti.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L76) +Defined in: [types/tti.ts:76](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L76) Runs the diffusion pipeline to generate an image from the provided text prompt. @@ -77,7 +77,7 @@ If the model is not loaded or is currently generating another image. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/tti.ts:86](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L86) +Defined in: [types/tti.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L86) Interrupts the currently active image generation process at the next available inference step. @@ -91,7 +91,7 @@ Interrupts the currently active image generation process at the next available i > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L60) +Defined in: [types/tti.ts:60](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L60) Indicates whether the model is currently generating an image. @@ -101,6 +101,6 @@ Indicates whether the model is currently generating an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:55](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tti.ts#L55) +Defined in: [types/tti.ts:55](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tti.ts#L55) Indicates whether the entire diffusion pipeline is loaded into memory and ready for generation. diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md index dac59eab08..6f2e04ab5b 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L64) +Defined in: [types/tts.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L64) General Text to Speech module configuration @@ -14,7 +14,7 @@ General Text to Speech module configuration > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L65) +Defined in: [types/tts.ts:65](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L65) a selected T2S model @@ -24,6 +24,6 @@ a selected T2S model > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:66](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L66) +Defined in: [types/tts.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L66) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md index dd1a6f41db..73414dd7fc 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:88](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L88) +Defined in: [types/tts.ts:88](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L88) Text to Speech module input definition @@ -14,7 +14,7 @@ Text to Speech module input definition > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:90](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L90) +Defined in: [types/tts.ts:90](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L90) optional speed argument - the higher it is, the faster the speech becomes @@ -24,6 +24,6 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:89](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L89) +Defined in: [types/tts.ts:89](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L89) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md index cec5908123..2cf0a88107 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechProps -Defined in: [packages/react-native-executorch/src/types/tts.ts:77](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L77) +Defined in: [types/tts.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L77) Props for the useTextToSpeech hook. @@ -14,7 +14,7 @@ Props for the useTextToSpeech hook. > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L65) +Defined in: [types/tts.ts:65](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L65) a selected T2S model @@ -28,7 +28,7 @@ a selected T2S model > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L78) +Defined in: [types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L78) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. @@ -38,7 +38,7 @@ Boolean that can prevent automatic model loading (and downloading the data if yo > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:66](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L66) +Defined in: [types/tts.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L66) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md index 20a48c3f12..69cb159ae0 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechStreamingInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:156](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L156) +Defined in: [types/tts.ts:156](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L156) Text to Speech streaming input definition @@ -19,7 +19,7 @@ Callbacks can be both synchronous or asynchronous. > `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:157](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L157) +Defined in: [types/tts.ts:157](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L157) Called when streaming begins @@ -33,7 +33,7 @@ Called when streaming begins > `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:159](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L159) +Defined in: [types/tts.ts:159](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L159) Called when streaming ends @@ -47,7 +47,7 @@ Called when streaming ends > `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:158](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L158) +Defined in: [types/tts.ts:158](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L158) Called after each audio chunk gets calculated. @@ -67,7 +67,7 @@ Called after each audio chunk gets calculated. > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:90](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L90) +Defined in: [types/tts.ts:90](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L90) optional speed argument - the higher it is, the faster the speech becomes @@ -81,7 +81,7 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:89](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L89) +Defined in: [types/tts.ts:89](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L89) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md index fd935e846d..342f868f23 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechType -Defined in: [packages/react-native-executorch/src/types/tts.ts:99](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L99) +Defined in: [types/tts.ts:99](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L99) Return type for the `useTextToSpeech` hook. Manages the state and operations for Text-to-Speech generation. @@ -11,7 +11,7 @@ Manages the state and operations for Text-to-Speech generation. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:118](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L118) +Defined in: [types/tts.ts:118](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L118) Represents the download progress of the model and voice assets as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model and voice assets as a value betwee > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tts.ts:103](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L103) +Defined in: [types/tts.ts:103](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L103) Contains the error object if the model failed to load or encountered an error during inference. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load or encountered an error du > **forward**: (`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:126](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L126) +Defined in: [types/tts.ts:126](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L126) Runs the model to convert the provided text into speech audio in a single pass. @@ -61,7 +61,7 @@ If the model is not loaded or is currently generating. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:113](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L113) +Defined in: [types/tts.ts:113](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L113) Indicates whether the model is currently generating audio. @@ -71,7 +71,7 @@ Indicates whether the model is currently generating audio. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:108](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L108) +Defined in: [types/tts.ts:108](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L108) Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. @@ -81,7 +81,7 @@ Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. > **stream**: (`input`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:135](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L135) +Defined in: [types/tts.ts:135](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L135) Streams the generated audio data incrementally. This is optimal for real-time playback, allowing audio to start playing before the full text is synthesized. @@ -112,7 +112,7 @@ If the model is not loaded or is currently generating. > **streamStop**: () => `void` -Defined in: [packages/react-native-executorch/src/types/tts.ts:140](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L140) +Defined in: [types/tts.ts:140](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L140) Interrupts and stops the currently active audio generation stream. diff --git a/docs/docs/06-api-reference/interfaces/TokenizerProps.md b/docs/docs/06-api-reference/interfaces/TokenizerProps.md index 39aa1c6df5..8ffacfc478 100644 --- a/docs/docs/06-api-reference/interfaces/TokenizerProps.md +++ b/docs/docs/06-api-reference/interfaces/TokenizerProps.md @@ -1,6 +1,6 @@ # Interface: TokenizerProps -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L9) +Defined in: [types/tokenizer.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L9) Parameters for initializing and configuring a Tokenizer instance. @@ -10,7 +10,7 @@ Parameters for initializing and configuring a Tokenizer instance. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L20) +Defined in: [types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L20) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. @@ -20,7 +20,7 @@ Boolean that can prevent automatic model loading (and downloading the data if yo > **tokenizer**: `object` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L15) +Defined in: [types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L15) Object containing: diff --git a/docs/docs/06-api-reference/interfaces/TokenizerType.md b/docs/docs/06-api-reference/interfaces/TokenizerType.md index 886adb9e8d..7ccc1bd6fc 100644 --- a/docs/docs/06-api-reference/interfaces/TokenizerType.md +++ b/docs/docs/06-api-reference/interfaces/TokenizerType.md @@ -1,6 +1,6 @@ # Interface: TokenizerType -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L28) +Defined in: [types/tokenizer.ts:28](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L28) React hook state and methods for managing a Tokenizer instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Tokenizer instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L47) +Defined in: [types/tokenizer.ts:47](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L47) Tracks the progress of the tokenizer download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the tokenizer download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L32) +Defined in: [types/tokenizer.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L32) Contains the error message if the tokenizer failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the tokenizer failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L42) +Defined in: [types/tokenizer.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L42) Indicates whether the tokenizer is currently processing data. @@ -40,7 +40,7 @@ Indicates whether the tokenizer is currently processing data. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L37) +Defined in: [types/tokenizer.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L37) Indicates whether the tokenizer has successfully loaded and is ready for use. @@ -50,7 +50,7 @@ Indicates whether the tokenizer has successfully loaded and is ready for use. > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:55](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L55) +Defined in: [types/tokenizer.ts:55](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L55) Converts an array of token IDs into a string. @@ -80,7 +80,7 @@ A promise resolving to the decoded text string. > **encode**(`text`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L65) +Defined in: [types/tokenizer.ts:65](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L65) Converts a string into an array of token IDs. @@ -104,7 +104,7 @@ A promise resolving to an array `number[]` containing the encoded token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:71](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L71) +Defined in: [types/tokenizer.ts:71](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L71) Returns the size of the tokenizer's vocabulary. @@ -120,7 +120,7 @@ A promise resolving to the vocabulary size. > **idToToken**(`id`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L78) +Defined in: [types/tokenizer.ts:78](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L78) Returns the token associated to the ID. @@ -144,7 +144,7 @@ A promise resolving to the token string representation. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:85](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tokenizer.ts#L85) +Defined in: [types/tokenizer.ts:85](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tokenizer.ts#L85) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md index 0d76782691..a8110815d9 100644 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -1,6 +1,6 @@ # Interface: ToolCall -Defined in: [packages/react-native-executorch/src/types/llm.ts:196](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L196) +Defined in: [types/llm.ts:196](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L196) Represents a tool call made by the model. @@ -10,7 +10,7 @@ Represents a tool call made by the model. > **arguments**: `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L198) +Defined in: [types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L198) The arguments passed to the tool. @@ -20,6 +20,6 @@ The arguments passed to the tool. > **toolName**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:197](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L197) +Defined in: [types/llm.ts:197](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L197) The name of the tool being called. diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md index e5285de153..c206936ffe 100644 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -1,6 +1,6 @@ # Interface: ToolsConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:232](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L232) +Defined in: [types/llm.ts:232](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L232) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. @@ -10,7 +10,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > `optional` **displayToolCalls**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:235](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L235) +Defined in: [types/llm.ts:235](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L235) If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. @@ -20,7 +20,7 @@ If set to true, JSON tool calls will be displayed in chat. If false, only answer > **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:234](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L234) +Defined in: [types/llm.ts:234](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L234) Function that accepts `ToolCall`, executes tool and returns the string to model. @@ -40,6 +40,6 @@ Function that accepts `ToolCall`, executes tool and returns the string to model. > **tools**: `Object`[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:233](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L233) +Defined in: [types/llm.ts:233](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L233) List of objects defining tools. diff --git a/docs/docs/06-api-reference/interfaces/TranscriptionResult.md b/docs/docs/06-api-reference/interfaces/TranscriptionResult.md index 5d64ccc921..109560de65 100644 --- a/docs/docs/06-api-reference/interfaces/TranscriptionResult.md +++ b/docs/docs/06-api-reference/interfaces/TranscriptionResult.md @@ -1,6 +1,6 @@ # Interface: TranscriptionResult -Defined in: [packages/react-native-executorch/src/types/stt.ts:250](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L250) +Defined in: [types/stt.ts:250](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L250) Structure that represent result of transcription for a one function call (either `transcribe` or `stream`). @@ -10,7 +10,7 @@ Structure that represent result of transcription for a one function call (either > **duration**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:253](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L253) +Defined in: [types/stt.ts:253](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L253) Duration in seconds of a given transcription. @@ -20,7 +20,7 @@ Duration in seconds of a given transcription. > **language**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:252](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L252) +Defined in: [types/stt.ts:252](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L252) Language chosen for transcription. @@ -30,7 +30,7 @@ Language chosen for transcription. > `optional` **segments**: [`TranscriptionSegment`](TranscriptionSegment.md)[] -Defined in: [packages/react-native-executorch/src/types/stt.ts:255](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L255) +Defined in: [types/stt.ts:255](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L255) If `verbose` set to `true` in `DecodingOptions`, it contains array of `TranscriptionSegment` with details split into separate transcription segments. @@ -41,7 +41,7 @@ If `verbose` set to `true` in `DecodingOptions`, it contains array of > `optional` **task**: `"transcribe"` \| `"stream"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:251](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L251) +Defined in: [types/stt.ts:251](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L251) String indicating task, either 'transcribe' or 'stream'. @@ -51,6 +51,6 @@ String indicating task, either 'transcribe' or 'stream'. > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:254](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L254) +Defined in: [types/stt.ts:254](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L254) The whole text of a transcription as a `string`. diff --git a/docs/docs/06-api-reference/interfaces/TranscriptionSegment.md b/docs/docs/06-api-reference/interfaces/TranscriptionSegment.md index b4551b4f20..5769cf2dcc 100644 --- a/docs/docs/06-api-reference/interfaces/TranscriptionSegment.md +++ b/docs/docs/06-api-reference/interfaces/TranscriptionSegment.md @@ -1,6 +1,6 @@ # Interface: TranscriptionSegment -Defined in: [packages/react-native-executorch/src/types/stt.ts:228](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L228) +Defined in: [types/stt.ts:228](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L228) Structure that represent single Segment of transcription. @@ -10,7 +10,7 @@ Structure that represent single Segment of transcription. > **avgLogprob**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:235](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L235) +Defined in: [types/stt.ts:235](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L235) Average log probability calculated across all tokens in a segment. @@ -20,7 +20,7 @@ Average log probability calculated across all tokens in a segment. > **compressionRatio**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:236](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L236) +Defined in: [types/stt.ts:236](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L236) Compression ration achieved on a given segment. @@ -30,7 +30,7 @@ Compression ration achieved on a given segment. > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:230](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L230) +Defined in: [types/stt.ts:230](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L230) Timestamp of the end of the segment in audio (in seconds). @@ -40,7 +40,7 @@ Timestamp of the end of the segment in audio (in seconds). > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:229](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L229) +Defined in: [types/stt.ts:229](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L229) Timestamp of the beginning of the segment in audio (in seconds). @@ -50,7 +50,7 @@ Timestamp of the beginning of the segment in audio (in seconds). > **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:234](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L234) +Defined in: [types/stt.ts:234](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L234) Temperature for which given segment was computed. @@ -60,7 +60,7 @@ Temperature for which given segment was computed. > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:231](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L231) +Defined in: [types/stt.ts:231](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L231) Full text of the given segment as a string. @@ -70,7 +70,7 @@ Full text of the given segment as a string. > **tokens**: `number`[] -Defined in: [packages/react-native-executorch/src/types/stt.ts:233](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L233) +Defined in: [types/stt.ts:233](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L233) Raw tokens represented as table of integers. @@ -80,7 +80,7 @@ Raw tokens represented as table of integers. > `optional` **words**: [`Word`](Word.md)[] -Defined in: [packages/react-native-executorch/src/types/stt.ts:232](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L232) +Defined in: [types/stt.ts:232](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L232) If `verbose` set to `true` in `DecodingOptions`, it returns word-level timestamping as an array of `Word`. diff --git a/docs/docs/06-api-reference/interfaces/VADProps.md b/docs/docs/06-api-reference/interfaces/VADProps.md index 9ca612e816..3c4e7748db 100644 --- a/docs/docs/06-api-reference/interfaces/VADProps.md +++ b/docs/docs/06-api-reference/interfaces/VADProps.md @@ -1,6 +1,6 @@ # Interface: VADProps -Defined in: [packages/react-native-executorch/src/types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L12) +Defined in: [types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L12) Props for the useVAD hook. @@ -10,7 +10,7 @@ Props for the useVAD hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L13) +Defined in: [types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L13) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L14) +Defined in: [types/vad.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L14) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/VADType.md b/docs/docs/06-api-reference/interfaces/VADType.md index ebbe6dc161..38d8092e60 100644 --- a/docs/docs/06-api-reference/interfaces/VADType.md +++ b/docs/docs/06-api-reference/interfaces/VADType.md @@ -1,6 +1,6 @@ # Interface: VADType -Defined in: [packages/react-native-executorch/src/types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L34) +Defined in: [types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L34) React hook state and methods for managing a Voice Activity Detection (VAD) model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Voice Activity Detection (VAD) model > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L53) +Defined in: [types/vad.ts:53](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L53) Represents the download progress as a value between 0 and 1. @@ -20,7 +20,7 @@ Represents the download progress as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/vad.ts:38](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L38) +Defined in: [types/vad.ts:38](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L38) Contains the error message if the VAD model failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the VAD model failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L48) +Defined in: [types/vad.ts:48](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L48) Indicates whether the model is currently processing an inference. @@ -40,7 +40,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:43](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L43) +Defined in: [types/vad.ts:43](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L43) Indicates whether the VAD model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the VAD model has successfully loaded and is ready for inferen > **forward**(`waveform`): `Promise`\<[`Segment`](Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/types/vad.ts:61](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/vad.ts#L61) +Defined in: [types/vad.ts:61](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L61) Runs the Voice Activity Detection model on the provided audio waveform. diff --git a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md index 0134a51439..59a2ec3969 100644 --- a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md +++ b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md @@ -1,6 +1,6 @@ # Interface: VerticalOCRProps -Defined in: [packages/react-native-executorch/src/types/ocr.ts:70](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L70) +Defined in: [types/ocr.ts:70](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L70) Configuration properties for the `useVerticalOCR` hook. @@ -14,7 +14,7 @@ Configuration properties for the `useVerticalOCR` hook. > `optional` **independentCharacters**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:75](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L75) +Defined in: [types/ocr.ts:75](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L75) Boolean indicating whether to treat each character independently during recognition. Defaults to `false`. @@ -25,7 +25,7 @@ Defaults to `false`. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L41) +Defined in: [types/ocr.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L41) Object containing the necessary model sources and configuration for the OCR pipeline. @@ -57,7 +57,7 @@ The language configuration enum for the OCR model (e.g., English, Polish, etc.). > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:62](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L62) +Defined in: [types/ocr.ts:62](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L62) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/VoiceConfig.md b/docs/docs/06-api-reference/interfaces/VoiceConfig.md index cd81910560..0bfbc1d011 100644 --- a/docs/docs/06-api-reference/interfaces/VoiceConfig.md +++ b/docs/docs/06-api-reference/interfaces/VoiceConfig.md @@ -1,6 +1,6 @@ # Interface: VoiceConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L23) +Defined in: [types/tts.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L23) Voice configuration @@ -12,7 +12,7 @@ So far in Kokoro, each voice is directly associated with a language. > `optional` **extra**: [`KokoroVoiceExtras`](KokoroVoiceExtras.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L26) +Defined in: [types/tts.ts:26](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L26) an optional extra sources or properties related to specific voice @@ -22,7 +22,7 @@ an optional extra sources or properties related to specific voice > **lang**: [`TextToSpeechLanguage`](../type-aliases/TextToSpeechLanguage.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L24) +Defined in: [types/tts.ts:24](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L24) speaker's language @@ -32,6 +32,6 @@ speaker's language > **voiceSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L25) +Defined in: [types/tts.ts:25](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L25) a source to a binary file with voice embedding diff --git a/docs/docs/06-api-reference/interfaces/Word.md b/docs/docs/06-api-reference/interfaces/Word.md index 44c442a147..79c262948b 100644 --- a/docs/docs/06-api-reference/interfaces/Word.md +++ b/docs/docs/06-api-reference/interfaces/Word.md @@ -1,6 +1,6 @@ # Interface: Word -Defined in: [packages/react-native-executorch/src/types/stt.ts:208](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L208) +Defined in: [types/stt.ts:208](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L208) Structure that represent single token with timestamp information. @@ -10,7 +10,7 @@ Structure that represent single token with timestamp information. > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:211](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L211) +Defined in: [types/stt.ts:211](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L211) Timestamp of the end of the token in audio (in seconds). @@ -20,7 +20,7 @@ Timestamp of the end of the token in audio (in seconds). > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:210](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L210) +Defined in: [types/stt.ts:210](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L210) Timestamp of the beginning of the token in audio (in seconds). @@ -30,6 +30,6 @@ Timestamp of the beginning of the token in audio (in seconds). > **word**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:209](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L209) +Defined in: [types/stt.ts:209](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L209) Token as a string value. diff --git a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/calculateDownloadProgress.md b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/calculateDownloadProgress.md index fb5a096f1f..0e6b55b376 100644 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/calculateDownloadProgress.md +++ b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/calculateDownloadProgress.md @@ -2,7 +2,7 @@ > **calculateDownloadProgress**(`totalLength`, `previousFilesTotalLength`, `currentFileLength`, `setProgress`): (`progress`) => `void` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:155](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L155) +Defined in: [utils/ResourceFetcherUtils.ts:155](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L155) Creates a progress callback that scales the current file's progress relative to the total size of all files being downloaded. diff --git a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/getFilenameFromUri.md b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/getFilenameFromUri.md index 120292ba74..42704f548b 100644 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/getFilenameFromUri.md +++ b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/getFilenameFromUri.md @@ -2,7 +2,7 @@ > **getFilenameFromUri**(`uri`): `string` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:204](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L204) +Defined in: [utils/ResourceFetcherUtils.ts:204](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L204) Generates a safe filename from a URI by removing the protocol and replacing special characters. diff --git a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/hashObject.md b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/hashObject.md index c6a7e88a70..927eed1db8 100644 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/hashObject.md +++ b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/hashObject.md @@ -2,7 +2,7 @@ > **hashObject**(`jsonString`): `string` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:134](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L134) +Defined in: [utils/ResourceFetcherUtils.ts:134](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L134) Generates a hash from a string representation of an object. diff --git a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/removeFilePrefix.md b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/removeFilePrefix.md index 15af27036b..bada306c66 100644 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/removeFilePrefix.md +++ b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/removeFilePrefix.md @@ -2,7 +2,7 @@ > **removeFilePrefix**(`uri`): `string` -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:125](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L125) +Defined in: [utils/ResourceFetcherUtils.ts:125](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L125) Removes the 'file://' prefix from a URI if it exists. diff --git a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/triggerHuggingFaceDownloadCounter.md b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/triggerHuggingFaceDownloadCounter.md index 542a3d058c..7a0dba6170 100644 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/triggerHuggingFaceDownloadCounter.md +++ b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/triggerHuggingFaceDownloadCounter.md @@ -2,7 +2,7 @@ > **triggerHuggingFaceDownloadCounter**(`uri`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts:188](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L188) +Defined in: [utils/ResourceFetcherUtils.ts:188](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcherUtils.ts#L188) Increments the Hugging Face download counter if the URI points to a Software Mansion Hugging Face repo. More information: https://huggingface.co/docs/hub/models-download-stats diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md index 4290ed5ed4..1247bb1f91 100644 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -2,7 +2,7 @@ > **LLMTool** = `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:208](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L208) +Defined in: [types/llm.ts:208](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L208) Represents a tool that can be used by the model. Usually tool is represented with dictionary (Object), but fields depend on the model. diff --git a/docs/docs/06-api-reference/type-aliases/LabelEnum.md b/docs/docs/06-api-reference/type-aliases/LabelEnum.md index 9414676dce..d7e161150b 100644 --- a/docs/docs/06-api-reference/type-aliases/LabelEnum.md +++ b/docs/docs/06-api-reference/type-aliases/LabelEnum.md @@ -2,7 +2,7 @@ > **LabelEnum** = `Readonly`\<`Record`\<`string`, `number` \| `string`\>\> -Defined in: [packages/react-native-executorch/src/types/common.ts:146](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/common.ts#L146) +Defined in: [types/common.ts:146](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L146) A readonly record mapping string keys to numeric or string values. Used to represent enum-like label maps for models. diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md index daa0729e1d..2a03ef04be 100644 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -2,6 +2,6 @@ > **MessageRole** = `"user"` \| `"assistant"` \| `"system"` -Defined in: [packages/react-native-executorch/src/types/llm.ts:175](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L175) +Defined in: [types/llm.ts:175](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L175) Roles that a message sender can have. diff --git a/docs/docs/06-api-reference/type-aliases/ModelNameOf.md b/docs/docs/06-api-reference/type-aliases/ModelNameOf.md index e962ab6988..f4104e2e7f 100644 --- a/docs/docs/06-api-reference/type-aliases/ModelNameOf.md +++ b/docs/docs/06-api-reference/type-aliases/ModelNameOf.md @@ -2,7 +2,7 @@ > **ModelNameOf**\<`C`\> = `C`\[`"modelName"`\] -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:45](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/imageSegmentation.ts#L45) +Defined in: [types/imageSegmentation.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L44) Extracts the model name from a [ModelSources](ModelSources.md) config object. diff --git a/docs/docs/06-api-reference/type-aliases/ModelSources.md b/docs/docs/06-api-reference/type-aliases/ModelSources.md index eefe516413..2cb34d39f6 100644 --- a/docs/docs/06-api-reference/type-aliases/ModelSources.md +++ b/docs/docs/06-api-reference/type-aliases/ModelSources.md @@ -1,8 +1,8 @@ # Type Alias: ModelSources -> **ModelSources** = \{ `modelName`: `"deeplab-v3"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"selfie-segmentation"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"rfdetr"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} +> **ModelSources** = \{ `modelName`: `"deeplab-v3"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"selfie-segmentation"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) +Defined in: [types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) Per-model config for [ImageSegmentationModule.fromModelName](../classes/ImageSegmentationModule.md#frommodelname). Each model name maps to its required fields. diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md index 3f0e11a251..0dd89381ee 100644 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -2,6 +2,6 @@ > **OCRLanguage** = keyof _typeof_ `symbols` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:119](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/ocr.ts#L119) +Defined in: [types/ocr.ts:119](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/ocr.ts#L119) Enumeration of supported OCR languages based on available symbol sets. diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md index a8b5e21005..6a956d2f90 100644 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -2,6 +2,6 @@ > **ResourceSource** = `string` \| `number` \| `object` -Defined in: [packages/react-native-executorch/src/types/common.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L10) +Defined in: [types/common.ts:10](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L10) Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). diff --git a/docs/docs/06-api-reference/type-aliases/SegmentationConfig.md b/docs/docs/06-api-reference/type-aliases/SegmentationConfig.md index ce957311da..a3185cdf34 100644 --- a/docs/docs/06-api-reference/type-aliases/SegmentationConfig.md +++ b/docs/docs/06-api-reference/type-aliases/SegmentationConfig.md @@ -2,7 +2,7 @@ > **SegmentationConfig**\<`T`\> = `object` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) Configuration for a custom segmentation model. @@ -20,7 +20,7 @@ The [LabelEnum](LabelEnum.md) type for the model. > **labelMap**: `T` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) The enum-like object mapping class names to indices. @@ -30,7 +30,7 @@ The enum-like object mapping class names to indices. > `optional` **preprocessorConfig**: `object` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) Optional preprocessing parameters. diff --git a/docs/docs/06-api-reference/type-aliases/SegmentationLabels.md b/docs/docs/06-api-reference/type-aliases/SegmentationLabels.md index 96939a3465..418a33d15f 100644 --- a/docs/docs/06-api-reference/type-aliases/SegmentationLabels.md +++ b/docs/docs/06-api-reference/type-aliases/SegmentationLabels.md @@ -2,7 +2,7 @@ > **SegmentationLabels**\<`M`\> = `ModelConfigsType`\[`M`\]\[`"labelMap"`\] -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L45) +Defined in: [modules/computer_vision/ImageSegmentationModule.ts:39](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L39) Resolves the [LabelEnum](LabelEnum.md) for a given built-in model name. diff --git a/docs/docs/06-api-reference/type-aliases/SegmentationModelName.md b/docs/docs/06-api-reference/type-aliases/SegmentationModelName.md index ba7197d06f..53ece64f19 100644 --- a/docs/docs/06-api-reference/type-aliases/SegmentationModelName.md +++ b/docs/docs/06-api-reference/type-aliases/SegmentationModelName.md @@ -2,7 +2,7 @@ > **SegmentationModelName** = [`ModelSources`](ModelSources.md)\[`"modelName"`\] -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/imageSegmentation.ts#L38) +Defined in: [types/imageSegmentation.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageSegmentation.ts#L37) Union of all built-in segmentation model names -(e.g. `'deeplab-v3'`, `'selfie-segmentation'`, `'rfdetr'`). +(e.g. `'deeplab-v3'`, `'selfie-segmentation'`). diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md index b36cf4410c..5e9653afb2 100644 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -2,6 +2,6 @@ > **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:110](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/stt.ts#L110) +Defined in: [types/stt.ts:110](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/stt.ts#L110) Languages supported by whisper (not whisper.en) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md index a1393e7f3f..62ac207e19 100644 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -2,6 +2,6 @@ > **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` -Defined in: [packages/react-native-executorch/src/types/common.ts:113](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/common.ts#L113) +Defined in: [types/common.ts:113](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L113) Represents the data buffer of a tensor, which can be one of several typed array formats. diff --git a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md index 0d95c3e22a..51caa86982 100644 --- a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md @@ -2,6 +2,6 @@ > **TextToSpeechLanguage** = `"en-us"` \| `"en-gb"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/tts.ts#L9) +Defined in: [types/tts.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L9) List all the languages available in TTS models (as lang shorthands) diff --git a/docs/docs/06-api-reference/type-aliases/Triple.md b/docs/docs/06-api-reference/type-aliases/Triple.md index 41fa3d2b1b..b8d8308974 100644 --- a/docs/docs/06-api-reference/type-aliases/Triple.md +++ b/docs/docs/06-api-reference/type-aliases/Triple.md @@ -2,7 +2,7 @@ > **Triple**\<`T`\> = readonly \[`T`, `T`, `T`\] -Defined in: [packages/react-native-executorch/src/types/common.ts:153](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/types/common.ts#L153) +Defined in: [types/common.ts:153](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L153) A readonly triple of values, typically used for per-channel normalization parameters. diff --git a/docs/docs/06-api-reference/typedoc-sidebar.cjs b/docs/docs/06-api-reference/typedoc-sidebar.cjs index c16362d3d7..00f1f4072b 100644 --- a/docs/docs/06-api-reference/typedoc-sidebar.cjs +++ b/docs/docs/06-api-reference/typedoc-sidebar.cjs @@ -1,4 +1,4 @@ // @ts-check /** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ -const typedocSidebar = {items:[{type:"category",label:"Hooks",items:[{type:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"06-api-reference/interfaces/ResourceSourceExtended",label:"ResourceSourceExtended"}]},{type:"category",label:"Models - Classification",items:[{type:"doc",id:"06-api-reference/variables/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"}]},{type:"category",label:"Models - Image Embeddings",items:[{type:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"}]},{type:"category",label:"Models - Image Generation",items:[{type:"doc",id:"06-api-reference/variables/BK_SDM_TINY_VPRED_256",label:"BK_SDM_TINY_VPRED_256"},{type:"doc",id:"06-api-reference/variables/BK_SDM_TINY_VPRED_512",label:"BK_SDM_TINY_VPRED_512"}]},{type:"category",label:"Models - Image Segmentation",items:[{type:"doc",id:"06-api-reference/variables/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"}]},{type:"category",label:"Models - LMM",items:[{type:"doc",id:"06-api-reference/variables/HAMMER2_1_0_5B",label:"HAMMER2_1_0_5B"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED",label:"HAMMER2_1_0_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_1_5B",label:"HAMMER2_1_1_5B"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED",label:"HAMMER2_1_1_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_3B",label:"HAMMER2_1_3B"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_3B_QUANTIZED",label:"HAMMER2_1_3B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_1B",label:"LLAMA3_2_1B"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_1B_QLORA",label:"LLAMA3_2_1B_QLORA"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_1B_SPINQUANT",label:"LLAMA3_2_1B_SPINQUANT"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_3B",label:"LLAMA3_2_3B"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_3B_QLORA",label:"LLAMA3_2_3B_QLORA"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_3B_SPINQUANT",label:"LLAMA3_2_3B_SPINQUANT"},{type:"doc",id:"06-api-reference/variables/PHI_4_MINI_4B",label:"PHI_4_MINI_4B"},{type:"doc",id:"06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED",label:"PHI_4_MINI_4B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_0_5B",label:"QWEN2_5_0_5B"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED",label:"QWEN2_5_0_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_1_5B",label:"QWEN2_5_1_5B"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED",label:"QWEN2_5_1_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_3B",label:"QWEN2_5_3B"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_3B_QUANTIZED",label:"QWEN2_5_3B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN3_0_6B",label:"QWEN3_0_6B"},{type:"doc",id:"06-api-reference/variables/QWEN3_0_6B_QUANTIZED",label:"QWEN3_0_6B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN3_1_7B",label:"QWEN3_1_7B"},{type:"doc",id:"06-api-reference/variables/QWEN3_1_7B_QUANTIZED",label:"QWEN3_1_7B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN3_4B",label:"QWEN3_4B"},{type:"doc",id:"06-api-reference/variables/QWEN3_4B_QUANTIZED",label:"QWEN3_4B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_1_7B",label:"SMOLLM2_1_1_7B"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED",label:"SMOLLM2_1_1_7B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_135M",label:"SMOLLM2_1_135M"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED",label:"SMOLLM2_1_135M_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_360M",label:"SMOLLM2_1_360M"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED",label:"SMOLLM2_1_360M_QUANTIZED"}]},{type:"category",label:"Models - Object Detection",items:[{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"}]},{type:"category",label:"Models - Speech To Text",items:[{type:"doc",id:"06-api-reference/variables/WHISPER_BASE",label:"WHISPER_BASE"},{type:"doc",id:"06-api-reference/variables/WHISPER_BASE_EN",label:"WHISPER_BASE_EN"},{type:"doc",id:"06-api-reference/variables/WHISPER_SMALL",label:"WHISPER_SMALL"},{type:"doc",id:"06-api-reference/variables/WHISPER_SMALL_EN",label:"WHISPER_SMALL_EN"},{type:"doc",id:"06-api-reference/variables/WHISPER_TINY",label:"WHISPER_TINY"},{type:"doc",id:"06-api-reference/variables/WHISPER_TINY_EN",label:"WHISPER_TINY_EN"},{type:"doc",id:"06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED",label:"WHISPER_TINY_EN_QUANTIZED"}]},{type:"category",label:"Models - Style Transfer",items:[{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_CANDY",label:"STYLE_TRANSFER_CANDY"},{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_MOSAIC",label:"STYLE_TRANSFER_MOSAIC"},{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS",label:"STYLE_TRANSFER_RAIN_PRINCESS"},{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_UDNIE",label:"STYLE_TRANSFER_UDNIE"}]},{type:"category",label:"Models - Text Embeddings",items:[{type:"doc",id:"06-api-reference/variables/ALL_MINILM_L6_V2",label:"ALL_MINILM_L6_V2"},{type:"doc",id:"06-api-reference/variables/ALL_MPNET_BASE_V2",label:"ALL_MPNET_BASE_V2"},{type:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT",label:"CLIP_VIT_BASE_PATCH32_TEXT"},{type:"doc",id:"06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1",label:"MULTI_QA_MINILM_L6_COS_V1"},{type:"doc",id:"06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1",label:"MULTI_QA_MPNET_BASE_DOT_V1"}]},{type:"category",label:"Models - Text to Speech",items:[{type:"doc",id:"06-api-reference/variables/KOKORO_MEDIUM",label:"KOKORO_MEDIUM"},{type:"doc",id:"06-api-reference/variables/KOKORO_SMALL",label:"KOKORO_SMALL"}]},{type:"category",label:"Models - Voice Activity Detection",items:[{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"}]},{type:"category",label:"OCR Supported Alphabets",items:[{type:"doc",id:"06-api-reference/variables/OCR_ABAZA",label:"OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/OCR_ADYGHE",label:"OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/OCR_AFRIKAANS",label:"OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/OCR_ALBANIAN",label:"OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/OCR_AVAR",label:"OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/OCR_AZERBAIJANI",label:"OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/OCR_BELARUSIAN",label:"OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/OCR_BOSNIAN",label:"OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/OCR_BULGARIAN",label:"OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/OCR_CHECHEN",label:"OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/OCR_CROATIAN",label:"OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/OCR_CZECH",label:"OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/OCR_DANISH",label:"OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/OCR_DARGWA",label:"OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/OCR_DUTCH",label:"OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/OCR_ENGLISH",label:"OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/OCR_ESTONIAN",label:"OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/OCR_FRENCH",label:"OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/OCR_GERMAN",label:"OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/OCR_HUNGARIAN",label:"OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/OCR_ICELANDIC",label:"OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/OCR_INDONESIAN",label:"OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/OCR_INGUSH",label:"OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/OCR_IRISH",label:"OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/OCR_ITALIAN",label:"OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/OCR_JAPANESE",label:"OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/OCR_KANNADA",label:"OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/OCR_KARBADIAN",label:"OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/OCR_KOREAN",label:"OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/OCR_KURDISH",label:"OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/OCR_LAK",label:"OCR_LAK"},{type:"doc",id:"06-api-reference/variables/OCR_LATIN",label:"OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/OCR_LATVIAN",label:"OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/OCR_LEZGHIAN",label:"OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/OCR_LITHUANIAN",label:"OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/OCR_MALAY",label:"OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/OCR_MALTESE",label:"OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/OCR_MAORI",label:"OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/OCR_MONGOLIAN",label:"OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/OCR_NORWEGIAN",label:"OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/OCR_OCCITAN",label:"OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/OCR_PALI",label:"OCR_PALI"},{type:"doc",id:"06-api-reference/variables/OCR_POLISH",label:"OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/OCR_PORTUGUESE",label:"OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/OCR_ROMANIAN",label:"OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/OCR_RUSSIAN",label:"OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/OCR_SERBIAN_CYRILLIC",label:"OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/OCR_SERBIAN_LATIN",label:"OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/OCR_SIMPLIFIED_CHINESE",label:"OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/OCR_SLOVAK",label:"OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/OCR_SLOVENIAN",label:"OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/OCR_SPANISH",label:"OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/OCR_SWAHILI",label:"OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/OCR_SWEDISH",label:"OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/OCR_TABASSARAN",label:"OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/OCR_TAGALOG",label:"OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/OCR_TAJIK",label:"OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/OCR_TELUGU",label:"OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/OCR_TURKISH",label:"OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/OCR_UKRAINIAN",label:"OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/OCR_UZBEK",label:"OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/OCR_VIETNAMESE",label:"OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/OCR_WELSH",label:"OCR_WELSH"}]},{type:"category",label:"Other",items:[{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/classes/Logger",label:"Logger"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"}]},{type:"category",label:"TTS Supported Voices",items:[{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AF_HEART",label:"KOKORO_VOICE_AF_HEART"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AF_RIVER",label:"KOKORO_VOICE_AF_RIVER"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AF_SARAH",label:"KOKORO_VOICE_AF_SARAH"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AM_ADAM",label:"KOKORO_VOICE_AM_ADAM"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL",label:"KOKORO_VOICE_AM_MICHAEL"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AM_SANTA",label:"KOKORO_VOICE_AM_SANTA"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_BF_EMMA",label:"KOKORO_VOICE_BF_EMMA"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_BM_DANIEL",label:"KOKORO_VOICE_BM_DANIEL"}]},{type:"category",label:"Types",items:[{type:"doc",id:"06-api-reference/enumerations/CocoLabel",label:"CocoLabel"},{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/DownloadStatus",label:"DownloadStatus"},{type:"doc",id:"06-api-reference/enumerations/HTTP_CODE",label:"HTTP_CODE"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"},{type:"doc",id:"06-api-reference/enumerations/SourceType",label:"SourceType"},{type:"doc",id:"06-api-reference/interfaces/Bbox",label:"Bbox"},{type:"doc",id:"06-api-reference/interfaces/ChatConfig",label:"ChatConfig"},{type:"doc",id:"06-api-reference/interfaces/ClassificationProps",label:"ClassificationProps"},{type:"doc",id:"06-api-reference/interfaces/ClassificationType",label:"ClassificationType"},{type:"doc",id:"06-api-reference/interfaces/ContextStrategy",label:"ContextStrategy"},{type:"doc",id:"06-api-reference/interfaces/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleProps",label:"ExecutorchModuleProps"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleType",label:"ExecutorchModuleType"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsProps",label:"ImageEmbeddingsProps"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsType",label:"ImageEmbeddingsType"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationProps",label:"ImageSegmentationProps"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationType",label:"ImageSegmentationType"},{type:"doc",id:"06-api-reference/interfaces/KokoroConfig",label:"KokoroConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroVoiceExtras",label:"KokoroVoiceExtras"},{type:"doc",id:"06-api-reference/interfaces/LLMConfig",label:"LLMConfig"},{type:"doc",id:"06-api-reference/interfaces/LLMProps",label:"LLMProps"},{type:"doc",id:"06-api-reference/interfaces/LLMType",label:"LLMType"},{type:"doc",id:"06-api-reference/interfaces/Message",label:"Message"},{type:"doc",id:"06-api-reference/interfaces/ObjectDetectionProps",label:"ObjectDetectionProps"},{type:"doc",id:"06-api-reference/interfaces/ObjectDetectionType",label:"ObjectDetectionType"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/OCRProps",label:"OCRProps"},{type:"doc",id:"06-api-reference/interfaces/OCRType",label:"OCRType"},{type:"doc",id:"06-api-reference/interfaces/Point",label:"Point"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextProps",label:"SpeechToTextProps"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextType",label:"SpeechToTextType"},{type:"doc",id:"06-api-reference/interfaces/StyleTransferProps",label:"StyleTransferProps"},{type:"doc",id:"06-api-reference/interfaces/StyleTransferType",label:"StyleTransferType"},{type:"doc",id:"06-api-reference/interfaces/TensorPtr",label:"TensorPtr"},{type:"doc",id:"06-api-reference/interfaces/TextEmbeddingsProps",label:"TextEmbeddingsProps"},{type:"doc",id:"06-api-reference/interfaces/TextEmbeddingsType",label:"TextEmbeddingsType"},{type:"doc",id:"06-api-reference/interfaces/TextToImageProps",label:"TextToImageProps"},{type:"doc",id:"06-api-reference/interfaces/TextToImageType",label:"TextToImageType"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechConfig",label:"TextToSpeechConfig"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechInput",label:"TextToSpeechInput"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechProps",label:"TextToSpeechProps"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechStreamingInput",label:"TextToSpeechStreamingInput"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechType",label:"TextToSpeechType"},{type:"doc",id:"06-api-reference/interfaces/TokenizerProps",label:"TokenizerProps"},{type:"doc",id:"06-api-reference/interfaces/TokenizerType",label:"TokenizerType"},{type:"doc",id:"06-api-reference/interfaces/ToolCall",label:"ToolCall"},{type:"doc",id:"06-api-reference/interfaces/ToolsConfig",label:"ToolsConfig"},{type:"doc",id:"06-api-reference/interfaces/TranscriptionResult",label:"TranscriptionResult"},{type:"doc",id:"06-api-reference/interfaces/TranscriptionSegment",label:"TranscriptionSegment"},{type:"doc",id:"06-api-reference/interfaces/VADProps",label:"VADProps"},{type:"doc",id:"06-api-reference/interfaces/VADType",label:"VADType"},{type:"doc",id:"06-api-reference/interfaces/VerticalOCRProps",label:"VerticalOCRProps"},{type:"doc",id:"06-api-reference/interfaces/VoiceConfig",label:"VoiceConfig"},{type:"doc",id:"06-api-reference/interfaces/Word",label:"Word"},{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"},{type:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"}]},{type:"category",label:"Typescript API",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/SpeechToTextModule",label:"SpeechToTextModule"},{type:"doc",id:"06-api-reference/classes/StyleTransferModule",label:"StyleTransferModule"},{type:"doc",id:"06-api-reference/classes/TextEmbeddingsModule",label:"TextEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/TextToImageModule",label:"TextToImageModule"},{type:"doc",id:"06-api-reference/classes/TextToSpeechModule",label:"TextToSpeechModule"},{type:"doc",id:"06-api-reference/classes/TokenizerModule",label:"TokenizerModule"},{type:"doc",id:"06-api-reference/classes/VADModule",label:"VADModule"},{type:"doc",id:"06-api-reference/classes/VerticalOCRModule",label:"VerticalOCRModule"}]},{type:"category",label:"Utilities - General",items:[{type:"category",label:"ResourceFetcherUtils",items:[{type:"category",label:"Functions",items:[{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/calculateDownloadProgress",label:"calculateDownloadProgress"},{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/getFilenameFromUri",label:"getFilenameFromUri"},{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/hashObject",label:"hashObject"},{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/removeFilePrefix",label:"removeFilePrefix"},{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/triggerHuggingFaceDownloadCounter",label:"triggerHuggingFaceDownloadCounter"}]}],link:{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/index"}},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchConfig",label:"ExecutorchConfig"},{type:"doc",id:"06-api-reference/interfaces/ResourceFetcherAdapter",label:"ResourceFetcherAdapter"},{type:"doc",id:"06-api-reference/functions/cleanupExecutorch",label:"cleanupExecutorch"},{type:"doc",id:"06-api-reference/functions/initExecutorch",label:"initExecutorch"}]},{type:"category",label:"Utilities - LLM",items:[{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_BUFFER_TOKENS",label:"DEFAULT_CONTEXT_BUFFER_TOKENS"},{type:"doc",id:"06-api-reference/variables/DEFAULT_MESSAGE_HISTORY",label:"DEFAULT_MESSAGE_HISTORY"},{type:"doc",id:"06-api-reference/variables/DEFAULT_SYSTEM_PROMPT",label:"DEFAULT_SYSTEM_PROMPT"},{type:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{type:"doc",id:"06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT",label:"DEFAULT_STRUCTURED_OUTPUT_PROMPT"},{type:"doc",id:"06-api-reference/functions/fixAndValidateStructuredOutput",label:"fixAndValidateStructuredOutput"},{type:"doc",id:"06-api-reference/functions/getStructuredOutputPrompt",label:"getStructuredOutputPrompt"}]},{type:"category",label:"Utils",items:[{type:"doc",id:"06-api-reference/classes/MessageCountContextStrategy",label:"MessageCountContextStrategy"},{type:"doc",id:"06-api-reference/classes/NoopContextStrategy",label:"NoopContextStrategy"},{type:"doc",id:"06-api-reference/classes/SlidingWindowContextStrategy",label:"SlidingWindowContextStrategy"}]}]}; +const typedocSidebar = {items:[{type:"category",label:"Hooks",items:[{type:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"06-api-reference/interfaces/ResourceSourceExtended",label:"ResourceSourceExtended"}]},{type:"category",label:"Models - Classification",items:[{type:"doc",id:"06-api-reference/variables/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"}]},{type:"category",label:"Models - Image Embeddings",items:[{type:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"}]},{type:"category",label:"Models - Image Generation",items:[{type:"doc",id:"06-api-reference/variables/BK_SDM_TINY_VPRED_256",label:"BK_SDM_TINY_VPRED_256"},{type:"doc",id:"06-api-reference/variables/BK_SDM_TINY_VPRED_512",label:"BK_SDM_TINY_VPRED_512"}]},{type:"category",label:"Models - Image Segmentation",items:[{type:"doc",id:"06-api-reference/variables/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/SELFIE_SEGMENTATION",label:"SELFIE_SEGMENTATION"}]},{type:"category",label:"Models - LMM",items:[{type:"doc",id:"06-api-reference/variables/HAMMER2_1_0_5B",label:"HAMMER2_1_0_5B"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED",label:"HAMMER2_1_0_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_1_5B",label:"HAMMER2_1_1_5B"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED",label:"HAMMER2_1_1_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_3B",label:"HAMMER2_1_3B"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_3B_QUANTIZED",label:"HAMMER2_1_3B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_1B",label:"LLAMA3_2_1B"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_1B_QLORA",label:"LLAMA3_2_1B_QLORA"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_1B_SPINQUANT",label:"LLAMA3_2_1B_SPINQUANT"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_3B",label:"LLAMA3_2_3B"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_3B_QLORA",label:"LLAMA3_2_3B_QLORA"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_3B_SPINQUANT",label:"LLAMA3_2_3B_SPINQUANT"},{type:"doc",id:"06-api-reference/variables/PHI_4_MINI_4B",label:"PHI_4_MINI_4B"},{type:"doc",id:"06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED",label:"PHI_4_MINI_4B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_0_5B",label:"QWEN2_5_0_5B"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED",label:"QWEN2_5_0_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_1_5B",label:"QWEN2_5_1_5B"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED",label:"QWEN2_5_1_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_3B",label:"QWEN2_5_3B"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_3B_QUANTIZED",label:"QWEN2_5_3B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN3_0_6B",label:"QWEN3_0_6B"},{type:"doc",id:"06-api-reference/variables/QWEN3_0_6B_QUANTIZED",label:"QWEN3_0_6B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN3_1_7B",label:"QWEN3_1_7B"},{type:"doc",id:"06-api-reference/variables/QWEN3_1_7B_QUANTIZED",label:"QWEN3_1_7B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN3_4B",label:"QWEN3_4B"},{type:"doc",id:"06-api-reference/variables/QWEN3_4B_QUANTIZED",label:"QWEN3_4B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_1_7B",label:"SMOLLM2_1_1_7B"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED",label:"SMOLLM2_1_1_7B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_135M",label:"SMOLLM2_1_135M"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED",label:"SMOLLM2_1_135M_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_360M",label:"SMOLLM2_1_360M"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED",label:"SMOLLM2_1_360M_QUANTIZED"}]},{type:"category",label:"Models - Object Detection",items:[{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"}]},{type:"category",label:"Models - Speech To Text",items:[{type:"doc",id:"06-api-reference/variables/WHISPER_BASE",label:"WHISPER_BASE"},{type:"doc",id:"06-api-reference/variables/WHISPER_BASE_EN",label:"WHISPER_BASE_EN"},{type:"doc",id:"06-api-reference/variables/WHISPER_SMALL",label:"WHISPER_SMALL"},{type:"doc",id:"06-api-reference/variables/WHISPER_SMALL_EN",label:"WHISPER_SMALL_EN"},{type:"doc",id:"06-api-reference/variables/WHISPER_TINY",label:"WHISPER_TINY"},{type:"doc",id:"06-api-reference/variables/WHISPER_TINY_EN",label:"WHISPER_TINY_EN"},{type:"doc",id:"06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED",label:"WHISPER_TINY_EN_QUANTIZED"}]},{type:"category",label:"Models - Style Transfer",items:[{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_CANDY",label:"STYLE_TRANSFER_CANDY"},{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_MOSAIC",label:"STYLE_TRANSFER_MOSAIC"},{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS",label:"STYLE_TRANSFER_RAIN_PRINCESS"},{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_UDNIE",label:"STYLE_TRANSFER_UDNIE"}]},{type:"category",label:"Models - Text Embeddings",items:[{type:"doc",id:"06-api-reference/variables/ALL_MINILM_L6_V2",label:"ALL_MINILM_L6_V2"},{type:"doc",id:"06-api-reference/variables/ALL_MPNET_BASE_V2",label:"ALL_MPNET_BASE_V2"},{type:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT",label:"CLIP_VIT_BASE_PATCH32_TEXT"},{type:"doc",id:"06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1",label:"MULTI_QA_MINILM_L6_COS_V1"},{type:"doc",id:"06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1",label:"MULTI_QA_MPNET_BASE_DOT_V1"}]},{type:"category",label:"Models - Text to Speech",items:[{type:"doc",id:"06-api-reference/variables/KOKORO_MEDIUM",label:"KOKORO_MEDIUM"},{type:"doc",id:"06-api-reference/variables/KOKORO_SMALL",label:"KOKORO_SMALL"}]},{type:"category",label:"Models - Voice Activity Detection",items:[{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"}]},{type:"category",label:"OCR Supported Alphabets",items:[{type:"doc",id:"06-api-reference/variables/OCR_ABAZA",label:"OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/OCR_ADYGHE",label:"OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/OCR_AFRIKAANS",label:"OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/OCR_ALBANIAN",label:"OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/OCR_AVAR",label:"OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/OCR_AZERBAIJANI",label:"OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/OCR_BELARUSIAN",label:"OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/OCR_BOSNIAN",label:"OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/OCR_BULGARIAN",label:"OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/OCR_CHECHEN",label:"OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/OCR_CROATIAN",label:"OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/OCR_CZECH",label:"OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/OCR_DANISH",label:"OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/OCR_DARGWA",label:"OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/OCR_DUTCH",label:"OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/OCR_ENGLISH",label:"OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/OCR_ESTONIAN",label:"OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/OCR_FRENCH",label:"OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/OCR_GERMAN",label:"OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/OCR_HUNGARIAN",label:"OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/OCR_ICELANDIC",label:"OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/OCR_INDONESIAN",label:"OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/OCR_INGUSH",label:"OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/OCR_IRISH",label:"OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/OCR_ITALIAN",label:"OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/OCR_JAPANESE",label:"OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/OCR_KANNADA",label:"OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/OCR_KARBADIAN",label:"OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/OCR_KOREAN",label:"OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/OCR_KURDISH",label:"OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/OCR_LAK",label:"OCR_LAK"},{type:"doc",id:"06-api-reference/variables/OCR_LATIN",label:"OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/OCR_LATVIAN",label:"OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/OCR_LEZGHIAN",label:"OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/OCR_LITHUANIAN",label:"OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/OCR_MALAY",label:"OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/OCR_MALTESE",label:"OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/OCR_MAORI",label:"OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/OCR_MONGOLIAN",label:"OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/OCR_NORWEGIAN",label:"OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/OCR_OCCITAN",label:"OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/OCR_PALI",label:"OCR_PALI"},{type:"doc",id:"06-api-reference/variables/OCR_POLISH",label:"OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/OCR_PORTUGUESE",label:"OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/OCR_ROMANIAN",label:"OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/OCR_RUSSIAN",label:"OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/OCR_SERBIAN_CYRILLIC",label:"OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/OCR_SERBIAN_LATIN",label:"OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/OCR_SIMPLIFIED_CHINESE",label:"OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/OCR_SLOVAK",label:"OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/OCR_SLOVENIAN",label:"OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/OCR_SPANISH",label:"OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/OCR_SWAHILI",label:"OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/OCR_SWEDISH",label:"OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/OCR_TABASSARAN",label:"OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/OCR_TAGALOG",label:"OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/OCR_TAJIK",label:"OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/OCR_TELUGU",label:"OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/OCR_TURKISH",label:"OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/OCR_UKRAINIAN",label:"OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/OCR_UZBEK",label:"OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/OCR_VIETNAMESE",label:"OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/OCR_WELSH",label:"OCR_WELSH"}]},{type:"category",label:"Other",items:[{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/classes/Logger",label:"Logger"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"}]},{type:"category",label:"TTS Supported Voices",items:[{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AF_HEART",label:"KOKORO_VOICE_AF_HEART"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AF_RIVER",label:"KOKORO_VOICE_AF_RIVER"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AF_SARAH",label:"KOKORO_VOICE_AF_SARAH"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AM_ADAM",label:"KOKORO_VOICE_AM_ADAM"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL",label:"KOKORO_VOICE_AM_MICHAEL"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AM_SANTA",label:"KOKORO_VOICE_AM_SANTA"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_BF_EMMA",label:"KOKORO_VOICE_BF_EMMA"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_BM_DANIEL",label:"KOKORO_VOICE_BM_DANIEL"}]},{type:"category",label:"Types",items:[{type:"doc",id:"06-api-reference/enumerations/CocoLabel",label:"CocoLabel"},{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/DownloadStatus",label:"DownloadStatus"},{type:"doc",id:"06-api-reference/enumerations/HTTP_CODE",label:"HTTP_CODE"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"},{type:"doc",id:"06-api-reference/enumerations/SelfieSegmentationLabel",label:"SelfieSegmentationLabel"},{type:"doc",id:"06-api-reference/enumerations/SourceType",label:"SourceType"},{type:"doc",id:"06-api-reference/interfaces/Bbox",label:"Bbox"},{type:"doc",id:"06-api-reference/interfaces/ChatConfig",label:"ChatConfig"},{type:"doc",id:"06-api-reference/interfaces/ClassificationProps",label:"ClassificationProps"},{type:"doc",id:"06-api-reference/interfaces/ClassificationType",label:"ClassificationType"},{type:"doc",id:"06-api-reference/interfaces/ContextStrategy",label:"ContextStrategy"},{type:"doc",id:"06-api-reference/interfaces/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleProps",label:"ExecutorchModuleProps"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleType",label:"ExecutorchModuleType"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsProps",label:"ImageEmbeddingsProps"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsType",label:"ImageEmbeddingsType"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationProps",label:"ImageSegmentationProps"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationType",label:"ImageSegmentationType"},{type:"doc",id:"06-api-reference/interfaces/KokoroConfig",label:"KokoroConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroVoiceExtras",label:"KokoroVoiceExtras"},{type:"doc",id:"06-api-reference/interfaces/LLMConfig",label:"LLMConfig"},{type:"doc",id:"06-api-reference/interfaces/LLMProps",label:"LLMProps"},{type:"doc",id:"06-api-reference/interfaces/LLMType",label:"LLMType"},{type:"doc",id:"06-api-reference/interfaces/Message",label:"Message"},{type:"doc",id:"06-api-reference/interfaces/ObjectDetectionProps",label:"ObjectDetectionProps"},{type:"doc",id:"06-api-reference/interfaces/ObjectDetectionType",label:"ObjectDetectionType"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/OCRProps",label:"OCRProps"},{type:"doc",id:"06-api-reference/interfaces/OCRType",label:"OCRType"},{type:"doc",id:"06-api-reference/interfaces/Point",label:"Point"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextProps",label:"SpeechToTextProps"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextType",label:"SpeechToTextType"},{type:"doc",id:"06-api-reference/interfaces/StyleTransferProps",label:"StyleTransferProps"},{type:"doc",id:"06-api-reference/interfaces/StyleTransferType",label:"StyleTransferType"},{type:"doc",id:"06-api-reference/interfaces/TensorPtr",label:"TensorPtr"},{type:"doc",id:"06-api-reference/interfaces/TextEmbeddingsProps",label:"TextEmbeddingsProps"},{type:"doc",id:"06-api-reference/interfaces/TextEmbeddingsType",label:"TextEmbeddingsType"},{type:"doc",id:"06-api-reference/interfaces/TextToImageProps",label:"TextToImageProps"},{type:"doc",id:"06-api-reference/interfaces/TextToImageType",label:"TextToImageType"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechConfig",label:"TextToSpeechConfig"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechInput",label:"TextToSpeechInput"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechProps",label:"TextToSpeechProps"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechStreamingInput",label:"TextToSpeechStreamingInput"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechType",label:"TextToSpeechType"},{type:"doc",id:"06-api-reference/interfaces/TokenizerProps",label:"TokenizerProps"},{type:"doc",id:"06-api-reference/interfaces/TokenizerType",label:"TokenizerType"},{type:"doc",id:"06-api-reference/interfaces/ToolCall",label:"ToolCall"},{type:"doc",id:"06-api-reference/interfaces/ToolsConfig",label:"ToolsConfig"},{type:"doc",id:"06-api-reference/interfaces/TranscriptionResult",label:"TranscriptionResult"},{type:"doc",id:"06-api-reference/interfaces/TranscriptionSegment",label:"TranscriptionSegment"},{type:"doc",id:"06-api-reference/interfaces/VADProps",label:"VADProps"},{type:"doc",id:"06-api-reference/interfaces/VADType",label:"VADType"},{type:"doc",id:"06-api-reference/interfaces/VerticalOCRProps",label:"VerticalOCRProps"},{type:"doc",id:"06-api-reference/interfaces/VoiceConfig",label:"VoiceConfig"},{type:"doc",id:"06-api-reference/interfaces/Word",label:"Word"},{type:"doc",id:"06-api-reference/type-aliases/LabelEnum",label:"LabelEnum"},{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/ModelNameOf",label:"ModelNameOf"},{type:"doc",id:"06-api-reference/type-aliases/ModelSources",label:"ModelSources"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SegmentationConfig",label:"SegmentationConfig"},{type:"doc",id:"06-api-reference/type-aliases/SegmentationLabels",label:"SegmentationLabels"},{type:"doc",id:"06-api-reference/type-aliases/SegmentationModelName",label:"SegmentationModelName"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"},{type:"doc",id:"06-api-reference/type-aliases/Triple",label:"Triple"},{type:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"}]},{type:"category",label:"Typescript API",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/SpeechToTextModule",label:"SpeechToTextModule"},{type:"doc",id:"06-api-reference/classes/StyleTransferModule",label:"StyleTransferModule"},{type:"doc",id:"06-api-reference/classes/TextEmbeddingsModule",label:"TextEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/TextToImageModule",label:"TextToImageModule"},{type:"doc",id:"06-api-reference/classes/TextToSpeechModule",label:"TextToSpeechModule"},{type:"doc",id:"06-api-reference/classes/TokenizerModule",label:"TokenizerModule"},{type:"doc",id:"06-api-reference/classes/VADModule",label:"VADModule"},{type:"doc",id:"06-api-reference/classes/VerticalOCRModule",label:"VerticalOCRModule"}]},{type:"category",label:"Utilities - General",items:[{type:"category",label:"ResourceFetcherUtils",items:[{type:"category",label:"Functions",items:[{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/calculateDownloadProgress",label:"calculateDownloadProgress"},{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/getFilenameFromUri",label:"getFilenameFromUri"},{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/hashObject",label:"hashObject"},{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/removeFilePrefix",label:"removeFilePrefix"},{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/triggerHuggingFaceDownloadCounter",label:"triggerHuggingFaceDownloadCounter"}]}],link:{type:"doc",id:"06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/index"}},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchConfig",label:"ExecutorchConfig"},{type:"doc",id:"06-api-reference/interfaces/ResourceFetcherAdapter",label:"ResourceFetcherAdapter"},{type:"doc",id:"06-api-reference/functions/cleanupExecutorch",label:"cleanupExecutorch"},{type:"doc",id:"06-api-reference/functions/initExecutorch",label:"initExecutorch"}]},{type:"category",label:"Utilities - LLM",items:[{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_BUFFER_TOKENS",label:"DEFAULT_CONTEXT_BUFFER_TOKENS"},{type:"doc",id:"06-api-reference/variables/DEFAULT_MESSAGE_HISTORY",label:"DEFAULT_MESSAGE_HISTORY"},{type:"doc",id:"06-api-reference/variables/DEFAULT_SYSTEM_PROMPT",label:"DEFAULT_SYSTEM_PROMPT"},{type:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{type:"doc",id:"06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT",label:"DEFAULT_STRUCTURED_OUTPUT_PROMPT"},{type:"doc",id:"06-api-reference/functions/fixAndValidateStructuredOutput",label:"fixAndValidateStructuredOutput"},{type:"doc",id:"06-api-reference/functions/getStructuredOutputPrompt",label:"getStructuredOutputPrompt"}]},{type:"category",label:"Utils",items:[{type:"doc",id:"06-api-reference/classes/MessageCountContextStrategy",label:"MessageCountContextStrategy"},{type:"doc",id:"06-api-reference/classes/NoopContextStrategy",label:"NoopContextStrategy"},{type:"doc",id:"06-api-reference/classes/SlidingWindowContextStrategy",label:"SlidingWindowContextStrategy"}]}]}; module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md index 8603adc9aa..33c24437af 100644 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -2,7 +2,7 @@ > `const` **ALL_MINILM_L6_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:552](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L552) +Defined in: [constants/modelUrls.ts:562](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L562) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md index 0b3c20da4e..ace1b7a1b2 100644 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -2,7 +2,7 @@ > `const` **ALL_MPNET_BASE_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:560](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L560) +Defined in: [constants/modelUrls.ts:570](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L570) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md index feb3dbbd11..0ecc0b302d 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -2,7 +2,7 @@ > `const` **BK_SDM_TINY_VPRED_256**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:605](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L605) +Defined in: [constants/modelUrls.ts:615](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L615) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index bb49506ef5..a196aa9f78 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -2,7 +2,7 @@ > `const` **BK_SDM_TINY_VPRED_512**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:594](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L594) +Defined in: [constants/modelUrls.ts:604](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L604) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index 400a57cf27..cc74861d0e 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -2,7 +2,7 @@ > `const` **CLIP_VIT_BASE_PATCH32_IMAGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:533](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L533) +Defined in: [constants/modelUrls.ts:543](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L543) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md index d21036252a..ac7ca6955c 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -2,7 +2,7 @@ > `const` **CLIP_VIT_BASE_PATCH32_TEXT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:584](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L584) +Defined in: [constants/modelUrls.ts:594](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L594) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md index d9ee8bfa19..48e5e61bfe 100644 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md +++ b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md @@ -2,10 +2,14 @@ > `const` **DEEPLAB_V3_RESNET50**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:523](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L523) +Defined in: [constants/modelUrls.ts:523](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L523) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"deeplab-v3"` = `'deeplab-v3'` + ### modelSource -> **modelSource**: `string` = `DEEPLAB_V3_RESNET50_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-deeplab-v3/resolve/v0.7.0/xnnpack/deeplabV3_xnnpack_fp32.pte"` = `DEEPLAB_V3_RESNET50_MODEL` diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md index 48abb3dfb7..1666a1c8bc 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -2,6 +2,6 @@ > `const` **DEFAULT_CHAT_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/llmDefaults.ts#L49) +Defined in: [constants/llmDefaults.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/llmDefaults.ts#L49) Default chat configuration for Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_BUFFER_TOKENS.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_BUFFER_TOKENS.md index e6d9cfafb5..c38006996a 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_BUFFER_TOKENS.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_BUFFER_TOKENS.md @@ -2,6 +2,6 @@ > `const` **DEFAULT_CONTEXT_BUFFER_TOKENS**: `512` = `512` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/llmDefaults.ts#L42) +Defined in: [constants/llmDefaults.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/llmDefaults.ts#L42) Default context buffer tokens (number of tokens to keep for the model response) for Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md index 5c3eb13a39..bec42f0005 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -2,6 +2,6 @@ > `const` **DEFAULT_MESSAGE_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:35](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/llmDefaults.ts#L35) +Defined in: [constants/llmDefaults.ts:35](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/llmDefaults.ts#L35) Default message history for Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md index b6eb65a78c..10f772ba6b 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -2,6 +2,6 @@ > `const` **DEFAULT_SYSTEM_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/llmDefaults.ts#L9) +Defined in: [constants/llmDefaults.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/llmDefaults.ts#L9) Default system prompt used to guide the behavior of Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md index f6d6cec03e..d5ff192b2b 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -2,7 +2,7 @@ > `const` **EFFICIENTNET_V2_S**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:359](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L359) +Defined in: [constants/modelUrls.ts:359](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L359) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/FSMN_VAD.md b/docs/docs/06-api-reference/variables/FSMN_VAD.md index 525c4626ea..a244dad87a 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -2,7 +2,7 @@ > `const` **FSMN_VAD**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:619](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L619) +Defined in: [constants/modelUrls.ts:629](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L629) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md index 17fdd45e63..c87e3a7ab4 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_0_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:147](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L147) +Defined in: [constants/modelUrls.ts:147](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L147) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md index 435e581485..f96fd1ddc2 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_0_5B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:156](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L156) +Defined in: [constants/modelUrls.ts:156](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L156) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md index 01913d091b..7f48f15e92 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_1_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:165](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L165) +Defined in: [constants/modelUrls.ts:165](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L165) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md index 71a109a4b2..c478c15b1c 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_1_5B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:174](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L174) +Defined in: [constants/modelUrls.ts:174](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L174) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md index e64edc9abb..a5adf62760 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:183](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L183) +Defined in: [constants/modelUrls.ts:183](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L183) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md index f507b00ffb..8e5815fffd 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_3B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:192](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L192) +Defined in: [constants/modelUrls.ts:192](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L192) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md index 4e8a8d7b31..cb5913cbe4 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md @@ -2,7 +2,7 @@ > `const` **KOKORO_MEDIUM**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/tts/models.ts#L26) +Defined in: [constants/tts/models.ts:26](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/models.ts#L26) A standard Kokoro instance which processes the text in batches of maximum 128 tokens. diff --git a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md index 2d00614910..098f4f631d 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md @@ -2,7 +2,7 @@ > `const` **KOKORO_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/tts/models.ts#L15) +Defined in: [constants/tts/models.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/models.ts#L15) A Kokoro model instance which processes the text in batches of maximum 64 tokens. Uses significant less memory than the medium model, but could produce diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md index b0ef145d9f..634fedb9f2 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AF_HEART**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/tts/voices.ts#L24) +Defined in: [constants/tts/voices.ts:24](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/voices.ts#L24) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md index b85d214765..718229b655 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AF_RIVER**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/tts/voices.ts#L32) +Defined in: [constants/tts/voices.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/voices.ts#L32) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md index 910bac9c76..0a9a242730 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AF_SARAH**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/tts/voices.ts#L40) +Defined in: [constants/tts/voices.ts:40](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/voices.ts#L40) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md index 8ed92d5ee3..336bce9ad1 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AM_ADAM**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/tts/voices.ts#L48) +Defined in: [constants/tts/voices.ts:48](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/voices.ts#L48) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md index c89d395ae5..337ddbf601 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AM_MICHAEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/tts/voices.ts#L56) +Defined in: [constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/voices.ts#L56) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md index 05eb52d980..a9884a680b 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AM_SANTA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/tts/voices.ts#L64) +Defined in: [constants/tts/voices.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/voices.ts#L64) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md index 86ac4ed36d..9b28f60b94 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_BF_EMMA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/tts/voices.ts#L72) +Defined in: [constants/tts/voices.ts:72](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/voices.ts#L72) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md index 9b90b45412..90eaa42dde 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_BM_DANIEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/tts/voices.ts#L80) +Defined in: [constants/tts/voices.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/voices.ts#L80) diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md index 3c464b44ff..ba19386eed 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_1B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L46) +Defined in: [constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L46) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md index 30afe9b87a..509a28ab09 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_1B_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:55](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L55) +Defined in: [constants/modelUrls.ts:55](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L55) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md index 8f57deb963..26bd6ae6d9 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_1B_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L64) +Defined in: [constants/modelUrls.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L64) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md index 3eda20a27c..792f3c5c9a 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L19) +Defined in: [constants/modelUrls.ts:19](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L19) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md index 9e3611c45f..eb0adfbba2 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_3B_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L28) +Defined in: [constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L28) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md index d4ab80e442..fb9d2c05ca 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_3B_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L37) +Defined in: [constants/modelUrls.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L37) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md index 3de0fc4451..6f20e23a40 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI_QA_MINILM_L6_COS_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:568](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L568) +Defined in: [constants/modelUrls.ts:578](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L578) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md index 43df0ecc27..c9682c7f67 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI_QA_MPNET_BASE_DOT_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:576](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L576) +Defined in: [constants/modelUrls.ts:586](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L586) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md index 4094b06fbf..fef48f0213 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **OCR_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L33) +Defined in: [constants/ocr/models.ts:33](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L33) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md index 4a2bb739f2..7648f0e5ff 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **OCR_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:38](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L38) +Defined in: [constants/ocr/models.ts:38](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L38) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md index b414a15813..a7fe470b89 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **OCR_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:43](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L43) +Defined in: [constants/ocr/models.ts:43](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L43) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md index 3bb632b37f..8812c4d9cd 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L302) +Defined in: [constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md index 5540f7e726..3f0636de5e 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **OCR_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L48) +Defined in: [constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L48) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md index 5130dc0007..a0661a6ff8 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **OCR_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L53) +Defined in: [constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L53) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md index 50af454ac1..f6c87ab1c5 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L58) +Defined in: [constants/ocr/models.ts:58](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L58) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md index 6304d86e99..1ebdd507ca 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L68) +Defined in: [constants/ocr/models.ts:68](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L68) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md index 2c4e753f3d..56e2d0ceca 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:63](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L63) +Defined in: [constants/ocr/models.ts:63](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L63) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md index d0f4396859..93d71ef8a5 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **OCR_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:81](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L81) +Defined in: [constants/ocr/models.ts:81](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L81) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md index 7d581e0239..44ab528a4c 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:136](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L136) +Defined in: [constants/ocr/models.ts:136](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L136) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md index 7b42ac8d42..fc3b62d4d0 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **OCR_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:86](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L86) +Defined in: [constants/ocr/models.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L86) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md index e9657b7c1d..a154758814 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **OCR_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:96](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L96) +Defined in: [constants/ocr/models.ts:96](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L96) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md index 62e227d98b..c8836b4ae3 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **OCR_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L101) +Defined in: [constants/ocr/models.ts:101](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L101) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md index b7925fd982..2f33d3ba79 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **OCR_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L236) +Defined in: [constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L236) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md index 1e7b9f7655..594ffe9518 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **OCR_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L111) +Defined in: [constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L111) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md index ae2759fd3c..916aca8375 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:121](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L121) +Defined in: [constants/ocr/models.ts:121](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L121) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md index b306f8c8e2..9698e383c2 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **OCR_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:126](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L126) +Defined in: [constants/ocr/models.ts:126](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L126) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md index d1071bc497..a664bd2639 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **OCR_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:106](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L106) +Defined in: [constants/ocr/models.ts:106](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L106) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md index 4fb0b7b942..536756310a 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L141) +Defined in: [constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L141) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md index 7aa7222046..5a219bda50 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **OCR_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:156](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L156) +Defined in: [constants/ocr/models.ts:156](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L156) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md index 90515967f6..e9adad3d58 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L146) +Defined in: [constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L146) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md index 58eed3b2e8..0a86e9f8d0 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **OCR_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:151](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L151) +Defined in: [constants/ocr/models.ts:151](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L151) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md index d9338d19f0..2a323f4046 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **OCR_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:131](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L131) +Defined in: [constants/ocr/models.ts:131](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L131) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md index e966db696e..fa26171452 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:161](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L161) +Defined in: [constants/ocr/models.ts:161](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L161) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md index 17dffc65f4..97dcab0188 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **OCR_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:166](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L166) +Defined in: [constants/ocr/models.ts:166](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L166) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md index 064a1831d4..fc3b792d17 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **OCR_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L176) +Defined in: [constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L176) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md index 93693fbf87..6418b51715 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L171) +Defined in: [constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L171) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md index 82715beb39..50b82b93ad 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **OCR_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:181](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L181) +Defined in: [constants/ocr/models.ts:181](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L181) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md index a95d39c9c9..8ecc9099bd 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **OCR_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:186](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L186) +Defined in: [constants/ocr/models.ts:186](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L186) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md index 76f077c380..b285759cd4 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **OCR_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:196](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L196) +Defined in: [constants/ocr/models.ts:196](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L196) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md index 523729be06..e2d54f19d3 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:191](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L191) +Defined in: [constants/ocr/models.ts:191](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L191) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md index cf58a8959e..ebd4832522 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:211](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L211) +Defined in: [constants/ocr/models.ts:211](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L211) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md index d9e6fff6a2..23c7f25611 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L201) +Defined in: [constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L201) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md index aa41430fb9..52e87ca781 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L206) +Defined in: [constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md index 5e598e900b..f7b507731b 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **OCR_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:226](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L226) +Defined in: [constants/ocr/models.ts:226](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L226) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md index e768f4bbf4..7fbb990ca4 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **OCR_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L231) +Defined in: [constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L231) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md index 03b779d1d0..448736ae12 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **OCR_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:216](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L216) +Defined in: [constants/ocr/models.ts:216](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L216) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md index 5d9eb4f4fb..ab60aef783 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:221](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L221) +Defined in: [constants/ocr/models.ts:221](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L221) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md index 246569fa89..251dde90af 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:241](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L241) +Defined in: [constants/ocr/models.ts:241](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L241) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md index a952ccf902..8140561b08 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **OCR_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:246](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L246) +Defined in: [constants/ocr/models.ts:246](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L246) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md index f39ec8a4a2..906364c00b 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **OCR_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:251](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L251) +Defined in: [constants/ocr/models.ts:251](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L251) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md index 9736fb5043..ccd12ff6b9 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **OCR_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:256](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L256) +Defined in: [constants/ocr/models.ts:256](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L256) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md index a6b3fe6dbc..cd8987230b 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **OCR_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L261) +Defined in: [constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L261) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md index c38acf3063..58052f9452 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L266) +Defined in: [constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L266) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md index d56498da18..3e76f334b8 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:271](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L271) +Defined in: [constants/ocr/models.ts:271](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L271) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md index b459120fee..4ff34c72f4 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **OCR_SERBIAN_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:276](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L276) +Defined in: [constants/ocr/models.ts:276](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L276) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md index c03204dd7c..4c9d21a7cb 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR_SERBIAN_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L284) +Defined in: [constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md index 96a6b97791..631e7f80b4 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **OCR_SIMPLIFIED_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:73](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L73) +Defined in: [constants/ocr/models.ts:73](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L73) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md index 556acbf413..c27a61484a 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **OCR_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:292](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L292) +Defined in: [constants/ocr/models.ts:292](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L292) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md index 946424bd77..2d76050f43 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L297) +Defined in: [constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md index 2d13a13eec..d9c3ecd041 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **OCR_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L116) +Defined in: [constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L116) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md index 9352cace48..45aa67e60c 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **OCR_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:312](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L312) +Defined in: [constants/ocr/models.ts:312](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L312) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md index 7a206b65ea..564ffa0ed0 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **OCR_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:307](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L307) +Defined in: [constants/ocr/models.ts:307](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L307) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md index 1faf8b757a..15b94d72d0 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **OCR_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:317](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L317) +Defined in: [constants/ocr/models.ts:317](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L317) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md index 9c8ce1fd56..91496254d2 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **OCR_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L332) +Defined in: [constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L332) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md index 00ae3dca74..a448882adc 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **OCR_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L327) +Defined in: [constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L327) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md index b116a2369e..0d767de822 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **OCR_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:322](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L322) +Defined in: [constants/ocr/models.ts:322](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L322) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md index 3b7cff0be3..f48ea3cd87 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **OCR_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:337](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L337) +Defined in: [constants/ocr/models.ts:337](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L337) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md index 4b219d82d2..55ec639251 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:342](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L342) +Defined in: [constants/ocr/models.ts:342](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L342) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md index 5f1ff36633..77b0185ca9 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **OCR_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:347](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L347) +Defined in: [constants/ocr/models.ts:347](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L347) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md index 5382e4d8b8..c47d7e8df8 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **OCR_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:352](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L352) +Defined in: [constants/ocr/models.ts:352](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L352) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md index 6651ed10f3..3086be6cec 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **OCR_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:91](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/ocr/models.ts#L91) +Defined in: [constants/ocr/models.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L91) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md index dc2a739a5f..ad438ab3df 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -2,7 +2,7 @@ > `const` **PHI_4_MINI_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:335](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L335) +Defined in: [constants/modelUrls.ts:335](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L335) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md index 82efaa2a1c..f85068fd3b 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **PHI_4_MINI_4B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:344](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L344) +Defined in: [constants/modelUrls.ts:344](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L344) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md index eb63a50a3b..156f5dac0b 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_0_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:275](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L275) +Defined in: [constants/modelUrls.ts:275](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L275) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md index 79d67bb182..aebad7bc80 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_0_5B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:284](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L284) +Defined in: [constants/modelUrls.ts:284](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md index dfb0debb9a..8b76b6a518 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_1_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L293) +Defined in: [constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L293) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md index a7f43c68ae..c8be4d14c9 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_1_5B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:302](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L302) +Defined in: [constants/modelUrls.ts:302](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md index e28af46c58..82d6c3a783 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:311](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L311) +Defined in: [constants/modelUrls.ts:311](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L311) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md index c365e57d30..8469195713 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_3B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:320](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L320) +Defined in: [constants/modelUrls.ts:320](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L320) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md index 9c9fa4242e..80b34b4661 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -2,7 +2,7 @@ > `const` **QWEN3_0_6B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:83](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L83) +Defined in: [constants/modelUrls.ts:83](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L83) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md index 84f0a74c41..e5a946d5a3 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3_0_6B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L92) +Defined in: [constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L92) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md index 282fa0b55b..fb941f7c64 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -2,7 +2,7 @@ > `const` **QWEN3_1_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L101) +Defined in: [constants/modelUrls.ts:101](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L101) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md index 360a95098e..fc7dd7ae72 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3_1_7B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:110](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L110) +Defined in: [constants/modelUrls.ts:110](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L110) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index f92550077d..f11eab3439 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -2,7 +2,7 @@ > `const` **QWEN3_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:119](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L119) +Defined in: [constants/modelUrls.ts:119](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L119) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md index 1474158bce..4345b2eb84 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3_4B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L128) +Defined in: [constants/modelUrls.ts:128](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L128) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md b/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md index 36135377c7..9e6aa5a352 100644 --- a/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md +++ b/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md @@ -2,7 +2,7 @@ > `const` **SELFIE_SEGMENTATION**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:533](https://github.com/software-mansion/react-native-executorch/blob/ec04754e2ea2ad38fe30c36a9250db47f020a06e/packages/react-native-executorch/src/constants/modelUrls.ts#L533) +Defined in: [constants/modelUrls.ts:532](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L532) ## Type Declaration @@ -12,4 +12,4 @@ Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:533](ht ### modelSource -> `readonly` **modelSource**: `"https://ai.swmansion.com/storage/jc_tests/selfie.pte"` = `SELFIE_SEGMENTATION_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-selfie-segmentation/resolve/v0.7.0/xnnpack/selfie-segmentation.pte"` = `SELFIE_SEGMENTATION_MODEL` diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md index b9016ebff0..d827c05835 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_135M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:211](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L211) +Defined in: [constants/modelUrls.ts:211](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L211) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md index 9e5aad666f..db395e6e43 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_135M_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:220](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L220) +Defined in: [constants/modelUrls.ts:220](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L220) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md index 440c27f3e5..b44e61632c 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_1_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:247](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L247) +Defined in: [constants/modelUrls.ts:247](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L247) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md index d027177dc9..af5bfd9a5a 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_1_7B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:256](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L256) +Defined in: [constants/modelUrls.ts:256](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L256) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md index 2623ac6412..0f8ecc7d32 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_360M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:229](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L229) +Defined in: [constants/modelUrls.ts:229](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L229) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md index d62f16a2c7..ead0bc9967 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_360M_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:238](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L238) +Defined in: [constants/modelUrls.ts:238](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L238) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md index 09619aff20..0b2a1accee 100644 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -2,7 +2,7 @@ > `const` **SPECIAL_TOKENS**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:281](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/types/llm.ts#L281) +Defined in: [types/llm.ts:281](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/llm.ts#L281) Special tokens used in Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md index b256546e3b..f13b4939f7 100644 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `const` **SSDLITE_320_MOBILENET_V3_LARGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:369](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L369) +Defined in: [constants/modelUrls.ts:369](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L369) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md index 68e1341452..20c51561d6 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -2,7 +2,7 @@ > `const` **STYLE_TRANSFER_CANDY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:394](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L394) +Defined in: [constants/modelUrls.ts:394](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L394) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md index 84cd573ca3..56a25898fe 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -2,7 +2,7 @@ > `const` **STYLE_TRANSFER_MOSAIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:401](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L401) +Defined in: [constants/modelUrls.ts:401](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L401) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md index 41318a4ace..172ed45249 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -2,7 +2,7 @@ > `const` **STYLE_TRANSFER_RAIN_PRINCESS**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L408) +Defined in: [constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L408) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md index 11061b0e29..62816172e7 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -2,7 +2,7 @@ > `const` **STYLE_TRANSFER_UDNIE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:415](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L415) +Defined in: [constants/modelUrls.ts:415](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L415) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md index f359c2199e..4eabe8c5b7 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -2,7 +2,7 @@ > `const` **WHISPER_BASE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:500](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L500) +Defined in: [constants/modelUrls.ts:500](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L500) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md index f202b92a03..f1d1ab0071 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER_BASE_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:470](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L470) +Defined in: [constants/modelUrls.ts:470](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L470) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md index 71448f5ee1..b00ed9e3e9 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -2,7 +2,7 @@ > `const` **WHISPER_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:510](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L510) +Defined in: [constants/modelUrls.ts:510](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L510) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md index fa216711a3..ff8f879e0e 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER_SMALL_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:480](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L480) +Defined in: [constants/modelUrls.ts:480](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L480) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md index 2ecd33fe12..fb42415d23 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -2,7 +2,7 @@ > `const` **WHISPER_TINY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:490](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L490) +Defined in: [constants/modelUrls.ts:490](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L490) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md index 87bc3bdc70..afb251d496 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER_TINY_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:450](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L450) +Defined in: [constants/modelUrls.ts:450](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L450) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md index 398ce5f56c..b75725a0bc 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **WHISPER_TINY_EN_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:460](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/constants/modelUrls.ts#L460) +Defined in: [constants/modelUrls.ts:460](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L460) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md index 4818438d3e..2492e294b0 100644 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -2,7 +2,7 @@ > `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] -Defined in: [packages/react-native-executorch/src/utils/llm.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a6b2b6f4f1622166e3517338d42680655383a3be/packages/react-native-executorch/src/utils/llm.ts#L16) +Defined in: [utils/llm.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llm.ts#L16) Parses tool calls from a given message string. diff --git a/docs/package.json b/docs/package.json index 4c612ed0c9..33572c67ae 100644 --- a/docs/package.json +++ b/docs/package.json @@ -5,8 +5,10 @@ "scripts": { "docusaurus": "docusaurus", "start": "docusaurus start", - "build": "docusaurus build && npm run postbuild", + "build": "docusaurus build && yarn prettier-api-reference && npm run postbuild", + "docs:version": "./scripts/build-version-docs.sh", "postbuild": "node scripts/postbuild.mjs", + "prettier-api-reference": "npx prettier --write 'docs/06-api-reference/**/*.{md,mdx}'", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "clear": "docusaurus clear", diff --git a/docs/scripts/build-version-docs.sh b/docs/scripts/build-version-docs.sh new file mode 100755 index 0000000000..4dea0f5d84 --- /dev/null +++ b/docs/scripts/build-version-docs.sh @@ -0,0 +1,17 @@ +#!/bin/bash +VERSION=$1 +SHA=$(git rev-parse HEAD) + +if [ -z "$VERSION" ]; then + echo "Usage: yarn docs:version " + exit 1 +fi + +yarn docusaurus docs:version $VERSION + +find versioned_docs/version-$VERSION -type f \( -name "*.md" -o -name "*.mdx" \) \ + -exec sed -i "" "s|/blob/main/|/blob/$SHA/|g" {} + + +yarn prettier-api-reference + +echo "Versioned $VERSION docs pinned to $SHA" \ No newline at end of file diff --git a/docs/typedoc.json b/docs/typedoc.json new file mode 100644 index 0000000000..f68607dbf1 --- /dev/null +++ b/docs/typedoc.json @@ -0,0 +1,8 @@ +{ + "gitRevision": "main", + "skipErrorChecking": true, + "compilerOptions": { + "skipLibCheck": true + }, + "excludeExternals": true +} diff --git a/packages/react-native-executorch/src/constants/modelUrls.ts b/packages/react-native-executorch/src/constants/modelUrls.ts index 20cacd0500..0c1c943fca 100644 --- a/packages/react-native-executorch/src/constants/modelUrls.ts +++ b/packages/react-native-executorch/src/constants/modelUrls.ts @@ -527,7 +527,7 @@ export const DEEPLAB_V3_RESNET50 = { const SELFIE_SEGMENTATION_MODEL = `${URL_PREFIX}-selfie-segmentation/${VERSION_TAG}/xnnpack/selfie-segmentation.pte`; /** - * @category Models - Image segmentation + * @category Models - Image Segmentation */ export const SELFIE_SEGMENTATION = { modelName: 'selfie-segmentation',