diff --git a/.github/workflows/api-reference-up-to-date-check.yml b/.github/workflows/api-reference-up-to-date-check.yml deleted file mode 100644 index 44972607e4..0000000000 --- a/.github/workflows/api-reference-up-to-date-check.yml +++ /dev/null @@ -1,52 +0,0 @@ -name: Check if API reference is up-to-date - -on: - push: - branches: - - main - paths: - - 'docs/**' - - 'packages/react-native-executorch/src/**' - - '.github/workflows/api-reference-up-to-date-check.yml' - pull_request: - branches: - - main - paths: - - 'docs/**' - - 'packages/react-native-executorch/src/**' - - '.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/.gitignore b/.gitignore index 780eaf46fe..6082e34cdd 100644 --- a/.gitignore +++ b/.gitignore @@ -90,6 +90,12 @@ android/generated apps/*/ios/ apps/*/android/ +# generated TypeDoc API reference (regenerated at build time) +docs/docs/06-api-reference/ + +# integration test model assets +packages/react-native-executorch/common/rnexecutorch/tests/integration/assets/models/ + # custom *.tgz Makefile diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md deleted file mode 100644 index f3cb19464e..0000000000 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ /dev/null @@ -1,255 +0,0 @@ -# Class: ClassificationModule - -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. - -## Extends - -- `BaseModule` - -## Constructors - -### Constructor - -> **new ClassificationModule**(): `ClassificationModule` - -#### Returns - -`ClassificationModule` - -#### Inherited from - -`BaseModule.constructor` - -## Properties - -### generateFromFrame() - -> **generateFromFrame**: (`frameData`, ...`args`) => `any` - -Defined in: [modules/BaseModule.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L56) - -Process a camera frame directly for real-time inference. - -This method is bound to a native JSI function after calling `load()`, -making it worklet-compatible and safe to call from VisionCamera's -frame processor thread. - -**Performance characteristics:** - -- **Zero-copy path**: When using `frame.getNativeBuffer()` from VisionCamera v5, - frame data is accessed directly without copying (fastest, recommended). -- **Copy path**: When using `frame.toArrayBuffer()`, pixel data is copied - from native to JS, then accessed from native code (slower, fallback). - -**Usage with VisionCamera:** - -```typescript -const frameOutput = useFrameOutput({ - pixelFormat: 'rgb', - onFrame(frame) { - 'worklet'; - // Zero-copy approach (recommended) - const nativeBuffer = frame.getNativeBuffer(); - const result = model.generateFromFrame( - { - nativeBuffer: nativeBuffer.pointer, - width: frame.width, - height: frame.height, - }, - ...args - ); - nativeBuffer.release(); - frame.dispose(); - }, -}); -``` - -#### Parameters - -##### frameData - -[`Frame`](../interfaces/Frame.md) - -Frame data object with either nativeBuffer (zero-copy) or data (ArrayBuffer) - -##### args - -...`any`[] - -Additional model-specific arguments (e.g., threshold, options) - -#### Returns - -`any` - -Model-specific output (e.g., detections, classifications, embeddings) - -#### See - -[Frame](../interfaces/Frame.md) for frame data format details - -#### Inherited from - -`BaseModule.generateFromFrame` - ---- - -### nativeModule - -> **nativeModule**: `any` = `null` - -Defined in: [modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L17) - -**`Internal`** - -Native module instance (JSI Host Object) - -#### Inherited from - -`BaseModule.nativeModule` - -## Methods - -### delete() - -> **delete**(): `void` - -Defined in: [modules/BaseModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L100) - -Unloads the model from memory and releases native resources. - -Always call this method when you're done with a model to prevent memory leaks. - -#### Returns - -`void` - -#### Inherited from - -`BaseModule.delete` - ---- - -### forward() - -> **forward**(`imageSource`): `Promise`\<\{\[`category`: `string`\]: `number`; \}\> - -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. - -#### Parameters - -##### imageSource - -`string` - -The image source to be classified. - -#### Returns - -`Promise`\<\{\[`category`: `string`\]: `number`; \}\> - -The classification result. - ---- - -### forwardET() - -> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Defined in: [modules/BaseModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L80) - -**`Internal`** - -Runs the model's forward method with the given input tensors. -It returns the output tensors that mimic the structure of output from ExecuTorch. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](../interfaces/TensorPtr.md)[] - -Array of input tensors. - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Array of output tensors. - -#### Inherited from - -`BaseModule.forwardET` - ---- - -### getInputShape() - -> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> - -Defined in: [modules/BaseModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L91) - -Gets the input shape for a given method and index. - -#### Parameters - -##### methodName - -`string` - -method name - -##### index - -`number` - -index of the argument which shape is requested - -#### Returns - -`Promise`\<`number`[]\> - -The input shape as an array of numbers. - -#### Inherited from - -`BaseModule.getInputShape` - ---- - -### load() - -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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`. - -#### Parameters - -##### model - -Object containing `modelSource`. - -###### modelSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md deleted file mode 100644 index 8592a13ff7..0000000000 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ /dev/null @@ -1,254 +0,0 @@ -# Class: ExecutorchModule - -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. - -## Extends - -- `BaseModule` - -## Constructors - -### Constructor - -> **new ExecutorchModule**(): `ExecutorchModule` - -#### Returns - -`ExecutorchModule` - -#### Inherited from - -`BaseModule.constructor` - -## Properties - -### generateFromFrame() - -> **generateFromFrame**: (`frameData`, ...`args`) => `any` - -Defined in: [modules/BaseModule.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L56) - -Process a camera frame directly for real-time inference. - -This method is bound to a native JSI function after calling `load()`, -making it worklet-compatible and safe to call from VisionCamera's -frame processor thread. - -**Performance characteristics:** - -- **Zero-copy path**: When using `frame.getNativeBuffer()` from VisionCamera v5, - frame data is accessed directly without copying (fastest, recommended). -- **Copy path**: When using `frame.toArrayBuffer()`, pixel data is copied - from native to JS, then accessed from native code (slower, fallback). - -**Usage with VisionCamera:** - -```typescript -const frameOutput = useFrameOutput({ - pixelFormat: 'rgb', - onFrame(frame) { - 'worklet'; - // Zero-copy approach (recommended) - const nativeBuffer = frame.getNativeBuffer(); - const result = model.generateFromFrame( - { - nativeBuffer: nativeBuffer.pointer, - width: frame.width, - height: frame.height, - }, - ...args - ); - nativeBuffer.release(); - frame.dispose(); - }, -}); -``` - -#### Parameters - -##### frameData - -[`Frame`](../interfaces/Frame.md) - -Frame data object with either nativeBuffer (zero-copy) or data (ArrayBuffer) - -##### args - -...`any`[] - -Additional model-specific arguments (e.g., threshold, options) - -#### Returns - -`any` - -Model-specific output (e.g., detections, classifications, embeddings) - -#### See - -[Frame](../interfaces/Frame.md) for frame data format details - -#### Inherited from - -`BaseModule.generateFromFrame` - ---- - -### nativeModule - -> **nativeModule**: `any` = `null` - -Defined in: [modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L17) - -**`Internal`** - -Native module instance (JSI Host Object) - -#### Inherited from - -`BaseModule.nativeModule` - -## Methods - -### delete() - -> **delete**(): `void` - -Defined in: [modules/BaseModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L100) - -Unloads the model from memory and releases native resources. - -Always call this method when you're done with a model to prevent memory leaks. - -#### Returns - -`void` - -#### Inherited from - -`BaseModule.delete` - ---- - -### forward() - -> **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -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. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](../interfaces/TensorPtr.md)[] - -Array of input tensor pointers. - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -An array of output tensor pointers. - ---- - -### forwardET() - -> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Defined in: [modules/BaseModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L80) - -**`Internal`** - -Runs the model's forward method with the given input tensors. -It returns the output tensors that mimic the structure of output from ExecuTorch. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](../interfaces/TensorPtr.md)[] - -Array of input tensors. - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Array of output tensors. - -#### Inherited from - -`BaseModule.forwardET` - ---- - -### getInputShape() - -> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> - -Defined in: [modules/BaseModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L91) - -Gets the input shape for a given method and index. - -#### Parameters - -##### methodName - -`string` - -method name - -##### index - -`number` - -index of the argument which shape is requested - -#### Returns - -`Promise`\<`number`[]\> - -The input shape as an array of numbers. - -#### Inherited from - -`BaseModule.getInputShape` - ---- - -### load() - -> **load**(`modelSource`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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. - -#### Parameters - -##### modelSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -Source of the model to be loaded. - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md deleted file mode 100644 index 9ae05fc403..0000000000 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ /dev/null @@ -1,254 +0,0 @@ -# Class: ImageEmbeddingsModule - -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. - -## Extends - -- `BaseModule` - -## Constructors - -### Constructor - -> **new ImageEmbeddingsModule**(): `ImageEmbeddingsModule` - -#### Returns - -`ImageEmbeddingsModule` - -#### Inherited from - -`BaseModule.constructor` - -## Properties - -### generateFromFrame() - -> **generateFromFrame**: (`frameData`, ...`args`) => `any` - -Defined in: [modules/BaseModule.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L56) - -Process a camera frame directly for real-time inference. - -This method is bound to a native JSI function after calling `load()`, -making it worklet-compatible and safe to call from VisionCamera's -frame processor thread. - -**Performance characteristics:** - -- **Zero-copy path**: When using `frame.getNativeBuffer()` from VisionCamera v5, - frame data is accessed directly without copying (fastest, recommended). -- **Copy path**: When using `frame.toArrayBuffer()`, pixel data is copied - from native to JS, then accessed from native code (slower, fallback). - -**Usage with VisionCamera:** - -```typescript -const frameOutput = useFrameOutput({ - pixelFormat: 'rgb', - onFrame(frame) { - 'worklet'; - // Zero-copy approach (recommended) - const nativeBuffer = frame.getNativeBuffer(); - const result = model.generateFromFrame( - { - nativeBuffer: nativeBuffer.pointer, - width: frame.width, - height: frame.height, - }, - ...args - ); - nativeBuffer.release(); - frame.dispose(); - }, -}); -``` - -#### Parameters - -##### frameData - -[`Frame`](../interfaces/Frame.md) - -Frame data object with either nativeBuffer (zero-copy) or data (ArrayBuffer) - -##### args - -...`any`[] - -Additional model-specific arguments (e.g., threshold, options) - -#### Returns - -`any` - -Model-specific output (e.g., detections, classifications, embeddings) - -#### See - -[Frame](../interfaces/Frame.md) for frame data format details - -#### Inherited from - -`BaseModule.generateFromFrame` - ---- - -### nativeModule - -> **nativeModule**: `any` = `null` - -Defined in: [modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L17) - -**`Internal`** - -Native module instance (JSI Host Object) - -#### Inherited from - -`BaseModule.nativeModule` - -## Methods - -### delete() - -> **delete**(): `void` - -Defined in: [modules/BaseModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L100) - -Unloads the model from memory and releases native resources. - -Always call this method when you're done with a model to prevent memory leaks. - -#### Returns - -`void` - -#### Inherited from - -`BaseModule.delete` - ---- - -### forward() - -> **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -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. - -#### Parameters - -##### imageSource - -`string` - -The image source (URI/URL) to image that will be embedded. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -A Float32Array containing the image embeddings. - ---- - -### forwardET() - -> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Defined in: [modules/BaseModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L80) - -**`Internal`** - -Runs the model's forward method with the given input tensors. -It returns the output tensors that mimic the structure of output from ExecuTorch. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](../interfaces/TensorPtr.md)[] - -Array of input tensors. - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Array of output tensors. - -#### Inherited from - -`BaseModule.forwardET` - ---- - -### getInputShape() - -> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> - -Defined in: [modules/BaseModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L91) - -Gets the input shape for a given method and index. - -#### Parameters - -##### methodName - -`string` - -method name - -##### index - -`number` - -index of the argument which shape is requested - -#### Returns - -`Promise`\<`number`[]\> - -The input shape as an array of numbers. - -#### Inherited from - -`BaseModule.getInputShape` - ---- - -### load() - -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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. - -#### Parameters - -##### model - -Object containing `modelSource`. - -###### modelSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md deleted file mode 100644 index 6f31a3db6e..0000000000 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ /dev/null @@ -1,318 +0,0 @@ -# Class: LLMModule - -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. - -## Constructors - -### Constructor - -> **new LLMModule**(`optionalCallbacks?`): `LLMModule` - -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. - -#### Parameters - -##### optionalCallbacks? - -Object containing optional callbacks. - -###### messageHistoryCallback? - -(`messageHistory`) => `void` - -An optional function called on every finished message (`Message[]`). -Returns the entire message history. - -###### tokenCallback? - -(`token`) => `void` - -An optional function that will be called on every generated token (`string`) with that token as its only argument. - -#### Returns - -`LLMModule` - -A new LLMModule instance. - -## Methods - -### configure() - -> **configure**(`config`): `void` - -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. - -#### Parameters - -##### config - -[`LLMConfig`](../interfaces/LLMConfig.md) - -Configuration object containing `chatConfig`, `toolsConfig`, and `generationConfig`. - -#### Returns - -`void` - ---- - -### delete() - -> **delete**(): `void` - -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. -You need to interrupt it first and make sure model stopped generation. - -#### Returns - -`void` - ---- - -### deleteMessage() - -> **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] - -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. -It also returns it. - -#### Parameters - -##### index - -`number` - -The index of the message to delete from history. - -#### Returns - -[`Message`](../interfaces/Message.md)[] - -- Updated message history after deletion. - ---- - -### forward() - -> **forward**(`input`): `Promise`\<`string`\> - -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. -It doesn't manage conversation context. It is intended for users that need access to the model itself without any wrapper. -If you want a simple chat with model the consider using `sendMessage` - -#### Parameters - -##### input - -`string` - -Raw input string containing the prompt and conversation history. - -#### Returns - -`Promise`\<`string`\> - -The generated response as a string. - ---- - -### generate() - -> **generate**(`messages`, `tools?`): `Promise`\<`string`\> - -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. - -#### Parameters - -##### messages - -[`Message`](../interfaces/Message.md)[] - -Array of messages representing the chat history. - -##### tools? - -`Object`[] - -Optional array of tools that can be used during generation. - -#### Returns - -`Promise`\<`string`\> - -The generated response as a string. - ---- - -### getGeneratedTokenCount() - -> **getGeneratedTokenCount**(): `number` - -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. - -#### Returns - -`number` - -The count of generated tokens. - ---- - -### getPromptTokensCount() - -> **getPromptTokensCount**(): `number` - -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. - -#### Returns - -`number` - -The count of prompt token. - ---- - -### getTotalTokensCount() - -> **getTotalTokensCount**(): `number` - -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. - -#### Returns - -`number` - -The count of prompt and generated tokens. - ---- - -### interrupt() - -> **interrupt**(): `void` - -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. - -#### Returns - -`void` - ---- - -### load() - -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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. - -#### Parameters - -##### model - -Object containing model, tokenizer, and tokenizer config sources. - -###### modelSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` that specifies the location of the model binary. - -###### tokenizerConfigSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` pointing to the JSON file which contains the tokenizer config. - -###### tokenizerSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` pointing to the JSON file which contains the tokenizer. - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to track download progress (value between 0 and 1). - -#### Returns - -`Promise`\<`void`\> - ---- - -### sendMessage() - -> **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> - -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. -It also returns them. - -#### Parameters - -##### message - -`string` - -The message string to send. - -#### Returns - -`Promise`\<[`Message`](../interfaces/Message.md)[]\> - -- Updated message history including the new user message and model response. - ---- - -### setTokenCallback() - -> **setTokenCallback**(`tokenCallback`): `void` - -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. - -#### Parameters - -##### tokenCallback - -Callback function to handle new tokens. - -###### tokenCallback - -(`token`) => `void` - -#### Returns - -`void` diff --git a/docs/docs/06-api-reference/classes/Logger.md b/docs/docs/06-api-reference/classes/Logger.md deleted file mode 100644 index ca2df23f39..0000000000 --- a/docs/docs/06-api-reference/classes/Logger.md +++ /dev/null @@ -1,105 +0,0 @@ -# Class: Logger - -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. - -## Constructors - -### Constructor - -> **new Logger**(): `Logger` - -#### Returns - -`Logger` - -## Methods - -### debug() - -> `static` **debug**(...`data`): `void` - -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 - -##### data - -...`any`[] - -#### Returns - -`void` - ---- - -### error() - -> `static` **error**(...`data`): `void` - -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 - -##### data - -...`any`[] - -#### Returns - -`void` - ---- - -### info() - -> `static` **info**(...`data`): `void` - -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 - -##### data - -...`any`[] - -#### Returns - -`void` - ---- - -### log() - -> `static` **log**(...`data`): `void` - -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 - -##### data - -...`any`[] - -#### Returns - -`void` - ---- - -### warn() - -> `static` **warn**(...`data`): `void` - -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 - -##### data - -...`any`[] - -#### Returns - -`void` diff --git a/docs/docs/06-api-reference/classes/MessageCountContextStrategy.md b/docs/docs/06-api-reference/classes/MessageCountContextStrategy.md deleted file mode 100644 index 2fe677c5f1..0000000000 --- a/docs/docs/06-api-reference/classes/MessageCountContextStrategy.md +++ /dev/null @@ -1,80 +0,0 @@ -# Class: MessageCountContextStrategy - -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. - -## Implements - -- [`ContextStrategy`](../interfaces/ContextStrategy.md) - -## Constructors - -### Constructor - -> **new MessageCountContextStrategy**(`windowLength?`): `MessageCountContextStrategy` - -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. - -- - -#### Parameters - -##### windowLength? - -`number` = `5` - -The maximum number of recent messages to retain in the context. Defaults to 5. - -#### Returns - -`MessageCountContextStrategy` - -## Methods - -### buildContext() - -> **buildContext**(`systemPrompt`, `history`, `_maxContextLength`, `_getTokenCount`): [`Message`](../interfaces/Message.md)[] - -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. - -#### Parameters - -##### systemPrompt - -`string` - -The top-level instructions for the model. - -##### history - -[`Message`](../interfaces/Message.md)[] - -The complete conversation history. - -##### \_maxContextLength - -`number` - -Unused in this strategy. - -##### \_getTokenCount - -(`messages`) => `number` - -Unused in this strategy. - -#### Returns - -[`Message`](../interfaces/Message.md)[] - -The truncated message history with the system prompt at the beginning. - -#### Implementation of - -[`ContextStrategy`](../interfaces/ContextStrategy.md).[`buildContext`](../interfaces/ContextStrategy.md#buildcontext) diff --git a/docs/docs/06-api-reference/classes/NoopContextStrategy.md b/docs/docs/06-api-reference/classes/NoopContextStrategy.md deleted file mode 100644 index 10183ecbc5..0000000000 --- a/docs/docs/06-api-reference/classes/NoopContextStrategy.md +++ /dev/null @@ -1,68 +0,0 @@ -# Class: NoopContextStrategy - -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. - -- This strategy is ideal when the developer wants to manually manage the conversation - context. - -## Implements - -- [`ContextStrategy`](../interfaces/ContextStrategy.md) - -## Constructors - -### Constructor - -> **new NoopContextStrategy**(): `NoopContextStrategy` - -#### Returns - -`NoopContextStrategy` - -## Methods - -### buildContext() - -> **buildContext**(`systemPrompt`, `history`, `_maxContextLength`, `_getTokenCount`): [`Message`](../interfaces/Message.md)[] - -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. - -#### Parameters - -##### systemPrompt - -`string` - -The top-level instructions for the model. - -##### history - -[`Message`](../interfaces/Message.md)[] - -The complete conversation history. - -##### \_maxContextLength - -`number` - -Unused in this strategy. - -##### \_getTokenCount - -(`messages`) => `number` - -Unused in this strategy. - -#### Returns - -[`Message`](../interfaces/Message.md)[] - -The unedited message history with the system prompt at the beginning. - -#### Implementation of - -[`ContextStrategy`](../interfaces/ContextStrategy.md).[`buildContext`](../interfaces/ContextStrategy.md#buildcontext) diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md deleted file mode 100644 index a940f11f13..0000000000 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ /dev/null @@ -1,96 +0,0 @@ -# Class: OCRModule - -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. - -## Constructors - -### Constructor - -> **new OCRModule**(): `OCRModule` - -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 - -`OCRModule` - -## Methods - -### delete() - -> **delete**(): `void` - -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. - -#### Returns - -`void` - ---- - -### forward() - -> **forward**(`imageSource`): `Promise`\<[`OCRDetection`](../interfaces/OCRDetection.md)[]\> - -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. - -#### Parameters - -##### imageSource - -`string` - -The image source to be processed. - -#### Returns - -`Promise`\<[`OCRDetection`](../interfaces/OCRDetection.md)[]\> - -The OCR result as a `OCRDetection[]`. - ---- - -### load() - -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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, -and `language` is a parameter that specifies the language of the text to be recognized by the OCR. - -#### Parameters - -##### model - -Object containing `detectorSource`, `recognizerSource`, and `language`. - -###### detectorSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -###### language - -`"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -###### recognizerSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md deleted file mode 100644 index e367778578..0000000000 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ /dev/null @@ -1,369 +0,0 @@ -# Class: ObjectDetectionModule\ - -Defined in: [modules/computer_vision/ObjectDetectionModule.ts:59](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L59) - -Generic object detection module with type-safe label maps. - -## Extends - -- `VisionLabeledModule`\<[`Detection`](../interfaces/Detection.md)\<`ResolveLabels`\<`T`\>\>[], `ResolveLabels`\<`T`\>\> - -## Type Parameters - -### T - -`T` _extends_ [`ObjectDetectionModelName`](../type-aliases/ObjectDetectionModelName.md) \| [`LabelEnum`](../type-aliases/LabelEnum.md) - -Either a built-in model name (e.g. `'ssdlite-320-mobilenet-v3-large'`) -or a custom [LabelEnum](../type-aliases/LabelEnum.md) label map. - -## Properties - -### generateFromFrame() - -> **generateFromFrame**: (`frameData`, ...`args`) => `any` - -Defined in: [modules/BaseModule.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L56) - -Process a camera frame directly for real-time inference. - -This method is bound to a native JSI function after calling `load()`, -making it worklet-compatible and safe to call from VisionCamera's -frame processor thread. - -**Performance characteristics:** - -- **Zero-copy path**: When using `frame.getNativeBuffer()` from VisionCamera v5, - frame data is accessed directly without copying (fastest, recommended). -- **Copy path**: When using `frame.toArrayBuffer()`, pixel data is copied - from native to JS, then accessed from native code (slower, fallback). - -**Usage with VisionCamera:** - -```typescript -const frameOutput = useFrameOutput({ - pixelFormat: 'rgb', - onFrame(frame) { - 'worklet'; - // Zero-copy approach (recommended) - const nativeBuffer = frame.getNativeBuffer(); - const result = model.generateFromFrame( - { - nativeBuffer: nativeBuffer.pointer, - width: frame.width, - height: frame.height, - }, - ...args - ); - nativeBuffer.release(); - frame.dispose(); - }, -}); -``` - -#### Parameters - -##### frameData - -[`Frame`](../interfaces/Frame.md) - -Frame data object with either nativeBuffer (zero-copy) or data (ArrayBuffer) - -##### args - -...`any`[] - -Additional model-specific arguments (e.g., threshold, options) - -#### Returns - -`any` - -Model-specific output (e.g., detections, classifications, embeddings) - -#### See - -[Frame](../interfaces/Frame.md) for frame data format details - -#### Inherited from - -`VisionLabeledModule.generateFromFrame` - ---- - -### labelMap - -> `protected` `readonly` **labelMap**: `ResolveLabels` - -Defined in: [modules/computer_vision/VisionLabeledModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/VisionLabeledModule.ts#L16) - -#### Inherited from - -`VisionLabeledModule.labelMap` - ---- - -### nativeModule - -> **nativeModule**: `any` = `null` - -Defined in: [modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L17) - -**`Internal`** - -Native module instance (JSI Host Object) - -#### Inherited from - -`VisionLabeledModule.nativeModule` - -## Accessors - -### runOnFrame - -#### Get Signature - -> **get** **runOnFrame**(): (`frame`, ...`args`) => `TOutput` \| `null` - -Defined in: [modules/computer_vision/VisionModule.ts:61](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/VisionModule.ts#L61) - -Synchronous worklet function for real-time VisionCamera frame processing. - -Only available after the model is loaded. Returns null if not loaded. - -**Use this for VisionCamera frame processing in worklets.** -For async processing, use `forward()` instead. - -##### Example - -```typescript -const model = new ClassificationModule(); -await model.load({ modelSource: MODEL }); - -// Use the functional form of setState to store the worklet — passing it -// directly would cause React to invoke it immediately as an updater fn. -const [runOnFrame, setRunOnFrame] = useState(null); -setRunOnFrame(() => model.runOnFrame); - -const frameOutput = useFrameOutput({ - onFrame(frame) { - 'worklet'; - if (!runOnFrame) return; - const result = runOnFrame(frame); - frame.dispose(); - }, -}); -``` - -##### Returns - -(`frame`, ...`args`) => `TOutput` \| `null` - -#### Inherited from - -`VisionLabeledModule.runOnFrame` - -## Methods - -### delete() - -> **delete**(): `void` - -Defined in: [modules/BaseModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L100) - -Unloads the model from memory and releases native resources. - -Always call this method when you're done with a model to prevent memory leaks. - -#### Returns - -`void` - -#### Inherited from - -`VisionLabeledModule.delete` - ---- - -### forward() - -> **forward**(`input`, `detectionThreshold?`): `Promise`\<[`Detection`](../interfaces/Detection.md)\<`ResolveLabels`\<`T`, \{ `rf-detr-nano`: \{ `labelMap`: _typeof_ [`CocoLabel`](../enumerations/CocoLabel.md); `preprocessorConfig`: \{ `normMean`: [`Triple`](../type-aliases/Triple.md)\<`number`\>; `normStd`: [`Triple`](../type-aliases/Triple.md)\<`number`\>; \}; \}; `ssdlite-320-mobilenet-v3-large`: \{ `labelMap`: _typeof_ [`CocoLabel`](../enumerations/CocoLabel.md); `preprocessorConfig`: `undefined`; \}; \}\>\>[]\> - -Defined in: [modules/computer_vision/ObjectDetectionModule.ts:118](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L118) - -Executes the model's forward pass to detect objects within the provided image. - -#### Parameters - -##### input - -A string image source (file path, URI, or Base64) or a [PixelData](../interfaces/PixelData.md) object. - -`string` | [`PixelData`](../interfaces/PixelData.md) - -##### detectionThreshold? - -`number` = `0.7` - -Minimum confidence score for a detection to be included. Default is 0.7. - -#### Returns - -`Promise`\<[`Detection`](../interfaces/Detection.md)\<`ResolveLabels`\<`T`, \{ `rf-detr-nano`: \{ `labelMap`: _typeof_ [`CocoLabel`](../enumerations/CocoLabel.md); `preprocessorConfig`: \{ `normMean`: [`Triple`](../type-aliases/Triple.md)\<`number`\>; `normStd`: [`Triple`](../type-aliases/Triple.md)\<`number`\>; \}; \}; `ssdlite-320-mobilenet-v3-large`: \{ `labelMap`: _typeof_ [`CocoLabel`](../enumerations/CocoLabel.md); `preprocessorConfig`: `undefined`; \}; \}\>\>[]\> - -A Promise resolving to an array of [Detection](../interfaces/Detection.md) objects. - -#### Overrides - -`VisionLabeledModule.forward` - ---- - -### forwardET() - -> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Defined in: [modules/BaseModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L80) - -**`Internal`** - -Runs the model's forward method with the given input tensors. -It returns the output tensors that mimic the structure of output from ExecuTorch. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](../interfaces/TensorPtr.md)[] - -Array of input tensors. - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Array of output tensors. - -#### Inherited from - -`VisionLabeledModule.forwardET` - ---- - -### getInputShape() - -> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> - -Defined in: [modules/BaseModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L91) - -Gets the input shape for a given method and index. - -#### Parameters - -##### methodName - -`string` - -method name - -##### index - -`number` - -index of the argument which shape is requested - -#### Returns - -`Promise`\<`number`[]\> - -The input shape as an array of numbers. - -#### Inherited from - -`VisionLabeledModule.getInputShape` - ---- - -### load() - -> **load**(): `Promise`\<`void`\> - -Defined in: [modules/computer_vision/VisionLabeledModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/VisionLabeledModule.ts#L25) - -Load the model and prepare it for inference. - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`VisionLabeledModule.load` - ---- - -### fromCustomConfig() - -> `static` **fromCustomConfig**\<`L`\>(`modelSource`, `config`, `onDownloadProgress?`): `Promise`\<`ObjectDetectionModule`\<`L`\>\> - -Defined in: [modules/computer_vision/ObjectDetectionModule.ts:125](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L125) - -#### Type Parameters - -##### L - -`L` _extends_ `Readonly`\<`Record`\<`string`, `string` \| `number`\>\> - -#### Parameters - -##### modelSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -##### config - -[`ObjectDetectionConfig`](../type-aliases/ObjectDetectionConfig.md)\<`L`\> - -##### onDownloadProgress? - -(`progress`) => `void` - -#### Returns - -`Promise`\<`ObjectDetectionModule`\<`L`\>\> - ---- - -### fromModelName() - -> `static` **fromModelName**\<`C`\>(`config`, `onDownloadProgress?`): `Promise`\<`ObjectDetectionModule`\<`ModelNameOf`\<`C`\>\>\> - -Defined in: [modules/computer_vision/ObjectDetectionModule.ts:73](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L73) - -Creates an object detection instance for a built-in model. - -#### Type Parameters - -##### C - -`C` _extends_ [`ObjectDetectionModelSources`](../type-aliases/ObjectDetectionModelSources.md) - -#### Parameters - -##### config - -`C` - -A [ObjectDetectionModelSources](../type-aliases/ObjectDetectionModelSources.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`\<`ObjectDetectionModule`\<`ModelNameOf`\<`C`\>\>\> - -A Promise resolving to an `ObjectDetectionModule` instance typed to the chosen model's label map. diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md deleted file mode 100644 index c0b896a294..0000000000 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ /dev/null @@ -1,154 +0,0 @@ -# Class: ResourceFetcher - -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. - -## Constructors - -### Constructor - -> **new ResourceFetcher**(): `ResourceFetcher` - -#### Returns - -`ResourceFetcher` - -## Properties - -### fs - -> `static` **fs**: `object` - -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. - -#### readAsString() - -> **readAsString**: (`path`) => `Promise`\<`string`\> - -Reads the contents of a file as a string. - -##### Parameters - -###### path - -`string` - -Absolute file path to read. - -##### Returns - -`Promise`\<`string`\> - -A promise that resolves to the file contents as a string. - -##### Remarks - -**REQUIRED**: Used internally for reading configuration files (e.g., tokenizer configs). - -#### Remarks - -Provides access to filesystem operations through the configured adapter. -Currently supports reading file contents as strings for configuration files. - -## Methods - -### fetch() - -> `static` **fetch**(`callback?`, ...`sources`): `Promise`\<`string`[] \| `null`\> - -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. - -#### Parameters - -##### callback? - -(`downloadProgress`) => `void` - -Optional callback to track progress of all downloads, reported between 0 and 1. - -##### sources - -...[`ResourceSource`](../type-aliases/ResourceSource.md)[] - -Multiple resources that can be strings, asset references, or objects. - -#### Returns - -`Promise`\<`string`[] \| `null`\> - -If the fetch was successful, it returns a promise which resolves to an array of local file paths for the downloaded/stored resources (without file:// prefix). -If the fetch was interrupted, it returns a promise which resolves to `null`. - ---- - -### getAdapter() - -> `static` **getAdapter**(): [`ResourceFetcherAdapter`](../interfaces/ResourceFetcherAdapter.md) - -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. - -#### Returns - -[`ResourceFetcherAdapter`](../interfaces/ResourceFetcherAdapter.md) - -The configured ResourceFetcherAdapter instance. - -#### Throws - -If no adapter has been set via [setAdapter](#setadapter). - -#### Remarks - -**INTERNAL**: Used internally by all resource fetching operations. - ---- - -### resetAdapter() - -> `static` **resetAdapter**(): `void` - -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. - -#### Returns - -`void` - -#### Remarks - -**INTERNAL**: Used primarily for testing purposes to clear the adapter state. - ---- - -### setAdapter() - -> `static` **setAdapter**(`adapter`): `void` - -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. - -#### Parameters - -##### adapter - -[`ResourceFetcherAdapter`](../interfaces/ResourceFetcherAdapter.md) - -The adapter instance to use for fetching resources. - -#### Returns - -`void` - -#### Remarks - -**INTERNAL**: Used by platform-specific init functions (expo/bare) to inject their fetcher implementation. diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md deleted file mode 100644 index 9566d83f9b..0000000000 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ /dev/null @@ -1,63 +0,0 @@ -# Class: RnExecutorchError - -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. - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` - -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 - -##### code - -`number` - -##### message - -`string` - -##### cause? - -`unknown` - -#### Returns - -`RnExecutorchError` - -#### Overrides - -`Error.constructor` - -## Properties - -### cause? - -> `optional` **cause**: `unknown` - -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. - -#### Overrides - -`Error.cause` - ---- - -### code - -> **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) - -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. diff --git a/docs/docs/06-api-reference/classes/SemanticSegmentationModule.md b/docs/docs/06-api-reference/classes/SemanticSegmentationModule.md deleted file mode 100644 index 97f33ea24f..0000000000 --- a/docs/docs/06-api-reference/classes/SemanticSegmentationModule.md +++ /dev/null @@ -1,373 +0,0 @@ -# Class: SemanticSegmentationModule\ - -Defined in: [modules/computer_vision/SemanticSegmentationModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/SemanticSegmentationModule.ts#L80) - -Generic semantic segmentation module with type-safe label maps. -Use a model name (e.g. `'deeplab-v3-resnet50'`) as the generic parameter for built-in models, -or a custom label enum for custom configs. - -## Extends - -- `BaseLabeledModule`\<`ResolveLabels`\<`T`\>\> - -## Type Parameters - -### T - -`T` _extends_ [`SemanticSegmentationModelName`](../type-aliases/SemanticSegmentationModelName.md) \| [`LabelEnum`](../type-aliases/LabelEnum.md) - -Either a built-in model name (`'deeplab-v3-resnet50'`, -`'deeplab-v3-resnet50-quantized'`, `'deeplab-v3-resnet101'`, -`'deeplab-v3-resnet101-quantized'`, `'deeplab-v3-mobilenet-v3-large'`, -`'deeplab-v3-mobilenet-v3-large-quantized'`, `'lraspp-mobilenet-v3-large'`, -`'lraspp-mobilenet-v3-large-quantized'`, `'fcn-resnet50'`, -`'fcn-resnet50-quantized'`, `'fcn-resnet101'`, `'fcn-resnet101-quantized'`, -`'selfie-segmentation'`) or a custom [LabelEnum](../type-aliases/LabelEnum.md) label map. - -## Properties - -### generateFromFrame() - -> **generateFromFrame**: (`frameData`, ...`args`) => `any` - -Defined in: [modules/BaseModule.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L56) - -Process a camera frame directly for real-time inference. - -This method is bound to a native JSI function after calling `load()`, -making it worklet-compatible and safe to call from VisionCamera's -frame processor thread. - -**Performance characteristics:** - -- **Zero-copy path**: When using `frame.getNativeBuffer()` from VisionCamera v5, - frame data is accessed directly without copying (fastest, recommended). -- **Copy path**: When using `frame.toArrayBuffer()`, pixel data is copied - from native to JS, then accessed from native code (slower, fallback). - -**Usage with VisionCamera:** - -```typescript -const frameOutput = useFrameOutput({ - pixelFormat: 'rgb', - onFrame(frame) { - 'worklet'; - // Zero-copy approach (recommended) - const nativeBuffer = frame.getNativeBuffer(); - const result = model.generateFromFrame( - { - nativeBuffer: nativeBuffer.pointer, - width: frame.width, - height: frame.height, - }, - ...args - ); - nativeBuffer.release(); - frame.dispose(); - }, -}); -``` - -#### Parameters - -##### frameData - -[`Frame`](../interfaces/Frame.md) - -Frame data object with either nativeBuffer (zero-copy) or data (ArrayBuffer) - -##### args - -...`any`[] - -Additional model-specific arguments (e.g., threshold, options) - -#### Returns - -`any` - -Model-specific output (e.g., detections, classifications, embeddings) - -#### See - -[Frame](../interfaces/Frame.md) for frame data format details - -#### Inherited from - -`BaseLabeledModule.generateFromFrame` - ---- - -### labelMap - -> `protected` `readonly` **labelMap**: `ResolveLabels` - -Defined in: [modules/BaseLabeledModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseLabeledModule.ts#L52) - -#### Inherited from - -`BaseLabeledModule.labelMap` - ---- - -### nativeModule - -> **nativeModule**: `any` = `null` - -Defined in: [modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L17) - -**`Internal`** - -Native module instance (JSI Host Object) - -#### Inherited from - -`BaseLabeledModule.nativeModule` - -## Methods - -### delete() - -> **delete**(): `void` - -Defined in: [modules/BaseModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L100) - -Unloads the model from memory and releases native resources. - -Always call this method when you're done with a model to prevent memory leaks. - -#### Returns - -`void` - -#### Inherited from - -`BaseLabeledModule.delete` - ---- - -### forward() - -> **forward**\<`K`\>(`imageSource`, `classesOfInterest?`, `resizeToInput?`): `Promise`\<`Record`\<`"ARGMAX"`, `Int32Array`\<`ArrayBufferLike`\>\> & `Record`\<`K`, `Float32Array`\<`ArrayBufferLike`\>\>\> - -Defined in: [modules/computer_vision/SemanticSegmentationModule.ts:179](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/SemanticSegmentationModule.ts#L179) - -Executes the model's forward pass to perform semantic segmentation on the provided image. - -#### Type Parameters - -##### K - -`K` _extends_ `string` \| `number` \| `symbol` - -#### Parameters - -##### imageSource - -`string` - -A string representing the image source (e.g., a file path, URI, or Base64-encoded string). - -##### classesOfInterest? - -`K`[] = `[]` - -An optional list of label keys indicating which per-class probability masks to include in the output. `ARGMAX` is always returned regardless. - -##### resizeToInput? - -`boolean` = `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`\<`Record`\<`"ARGMAX"`, `Int32Array`\<`ArrayBufferLike`\>\> & `Record`\<`K`, `Float32Array`\<`ArrayBufferLike`\>\>\> - -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. - ---- - -### forwardET() - -> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Defined in: [modules/BaseModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L80) - -**`Internal`** - -Runs the model's forward method with the given input tensors. -It returns the output tensors that mimic the structure of output from ExecuTorch. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](../interfaces/TensorPtr.md)[] - -Array of input tensors. - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Array of output tensors. - -#### Inherited from - -`BaseLabeledModule.forwardET` - ---- - -### getInputShape() - -> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> - -Defined in: [modules/BaseModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L91) - -Gets the input shape for a given method and index. - -#### Parameters - -##### methodName - -`string` - -method name - -##### index - -`number` - -index of the argument which shape is requested - -#### Returns - -`Promise`\<`number`[]\> - -The input shape as an array of numbers. - -#### Inherited from - -`BaseLabeledModule.getInputShape` - ---- - -### load() - -> **load**(): `Promise`\<`void`\> - -Defined in: [modules/BaseLabeledModule.ts:61](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseLabeledModule.ts#L61) - -Load the model and prepare it for inference. - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`BaseLabeledModule.load` - ---- - -### fromCustomConfig() - -> `static` **fromCustomConfig**\<`L`\>(`modelSource`, `config`, `onDownloadProgress?`): `Promise`\<`SemanticSegmentationModule`\<`L`\>\> - -Defined in: [modules/computer_vision/SemanticSegmentationModule.ts:147](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/SemanticSegmentationModule.ts#L147) - -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) - -A fetchable resource pointing to the model binary. - -##### config - -[`SemanticSegmentationConfig`](../type-aliases/SemanticSegmentationConfig.md)\<`L`\> - -A [SemanticSegmentationConfig](../type-aliases/SemanticSegmentationConfig.md) object with the label map and optional preprocessing parameters. - -##### onDownloadProgress? - -(`progress`) => `void` - -Optional callback to monitor download progress, receiving a value between 0 and 1. - -#### Returns - -`Promise`\<`SemanticSegmentationModule`\<`L`\>\> - -A Promise resolving to a `SemanticSegmentationModule` instance typed to the provided label map. - -#### Example - -```ts -const MyLabels = { BACKGROUND: 0, FOREGROUND: 1 } as const; -const segmentation = await SemanticSegmentationModule.fromCustomConfig( - 'https://example.com/custom_model.pte', - { labelMap: MyLabels } -); -``` - ---- - -### fromModelName() - -> `static` **fromModelName**\<`C`\>(`config`, `onDownloadProgress?`): `Promise`\<`SemanticSegmentationModule`\<[`ModelNameOf`](../type-aliases/ModelNameOf.md)\<`C`\>\>\> - -Defined in: [modules/computer_vision/SemanticSegmentationModule.ts:104](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/SemanticSegmentationModule.ts#L104) - -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_ [`SemanticSegmentationModelSources`](../type-aliases/SemanticSegmentationModelSources.md) - -#### Parameters - -##### config - -`C` - -A [SemanticSegmentationModelSources](../type-aliases/SemanticSegmentationModelSources.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`\<`SemanticSegmentationModule`\<[`ModelNameOf`](../type-aliases/ModelNameOf.md)\<`C`\>\>\> - -A Promise resolving to a `SemanticSegmentationModule` instance typed to the chosen model's label map. - -#### Example - -```ts -const segmentation = await SemanticSegmentationModule.fromModelName({ - modelName: 'deeplab-v3', - modelSource: 'https://example.com/deeplab.pte', -}); -``` diff --git a/docs/docs/06-api-reference/classes/SlidingWindowContextStrategy.md b/docs/docs/06-api-reference/classes/SlidingWindowContextStrategy.md deleted file mode 100644 index 0614593f77..0000000000 --- a/docs/docs/06-api-reference/classes/SlidingWindowContextStrategy.md +++ /dev/null @@ -1,90 +0,0 @@ -# Class: SlidingWindowContextStrategy - -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. - -- This strategy calculates the exact token count of the formatted prompt. If the prompt - exceeds the allowed token budget (`maxContextLength` - `bufferTokens`), it recursively - removes the oldest messages. - -## Implements - -- [`ContextStrategy`](../interfaces/ContextStrategy.md) - -## Constructors - -### Constructor - -> **new SlidingWindowContextStrategy**(`bufferTokens`, `allowOrphanedAssistantMessages?`): `SlidingWindowContextStrategy` - -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. - -#### Parameters - -##### bufferTokens - -`number` - -The number of tokens to keep free for the model's generated response (e.g., 1000). - -##### allowOrphanedAssistantMessages? - -`boolean` = `false` - -Whether to allow orphaned assistant messages when trimming the history. -If false, the strategy will ensure that an assistant message is not left without its preceding user message. - -#### Returns - -`SlidingWindowContextStrategy` - -## Methods - -### buildContext() - -> **buildContext**(`systemPrompt`, `history`, `maxContextLength`, `getTokenCount`): [`Message`](../interfaces/Message.md)[] - -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. - -#### Parameters - -##### systemPrompt - -`string` - -The top-level instructions for the model. - -##### history - -[`Message`](../interfaces/Message.md)[] - -The complete conversation history. - -##### maxContextLength - -`number` - -Unused in this strategy, as the strategy relies on token count rather than message count. - -##### getTokenCount - -(`messages`) => `number` - -Callback to calculate the exact token count of the rendered template. - -#### Returns - -[`Message`](../interfaces/Message.md)[] - -The optimized message history guaranteed to fit the token budget. - -#### Implementation of - -[`ContextStrategy`](../interfaces/ContextStrategy.md).[`buildContext`](../interfaces/ContextStrategy.md#buildcontext) diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md deleted file mode 100644 index a54d795e4e..0000000000 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ /dev/null @@ -1,211 +0,0 @@ -# Class: SpeechToTextModule - -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. - -## Constructors - -### Constructor - -> **new SpeechToTextModule**(): `SpeechToTextModule` - -#### Returns - -`SpeechToTextModule` - -## Methods - -### decode() - -> **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -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. - -#### Parameters - -##### tokens - -`Int32Array` - -The input tokens. - -##### encoderOutput - -`Float32Array` - -The encoder output. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -Decoded output. - ---- - -### delete() - -> **delete**(): `void` - -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. - -#### Returns - -`void` - ---- - -### encode() - -> **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -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. - -#### Parameters - -##### waveform - -`Float32Array` - -The input audio waveform. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -The encoded output. - ---- - -### load() - -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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. - -#### Parameters - -##### model - -[`SpeechToTextModelConfig`](../interfaces/SpeechToTextModelConfig.md) - -Configuration object containing model sources. - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> - ---- - -### stream() - -> **stream**(`options?`): `AsyncGenerator`\<\{ `committed`: [`TranscriptionResult`](../interfaces/TranscriptionResult.md); `nonCommitted`: [`TranscriptionResult`](../interfaces/TranscriptionResult.md); \}\> - -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. -Committed transcription contains the part of the transcription that is finalized and will not change. -Useful for displaying stable results during streaming. -Non-committed transcription contains the part of the transcription that is still being processed and may change. -Useful for displaying live, partial results during streaming. -Use with `streamInsert` and `streamStop` to control the stream. - -#### Parameters - -##### options? - -[`DecodingOptions`](../interfaces/DecodingOptions.md) = `{}` - -Decoding options including language. - -#### Returns - -`AsyncGenerator`\<\{ `committed`: [`TranscriptionResult`](../interfaces/TranscriptionResult.md); `nonCommitted`: [`TranscriptionResult`](../interfaces/TranscriptionResult.md); \}\> - -An async generator yielding transcription updates. - ---- - -### streamInsert() - -> **streamInsert**(`waveform`): `void` - -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. - -#### Parameters - -##### waveform - -`Float32Array` - -The audio chunk to insert. - -#### Returns - -`void` - ---- - -### streamStop() - -> **streamStop**(): `void` - -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. - -#### Returns - -`void` - ---- - -### transcribe() - -> **transcribe**(`waveform`, `options?`): `Promise`\<[`TranscriptionResult`](../interfaces/TranscriptionResult.md)\> - -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`. -Returns the transcription as a string. Passing `number[]` is deprecated. - -#### Parameters - -##### waveform - -`Float32Array` - -The Float32Array audio data. - -##### options? - -[`DecodingOptions`](../interfaces/DecodingOptions.md) = `{}` - -Decoding options including language. - -#### Returns - -`Promise`\<[`TranscriptionResult`](../interfaces/TranscriptionResult.md)\> - -The transcription string. diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md deleted file mode 100644 index fde173d7c5..0000000000 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ /dev/null @@ -1,255 +0,0 @@ -# Class: StyleTransferModule - -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. - -## Extends - -- `BaseModule` - -## Constructors - -### Constructor - -> **new StyleTransferModule**(): `StyleTransferModule` - -#### Returns - -`StyleTransferModule` - -#### Inherited from - -`BaseModule.constructor` - -## Properties - -### generateFromFrame() - -> **generateFromFrame**: (`frameData`, ...`args`) => `any` - -Defined in: [modules/BaseModule.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L56) - -Process a camera frame directly for real-time inference. - -This method is bound to a native JSI function after calling `load()`, -making it worklet-compatible and safe to call from VisionCamera's -frame processor thread. - -**Performance characteristics:** - -- **Zero-copy path**: When using `frame.getNativeBuffer()` from VisionCamera v5, - frame data is accessed directly without copying (fastest, recommended). -- **Copy path**: When using `frame.toArrayBuffer()`, pixel data is copied - from native to JS, then accessed from native code (slower, fallback). - -**Usage with VisionCamera:** - -```typescript -const frameOutput = useFrameOutput({ - pixelFormat: 'rgb', - onFrame(frame) { - 'worklet'; - // Zero-copy approach (recommended) - const nativeBuffer = frame.getNativeBuffer(); - const result = model.generateFromFrame( - { - nativeBuffer: nativeBuffer.pointer, - width: frame.width, - height: frame.height, - }, - ...args - ); - nativeBuffer.release(); - frame.dispose(); - }, -}); -``` - -#### Parameters - -##### frameData - -[`Frame`](../interfaces/Frame.md) - -Frame data object with either nativeBuffer (zero-copy) or data (ArrayBuffer) - -##### args - -...`any`[] - -Additional model-specific arguments (e.g., threshold, options) - -#### Returns - -`any` - -Model-specific output (e.g., detections, classifications, embeddings) - -#### See - -[Frame](../interfaces/Frame.md) for frame data format details - -#### Inherited from - -`BaseModule.generateFromFrame` - ---- - -### nativeModule - -> **nativeModule**: `any` = `null` - -Defined in: [modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L17) - -**`Internal`** - -Native module instance (JSI Host Object) - -#### Inherited from - -`BaseModule.nativeModule` - -## Methods - -### delete() - -> **delete**(): `void` - -Defined in: [modules/BaseModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L100) - -Unloads the model from memory and releases native resources. - -Always call this method when you're done with a model to prevent memory leaks. - -#### Returns - -`void` - -#### Inherited from - -`BaseModule.delete` - ---- - -### forward() - -> **forward**(`imageSource`): `Promise`\<`string`\> - -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. - -#### Parameters - -##### imageSource - -`string` - -The image source to be processed. - -#### Returns - -`Promise`\<`string`\> - -The stylized image as a Base64-encoded string. - ---- - -### forwardET() - -> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Defined in: [modules/BaseModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L80) - -**`Internal`** - -Runs the model's forward method with the given input tensors. -It returns the output tensors that mimic the structure of output from ExecuTorch. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](../interfaces/TensorPtr.md)[] - -Array of input tensors. - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Array of output tensors. - -#### Inherited from - -`BaseModule.forwardET` - ---- - -### getInputShape() - -> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> - -Defined in: [modules/BaseModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L91) - -Gets the input shape for a given method and index. - -#### Parameters - -##### methodName - -`string` - -method name - -##### index - -`number` - -index of the argument which shape is requested - -#### Returns - -`Promise`\<`number`[]\> - -The input shape as an array of numbers. - -#### Inherited from - -`BaseModule.getInputShape` - ---- - -### load() - -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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`. - -#### Parameters - -##### model - -Object containing `modelSource`. - -###### modelSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md deleted file mode 100644 index 39830272b3..0000000000 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ /dev/null @@ -1,262 +0,0 @@ -# Class: TextEmbeddingsModule - -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. - -## Extends - -- `BaseModule` - -## Constructors - -### Constructor - -> **new TextEmbeddingsModule**(): `TextEmbeddingsModule` - -#### Returns - -`TextEmbeddingsModule` - -#### Inherited from - -`BaseModule.constructor` - -## Properties - -### generateFromFrame() - -> **generateFromFrame**: (`frameData`, ...`args`) => `any` - -Defined in: [modules/BaseModule.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L56) - -Process a camera frame directly for real-time inference. - -This method is bound to a native JSI function after calling `load()`, -making it worklet-compatible and safe to call from VisionCamera's -frame processor thread. - -**Performance characteristics:** - -- **Zero-copy path**: When using `frame.getNativeBuffer()` from VisionCamera v5, - frame data is accessed directly without copying (fastest, recommended). -- **Copy path**: When using `frame.toArrayBuffer()`, pixel data is copied - from native to JS, then accessed from native code (slower, fallback). - -**Usage with VisionCamera:** - -```typescript -const frameOutput = useFrameOutput({ - pixelFormat: 'rgb', - onFrame(frame) { - 'worklet'; - // Zero-copy approach (recommended) - const nativeBuffer = frame.getNativeBuffer(); - const result = model.generateFromFrame( - { - nativeBuffer: nativeBuffer.pointer, - width: frame.width, - height: frame.height, - }, - ...args - ); - nativeBuffer.release(); - frame.dispose(); - }, -}); -``` - -#### Parameters - -##### frameData - -[`Frame`](../interfaces/Frame.md) - -Frame data object with either nativeBuffer (zero-copy) or data (ArrayBuffer) - -##### args - -...`any`[] - -Additional model-specific arguments (e.g., threshold, options) - -#### Returns - -`any` - -Model-specific output (e.g., detections, classifications, embeddings) - -#### See - -[Frame](../interfaces/Frame.md) for frame data format details - -#### Inherited from - -`BaseModule.generateFromFrame` - ---- - -### nativeModule - -> **nativeModule**: `any` = `null` - -Defined in: [modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L17) - -**`Internal`** - -Native module instance (JSI Host Object) - -#### Inherited from - -`BaseModule.nativeModule` - -## Methods - -### delete() - -> **delete**(): `void` - -Defined in: [modules/BaseModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L100) - -Unloads the model from memory and releases native resources. - -Always call this method when you're done with a model to prevent memory leaks. - -#### Returns - -`void` - -#### Inherited from - -`BaseModule.delete` - ---- - -### forward() - -> **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -Defined in: [modules/natural_language_processing/TextEmbeddingsModule.ts:63](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L63) - -Executes the model's forward pass, where `input` is a text that will be embedded. - -#### Parameters - -##### input - -`string` - -The text string to embed. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -A Float32Array containing the vector embeddings. - ---- - -### forwardET() - -> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Defined in: [modules/BaseModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L80) - -**`Internal`** - -Runs the model's forward method with the given input tensors. -It returns the output tensors that mimic the structure of output from ExecuTorch. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](../interfaces/TensorPtr.md)[] - -Array of input tensors. - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Array of output tensors. - -#### Inherited from - -`BaseModule.forwardET` - ---- - -### getInputShape() - -> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> - -Defined in: [modules/BaseModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L91) - -Gets the input shape for a given method and index. - -#### Parameters - -##### methodName - -`string` - -method name - -##### index - -`number` - -index of the argument which shape is requested - -#### Returns - -`Promise`\<`number`[]\> - -The input shape as an array of numbers. - -#### Inherited from - -`BaseModule.getInputShape` - ---- - -### load() - -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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. - -#### Parameters - -##### model - -Object containing model and tokenizer sources. - -###### modelSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` that specifies the location of the text embeddings model binary. - -###### tokenizerSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` that specifies the location of the tokenizer JSON file. - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to track download progress (value between 0 and 1). - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md deleted file mode 100644 index 8f74a7a0e4..0000000000 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ /dev/null @@ -1,315 +0,0 @@ -# Class: TextToImageModule - -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. - -## Extends - -- `BaseModule` - -## Constructors - -### Constructor - -> **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` - -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. - -#### Parameters - -##### inferenceCallback? - -(`stepIdx`) => `void` - -Optional callback function that receives the current step index during inference. - -#### Returns - -`TextToImageModule` - -#### Overrides - -`BaseModule.constructor` - -## Properties - -### generateFromFrame() - -> **generateFromFrame**: (`frameData`, ...`args`) => `any` - -Defined in: [modules/BaseModule.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L56) - -Process a camera frame directly for real-time inference. - -This method is bound to a native JSI function after calling `load()`, -making it worklet-compatible and safe to call from VisionCamera's -frame processor thread. - -**Performance characteristics:** - -- **Zero-copy path**: When using `frame.getNativeBuffer()` from VisionCamera v5, - frame data is accessed directly without copying (fastest, recommended). -- **Copy path**: When using `frame.toArrayBuffer()`, pixel data is copied - from native to JS, then accessed from native code (slower, fallback). - -**Usage with VisionCamera:** - -```typescript -const frameOutput = useFrameOutput({ - pixelFormat: 'rgb', - onFrame(frame) { - 'worklet'; - // Zero-copy approach (recommended) - const nativeBuffer = frame.getNativeBuffer(); - const result = model.generateFromFrame( - { - nativeBuffer: nativeBuffer.pointer, - width: frame.width, - height: frame.height, - }, - ...args - ); - nativeBuffer.release(); - frame.dispose(); - }, -}); -``` - -#### Parameters - -##### frameData - -[`Frame`](../interfaces/Frame.md) - -Frame data object with either nativeBuffer (zero-copy) or data (ArrayBuffer) - -##### args - -...`any`[] - -Additional model-specific arguments (e.g., threshold, options) - -#### Returns - -`any` - -Model-specific output (e.g., detections, classifications, embeddings) - -#### See - -[Frame](../interfaces/Frame.md) for frame data format details - -#### Inherited from - -`BaseModule.generateFromFrame` - ---- - -### nativeModule - -> **nativeModule**: `any` = `null` - -Defined in: [modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L17) - -**`Internal`** - -Native module instance (JSI Host Object) - -#### Inherited from - -`BaseModule.nativeModule` - -## Methods - -### delete() - -> **delete**(): `void` - -Defined in: [modules/BaseModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L100) - -Unloads the model from memory and releases native resources. - -Always call this method when you're done with a model to prevent memory leaks. - -#### Returns - -`void` - -#### Inherited from - -`BaseModule.delete` - ---- - -### forward() - -> **forward**(`input`, `imageSize?`, `numSteps?`, `seed?`): `Promise`\<`string`\> - -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. - -#### Parameters - -##### input - -`string` - -The text prompt to generate the image from. - -##### imageSize? - -`number` = `512` - -The desired width and height of the output image in pixels. - -##### numSteps? - -`number` = `5` - -The number of inference steps to perform. - -##### seed? - -`number` - -An optional seed for random number generation to ensure reproducibility. - -#### Returns - -`Promise`\<`string`\> - -A Base64-encoded string representing the generated PNG image. - ---- - -### forwardET() - -> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Defined in: [modules/BaseModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L80) - -**`Internal`** - -Runs the model's forward method with the given input tensors. -It returns the output tensors that mimic the structure of output from ExecuTorch. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](../interfaces/TensorPtr.md)[] - -Array of input tensors. - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Array of output tensors. - -#### Inherited from - -`BaseModule.forwardET` - ---- - -### getInputShape() - -> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> - -Defined in: [modules/BaseModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L91) - -Gets the input shape for a given method and index. - -#### Parameters - -##### methodName - -`string` - -method name - -##### index - -`number` - -index of the argument which shape is requested - -#### Returns - -`Promise`\<`number`[]\> - -The input shape as an array of numbers. - -#### Inherited from - -`BaseModule.getInputShape` - ---- - -### interrupt() - -> **interrupt**(): `void` - -Defined in: [modules/computer_vision/TextToImageModule.ts:138](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L138) - -Interrupts model generation. The model is stopped in the nearest step. - -#### Returns - -`void` - ---- - -### load() - -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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. - -#### Parameters - -##### model - -Object containing sources for tokenizer, scheduler, encoder, unet, and decoder. - -###### decoderSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -###### encoderSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -###### schedulerSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -###### tokenizerSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -###### unetSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/TextToSpeechModule.md b/docs/docs/06-api-reference/classes/TextToSpeechModule.md deleted file mode 100644 index a21577d2b3..0000000000 --- a/docs/docs/06-api-reference/classes/TextToSpeechModule.md +++ /dev/null @@ -1,194 +0,0 @@ -# Class: TextToSpeechModule - -Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L18) - -Module for Text to Speech (TTS) functionalities. - -## Constructors - -### Constructor - -> **new TextToSpeechModule**(): `TextToSpeechModule` - -#### Returns - -`TextToSpeechModule` - -## Properties - -### nativeModule - -> **nativeModule**: `any` = `null` - -Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L22) - -Native module instance - -## Methods - -### delete() - -> **delete**(): `void` - -Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:229](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L229) - -Unloads the model from memory. - -#### Returns - -`void` - ---- - -### forward() - -> **forward**(`text`, `speed?`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:118](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L118) - -Synthesizes the provided text into speech. -Returns a promise that resolves to the full audio waveform as a `Float32Array`. - -#### Parameters - -##### text - -`string` - -The input text to be synthesized. - -##### speed? - -`number` = `1.0` - -Optional speed multiplier for the speech synthesis (default is 1.0). - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -A promise resolving to the synthesized audio waveform. - ---- - -### forwardFromPhonemes() - -> **forwardFromPhonemes**(`phonemes`, `speed?`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:135](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L135) - -Synthesizes pre-computed phonemes into speech, bypassing the built-in phonemizer. -This allows using an external G2P system (e.g. the Python `phonemizer` library, -espeak-ng, or any custom phonemizer). - -#### Parameters - -##### phonemes - -`string` - -The pre-computed IPA phoneme string. - -##### speed? - -`number` = `1.0` - -Optional speed multiplier for the speech synthesis (default is 1.0). - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -A promise resolving to the synthesized audio waveform. - ---- - -### load() - -> **load**(`config`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L31) - -Loads the model and voice assets specified by the config object. -`onDownloadProgressCallback` allows you to monitor the current progress. - -#### Parameters - -##### config - -[`TextToSpeechConfig`](../interfaces/TextToSpeechConfig.md) - -Configuration object containing `model` source and `voice`. - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> - ---- - -### stream() - -> **stream**(`input`): `AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>\> - -Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:196](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L196) - -Starts a streaming synthesis session. Yields audio chunks as they are generated. - -#### Parameters - -##### input - -[`TextToSpeechStreamingInput`](../interfaces/TextToSpeechStreamingInput.md) - -Input object containing text and optional speed. - -#### Returns - -`AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>\> - -An async generator yielding Float32Array audio chunks. - ---- - -### streamFromPhonemes() - -> **streamFromPhonemes**(`input`): `AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>\> - -Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:210](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L210) - -Starts a streaming synthesis session from pre-computed phonemes. -Bypasses the built-in phonemizer, allowing use of external G2P systems. - -#### Parameters - -##### input - -[`TextToSpeechStreamingPhonemeInput`](../interfaces/TextToSpeechStreamingPhonemeInput.md) - -Input object containing phonemes and optional speed. - -#### Returns - -`AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>\> - -An async generator yielding Float32Array audio chunks. - ---- - -### streamStop() - -> **streamStop**(): `void` - -Defined in: [modules/natural_language_processing/TextToSpeechModule.ts:222](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L222) - -Stops the streaming process if there is any ongoing. - -#### Returns - -`void` diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md deleted file mode 100644 index b64dde8fe7..0000000000 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ /dev/null @@ -1,174 +0,0 @@ -# Class: TokenizerModule - -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. - -## Constructors - -### Constructor - -> **new TokenizerModule**(): `TokenizerModule` - -#### Returns - -`TokenizerModule` - -## Properties - -### nativeModule - -> **nativeModule**: `any` - -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 - -## Methods - -### decode() - -> **decode**(`tokens`, `skipSpecialTokens?`): `Promise`\<`string`\> - -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. - -#### Parameters - -##### tokens - -`number`[] - -Array of token IDs to be decoded. - -##### skipSpecialTokens? - -`boolean` = `true` - -Whether to skip special tokens during decoding (default: true). - -#### Returns - -`Promise`\<`string`\> - -The decoded string. - ---- - -### encode() - -> **encode**(`input`): `Promise`\<`number`[]\> - -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. - -#### Parameters - -##### input - -`string` - -The input string to be tokenized. - -#### Returns - -`Promise`\<`number`[]\> - -An array of token IDs. - ---- - -### getVocabSize() - -> **getVocabSize**(): `Promise`\<`number`\> - -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. - -#### Returns - -`Promise`\<`number`\> - -The vocabulary size. - ---- - -### idToToken() - -> **idToToken**(`tokenId`): `Promise`\<`string`\> - -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. - -#### Parameters - -##### tokenId - -`number` - -ID of the token. - -#### Returns - -`Promise`\<`string`\> - -The token string associated to ID. - ---- - -### load() - -> **load**(`tokenizer`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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. - -#### Parameters - -##### tokenizer - -Object containing `tokenizerSource`. - -###### tokenizerSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> - ---- - -### tokenToId() - -> **tokenToId**(`token`): `Promise`\<`number`\> - -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. - -#### Parameters - -##### token - -`string` - -The token string. - -#### Returns - -`Promise`\<`number`\> - -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 deleted file mode 100644 index 6b9ff41207..0000000000 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ /dev/null @@ -1,255 +0,0 @@ -# Class: VADModule - -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. - -## Extends - -- `BaseModule` - -## Constructors - -### Constructor - -> **new VADModule**(): `VADModule` - -#### Returns - -`VADModule` - -#### Inherited from - -`BaseModule.constructor` - -## Properties - -### generateFromFrame() - -> **generateFromFrame**: (`frameData`, ...`args`) => `any` - -Defined in: [modules/BaseModule.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L56) - -Process a camera frame directly for real-time inference. - -This method is bound to a native JSI function after calling `load()`, -making it worklet-compatible and safe to call from VisionCamera's -frame processor thread. - -**Performance characteristics:** - -- **Zero-copy path**: When using `frame.getNativeBuffer()` from VisionCamera v5, - frame data is accessed directly without copying (fastest, recommended). -- **Copy path**: When using `frame.toArrayBuffer()`, pixel data is copied - from native to JS, then accessed from native code (slower, fallback). - -**Usage with VisionCamera:** - -```typescript -const frameOutput = useFrameOutput({ - pixelFormat: 'rgb', - onFrame(frame) { - 'worklet'; - // Zero-copy approach (recommended) - const nativeBuffer = frame.getNativeBuffer(); - const result = model.generateFromFrame( - { - nativeBuffer: nativeBuffer.pointer, - width: frame.width, - height: frame.height, - }, - ...args - ); - nativeBuffer.release(); - frame.dispose(); - }, -}); -``` - -#### Parameters - -##### frameData - -[`Frame`](../interfaces/Frame.md) - -Frame data object with either nativeBuffer (zero-copy) or data (ArrayBuffer) - -##### args - -...`any`[] - -Additional model-specific arguments (e.g., threshold, options) - -#### Returns - -`any` - -Model-specific output (e.g., detections, classifications, embeddings) - -#### See - -[Frame](../interfaces/Frame.md) for frame data format details - -#### Inherited from - -`BaseModule.generateFromFrame` - ---- - -### nativeModule - -> **nativeModule**: `any` = `null` - -Defined in: [modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L17) - -**`Internal`** - -Native module instance (JSI Host Object) - -#### Inherited from - -`BaseModule.nativeModule` - -## Methods - -### delete() - -> **delete**(): `void` - -Defined in: [modules/BaseModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L100) - -Unloads the model from memory and releases native resources. - -Always call this method when you're done with a model to prevent memory leaks. - -#### Returns - -`void` - -#### Inherited from - -`BaseModule.delete` - ---- - -### forward() - -> **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> - -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). - -#### Parameters - -##### waveform - -`Float32Array` - -The input audio waveform as a Float32Array. It must represent a mono audio signal sampled at 16kHz. - -#### Returns - -`Promise`\<[`Segment`](../interfaces/Segment.md)[]\> - -A promise resolving to an array of detected speech segments. - ---- - -### forwardET() - -> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Defined in: [modules/BaseModule.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L80) - -**`Internal`** - -Runs the model's forward method with the given input tensors. -It returns the output tensors that mimic the structure of output from ExecuTorch. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](../interfaces/TensorPtr.md)[] - -Array of input tensors. - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -Array of output tensors. - -#### Inherited from - -`BaseModule.forwardET` - ---- - -### getInputShape() - -> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> - -Defined in: [modules/BaseModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L91) - -Gets the input shape for a given method and index. - -#### Parameters - -##### methodName - -`string` - -method name - -##### index - -`number` - -index of the argument which shape is requested - -#### Returns - -`Promise`\<`number`[]\> - -The input shape as an array of numbers. - -#### Inherited from - -`BaseModule.getInputShape` - ---- - -### load() - -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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`. - -#### Parameters - -##### model - -Object containing `modelSource`. - -###### modelSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md deleted file mode 100644 index a01418a083..0000000000 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ /dev/null @@ -1,102 +0,0 @@ -# Class: VerticalOCRModule - -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. - -## Constructors - -### Constructor - -> **new VerticalOCRModule**(): `VerticalOCRModule` - -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 - -`VerticalOCRModule` - -## Methods - -### delete() - -> **delete**(): `void` - -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. - -#### Returns - -`void` - ---- - -### forward() - -> **forward**(`imageSource`): `Promise`\<[`OCRDetection`](../interfaces/OCRDetection.md)[]\> - -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. - -#### Parameters - -##### imageSource - -`string` - -The image source to be processed. - -#### Returns - -`Promise`\<[`OCRDetection`](../interfaces/OCRDetection.md)[]\> - -The OCR result as a `OCRDetection[]`. - ---- - -### load() - -> **load**(`model`, `independentCharacters`, `onDownloadProgressCallback?`): `Promise`\<`void`\> - -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, -and `language` is a parameter that specifies the language of the text to be recognized by the OCR. - -#### Parameters - -##### model - -Object containing `detectorSource`, `recognizerSource`, and `language`. - -###### detectorSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -###### language - -`"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -###### recognizerSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -##### independentCharacters - -`boolean` - -Whether to treat characters independently during recognition. - -##### onDownloadProgressCallback? - -(`progress`) => `void` - -Optional callback to monitor download progress. - -#### Returns - -`Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/enumerations/CocoLabel.md b/docs/docs/06-api-reference/enumerations/CocoLabel.md deleted file mode 100644 index 8a15fbe257..0000000000 --- a/docs/docs/06-api-reference/enumerations/CocoLabel.md +++ /dev/null @@ -1,725 +0,0 @@ -# Enumeration: CocoLabel - -Defined in: [constants/commonVision.ts:11](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L11) - -COCO dataset class labels used for object detection. - -## Enumeration Members - -### AIRPLANE - -> **AIRPLANE**: `5` - -Defined in: [constants/commonVision.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L16) - ---- - -### APPLE - -> **APPLE**: `53` - -Defined in: [constants/commonVision.ts:63](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L63) - ---- - -### BACKPACK - -> **BACKPACK**: `27` - -Defined in: [constants/commonVision.ts:38](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L38) - ---- - -### BANANA - -> **BANANA**: `52` - -Defined in: [constants/commonVision.ts:62](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L62) - ---- - -### BASEBALL - -> **BASEBALL**: `39` - -Defined in: [constants/commonVision.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L50) - ---- - -### BEAR - -> **BEAR**: `23` - -Defined in: [constants/commonVision.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L34) - ---- - -### BED - -> **BED**: `65` - -Defined in: [constants/commonVision.ts:75](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L75) - ---- - -### BENCH - -> **BENCH**: `15` - -Defined in: [constants/commonVision.ts:26](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L26) - ---- - -### BICYCLE - -> **BICYCLE**: `2` - -Defined in: [constants/commonVision.ts:13](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L13) - ---- - -### BIRD - -> **BIRD**: `16` - -Defined in: [constants/commonVision.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L27) - ---- - -### BLENDER - -> **BLENDER**: `83` - -Defined in: [constants/commonVision.ts:93](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L93) - ---- - -### BOAT - -> **BOAT**: `9` - -Defined in: [constants/commonVision.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L20) - ---- - -### BOOK - -> **BOOK**: `84` - -Defined in: [constants/commonVision.ts:94](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L94) - ---- - -### BOTTLE - -> **BOTTLE**: `44` - -Defined in: [constants/commonVision.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L54) - ---- - -### BOWL - -> **BOWL**: `51` - -Defined in: [constants/commonVision.ts:61](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L61) - ---- - -### BROCCOLI - -> **BROCCOLI**: `56` - -Defined in: [constants/commonVision.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L66) - ---- - -### BUS - -> **BUS**: `6` - -Defined in: [constants/commonVision.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L17) - ---- - -### CAKE - -> **CAKE**: `61` - -Defined in: [constants/commonVision.ts:71](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L71) - ---- - -### CAR - -> **CAR**: `3` - -Defined in: [constants/commonVision.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L14) - ---- - -### CARROT - -> **CARROT**: `57` - -Defined in: [constants/commonVision.ts:67](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L67) - ---- - -### CAT - -> **CAT**: `17` - -Defined in: [constants/commonVision.ts:28](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L28) - ---- - -### CELL_PHONE - -> **CELL_PHONE**: `77` - -Defined in: [constants/commonVision.ts:87](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L87) - ---- - -### CHAIR - -> **CHAIR**: `62` - -Defined in: [constants/commonVision.ts:72](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L72) - ---- - -### CLOCK - -> **CLOCK**: `85` - -Defined in: [constants/commonVision.ts:95](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L95) - ---- - -### COUCH - -> **COUCH**: `63` - -Defined in: [constants/commonVision.ts:73](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L73) - ---- - -### COW - -> **COW**: `21` - -Defined in: [constants/commonVision.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L32) - ---- - -### CUP - -> **CUP**: `47` - -Defined in: [constants/commonVision.ts:57](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L57) - ---- - -### DESK - -> **DESK**: `69` - -Defined in: [constants/commonVision.ts:79](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L79) - ---- - -### DINING_TABLE - -> **DINING_TABLE**: `67` - -Defined in: [constants/commonVision.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L77) - ---- - -### DOG - -> **DOG**: `18` - -Defined in: [constants/commonVision.ts:29](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L29) - ---- - -### DONUT - -> **DONUT**: `60` - -Defined in: [constants/commonVision.ts:70](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L70) - ---- - -### DOOR - -> **DOOR**: `71` - -Defined in: [constants/commonVision.ts:81](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L81) - ---- - -### ELEPHANT - -> **ELEPHANT**: `22` - -Defined in: [constants/commonVision.ts:33](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L33) - ---- - -### EYE - -> **EYE**: `30` - -Defined in: [constants/commonVision.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L41) - ---- - -### FIRE_HYDRANT - -> **FIRE_HYDRANT**: `11` - -Defined in: [constants/commonVision.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L22) - ---- - -### FORK - -> **FORK**: `48` - -Defined in: [constants/commonVision.ts:58](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L58) - ---- - -### FRISBEE - -> **FRISBEE**: `34` - -Defined in: [constants/commonVision.ts:45](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L45) - ---- - -### GIRAFFE - -> **GIRAFFE**: `25` - -Defined in: [constants/commonVision.ts:36](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L36) - ---- - -### HAIR_BRUSH - -> **HAIR_BRUSH**: `91` - -Defined in: [constants/commonVision.ts:101](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L101) - ---- - -### HAIR_DRIER - -> **HAIR_DRIER**: `89` - -Defined in: [constants/commonVision.ts:99](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L99) - ---- - -### HANDBAG - -> **HANDBAG**: `31` - -Defined in: [constants/commonVision.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L42) - ---- - -### HAT - -> **HAT**: `26` - -Defined in: [constants/commonVision.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L37) - ---- - -### HORSE - -> **HORSE**: `19` - -Defined in: [constants/commonVision.ts:30](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L30) - ---- - -### HOT_DOG - -> **HOT_DOG**: `58` - -Defined in: [constants/commonVision.ts:68](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L68) - ---- - -### KEYBOARD - -> **KEYBOARD**: `76` - -Defined in: [constants/commonVision.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L86) - ---- - -### KITE - -> **KITE**: `38` - -Defined in: [constants/commonVision.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L49) - ---- - -### KNIFE - -> **KNIFE**: `49` - -Defined in: [constants/commonVision.ts:59](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L59) - ---- - -### LAPTOP - -> **LAPTOP**: `73` - -Defined in: [constants/commonVision.ts:83](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L83) - ---- - -### MICROWAVE - -> **MICROWAVE**: `78` - -Defined in: [constants/commonVision.ts:88](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L88) - ---- - -### MIRROR - -> **MIRROR**: `66` - -Defined in: [constants/commonVision.ts:76](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L76) - ---- - -### MOTORCYCLE - -> **MOTORCYCLE**: `4` - -Defined in: [constants/commonVision.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L15) - ---- - -### MOUSE - -> **MOUSE**: `74` - -Defined in: [constants/commonVision.ts:84](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L84) - ---- - -### ORANGE - -> **ORANGE**: `55` - -Defined in: [constants/commonVision.ts:65](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L65) - ---- - -### OVEN - -> **OVEN**: `79` - -Defined in: [constants/commonVision.ts:89](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L89) - ---- - -### PARKING - -> **PARKING**: `14` - -Defined in: [constants/commonVision.ts:25](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L25) - ---- - -### PERSON - -> **PERSON**: `1` - -Defined in: [constants/commonVision.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L12) - ---- - -### PIZZA - -> **PIZZA**: `59` - -Defined in: [constants/commonVision.ts:69](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L69) - ---- - -### PLATE - -> **PLATE**: `45` - -Defined in: [constants/commonVision.ts:55](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L55) - ---- - -### POTTED_PLANT - -> **POTTED_PLANT**: `64` - -Defined in: [constants/commonVision.ts:74](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L74) - ---- - -### REFRIGERATOR - -> **REFRIGERATOR**: `82` - -Defined in: [constants/commonVision.ts:92](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L92) - ---- - -### REMOTE - -> **REMOTE**: `75` - -Defined in: [constants/commonVision.ts:85](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L85) - ---- - -### SANDWICH - -> **SANDWICH**: `54` - -Defined in: [constants/commonVision.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L64) - ---- - -### SCISSORS - -> **SCISSORS**: `87` - -Defined in: [constants/commonVision.ts:97](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L97) - ---- - -### SHEEP - -> **SHEEP**: `20` - -Defined in: [constants/commonVision.ts:31](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L31) - ---- - -### SHOE - -> **SHOE**: `29` - -Defined in: [constants/commonVision.ts:40](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L40) - ---- - -### SINK - -> **SINK**: `81` - -Defined in: [constants/commonVision.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L91) - ---- - -### SKATEBOARD - -> **SKATEBOARD**: `41` - -Defined in: [constants/commonVision.ts:51](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L51) - ---- - -### SKIS - -> **SKIS**: `35` - -Defined in: [constants/commonVision.ts:46](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L46) - ---- - -### SNOWBOARD - -> **SNOWBOARD**: `36` - -Defined in: [constants/commonVision.ts:47](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L47) - ---- - -### SPOON - -> **SPOON**: `50` - -Defined in: [constants/commonVision.ts:60](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L60) - ---- - -### SPORTS - -> **SPORTS**: `37` - -Defined in: [constants/commonVision.ts:48](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L48) - ---- - -### STOP_SIGN - -> **STOP_SIGN**: `13` - -Defined in: [constants/commonVision.ts:24](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L24) - ---- - -### STREET_SIGN - -> **STREET_SIGN**: `12` - -Defined in: [constants/commonVision.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L23) - ---- - -### SUITCASE - -> **SUITCASE**: `33` - -Defined in: [constants/commonVision.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L44) - ---- - -### SURFBOARD - -> **SURFBOARD**: `42` - -Defined in: [constants/commonVision.ts:52](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L52) - ---- - -### TEDDY_BEAR - -> **TEDDY_BEAR**: `88` - -Defined in: [constants/commonVision.ts:98](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L98) - ---- - -### TENNIS_RACKET - -> **TENNIS_RACKET**: `43` - -Defined in: [constants/commonVision.ts:53](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L53) - ---- - -### TIE - -> **TIE**: `32` - -Defined in: [constants/commonVision.ts:43](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L43) - ---- - -### TOASTER - -> **TOASTER**: `80` - -Defined in: [constants/commonVision.ts:90](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L90) - ---- - -### TOILET - -> **TOILET**: `70` - -Defined in: [constants/commonVision.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L80) - ---- - -### TOOTHBRUSH - -> **TOOTHBRUSH**: `90` - -Defined in: [constants/commonVision.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L100) - ---- - -### TRAFFIC_LIGHT - -> **TRAFFIC_LIGHT**: `10` - -Defined in: [constants/commonVision.ts:21](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L21) - ---- - -### TRAIN - -> **TRAIN**: `7` - -Defined in: [constants/commonVision.ts:18](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L18) - ---- - -### TRUCK - -> **TRUCK**: `8` - -Defined in: [constants/commonVision.ts:19](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L19) - ---- - -### TV - -> **TV**: `72` - -Defined in: [constants/commonVision.ts:82](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L82) - ---- - -### UMBRELLA - -> **UMBRELLA**: `28` - -Defined in: [constants/commonVision.ts:39](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L39) - ---- - -### VASE - -> **VASE**: `86` - -Defined in: [constants/commonVision.ts:96](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L96) - ---- - -### WINDOW - -> **WINDOW**: `68` - -Defined in: [constants/commonVision.ts:78](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L78) - ---- - -### WINE_GLASS - -> **WINE_GLASS**: `46` - -Defined in: [constants/commonVision.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L56) - ---- - -### ZEBRA - -> **ZEBRA**: `24` - -Defined in: [constants/commonVision.ts:35](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L35) diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md deleted file mode 100644 index 7fc8ec2c2d..0000000000 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ /dev/null @@ -1,173 +0,0 @@ -# Enumeration: DeeplabLabel - -Defined in: [types/semanticSegmentation.ts:70](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L70) - -Labels used in the DeepLab semantic segmentation model. - -## Enumeration Members - -### AEROPLANE - -> **AEROPLANE**: `1` - -Defined in: [types/semanticSegmentation.ts:72](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L72) - ---- - -### BACKGROUND - -> **BACKGROUND**: `0` - -Defined in: [types/semanticSegmentation.ts:71](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L71) - ---- - -### BICYCLE - -> **BICYCLE**: `2` - -Defined in: [types/semanticSegmentation.ts:73](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L73) - ---- - -### BIRD - -> **BIRD**: `3` - -Defined in: [types/semanticSegmentation.ts:74](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L74) - ---- - -### BOAT - -> **BOAT**: `4` - -Defined in: [types/semanticSegmentation.ts:75](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L75) - ---- - -### BOTTLE - -> **BOTTLE**: `5` - -Defined in: [types/semanticSegmentation.ts:76](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L76) - ---- - -### BUS - -> **BUS**: `6` - -Defined in: [types/semanticSegmentation.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L77) - ---- - -### CAR - -> **CAR**: `7` - -Defined in: [types/semanticSegmentation.ts:78](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L78) - ---- - -### CAT - -> **CAT**: `8` - -Defined in: [types/semanticSegmentation.ts:79](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L79) - ---- - -### CHAIR - -> **CHAIR**: `9` - -Defined in: [types/semanticSegmentation.ts:80](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L80) - ---- - -### COW - -> **COW**: `10` - -Defined in: [types/semanticSegmentation.ts:81](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L81) - ---- - -### DININGTABLE - -> **DININGTABLE**: `11` - -Defined in: [types/semanticSegmentation.ts:82](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L82) - ---- - -### DOG - -> **DOG**: `12` - -Defined in: [types/semanticSegmentation.ts:83](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L83) - ---- - -### HORSE - -> **HORSE**: `13` - -Defined in: [types/semanticSegmentation.ts:84](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L84) - ---- - -### MOTORBIKE - -> **MOTORBIKE**: `14` - -Defined in: [types/semanticSegmentation.ts:85](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L85) - ---- - -### PERSON - -> **PERSON**: `15` - -Defined in: [types/semanticSegmentation.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L86) - ---- - -### POTTEDPLANT - -> **POTTEDPLANT**: `16` - -Defined in: [types/semanticSegmentation.ts:87](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L87) - ---- - -### SHEEP - -> **SHEEP**: `17` - -Defined in: [types/semanticSegmentation.ts:88](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L88) - ---- - -### SOFA - -> **SOFA**: `18` - -Defined in: [types/semanticSegmentation.ts:89](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L89) - ---- - -### TRAIN - -> **TRAIN**: `19` - -Defined in: [types/semanticSegmentation.ts:90](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L90) - ---- - -### TVMONITOR - -> **TVMONITOR**: `20` - -Defined in: [types/semanticSegmentation.ts:91](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L91) diff --git a/docs/docs/06-api-reference/enumerations/DownloadStatus.md b/docs/docs/06-api-reference/enumerations/DownloadStatus.md deleted file mode 100644 index 0bc7add107..0000000000 --- a/docs/docs/06-api-reference/enumerations/DownloadStatus.md +++ /dev/null @@ -1,25 +0,0 @@ -# Enumeration: DownloadStatus - -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. - -## Enumeration Members - -### ONGOING - -> **ONGOING**: `0` - -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. - ---- - -### PAUSED - -> **PAUSED**: `1` - -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 deleted file mode 100644 index 213a2ba898..0000000000 --- a/docs/docs/06-api-reference/enumerations/HTTP_CODE.md +++ /dev/null @@ -1,25 +0,0 @@ -# Enumeration: HTTP_CODE - -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 - -## Enumeration Members - -### OK - -> **OK**: `200` - -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. - ---- - -### PARTIAL_CONTENT - -> **PARTIAL_CONTENT**: `206` - -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 deleted file mode 100644 index 8af6a41a0b..0000000000 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ /dev/null @@ -1,453 +0,0 @@ -# Enumeration: RnExecutorchErrorCode - -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 - -### AccessFailed - -> **AccessFailed**: `34` - -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) - -Could not access a resource. - ---- - -### DelegateInvalidCompatibility - -> **DelegateInvalidCompatibility**: `48` - -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 receives an incompatible delegate version. - ---- - -### DelegateInvalidHandle - -> **DelegateInvalidHandle**: `50` - -Defined in: [errors/ErrorCodes.ts:184](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/errors/ErrorCodes.ts#L184) - -Execute stage: The handle is invalid. - ---- - -### DelegateMemoryAllocationFailed - -> **DelegateMemoryAllocationFailed**: `49` - -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) - -Init stage: Backend fails to allocate memory. - ---- - -### DownloadInterrupted - -> **DownloadInterrupted**: `118` - -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. - ---- - -### EndOfMethod - -> **EndOfMethod**: `3` - -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) - -Status indicating there are no more steps of execution to run - ---- - -### FileReadFailed - -> **FileReadFailed**: `114` - -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. - ---- - -### FileWriteFailed - -> **FileWriteFailed**: `103` - -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. - ---- - -### Internal - -> **Internal**: `1` - -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) - -An internal error occurred. - ---- - -### InvalidArgument - -> **InvalidArgument**: `18` - -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) - -User provided an invalid argument. - ---- - -### InvalidConfig - -> **InvalidConfig**: `112` - -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]. - ---- - -### InvalidExternalData - -> **InvalidExternalData**: `36` - -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) - -Error caused by the contents of external data. - ---- - -### InvalidModelOutput - -> **InvalidModelOutput**: `115` - -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. - ---- - -### InvalidModelSource - -> **InvalidModelSource**: `255` - -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. - ---- - -### InvalidProgram - -> **InvalidProgram**: `35` - -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 a program. - ---- - -### InvalidState - -> **InvalidState**: `2` - -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 the executor is in an invalid state for a targeted operation. - ---- - -### InvalidType - -> **InvalidType**: `19` - -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) - -Object is an invalid type for the operation. - ---- - -### InvalidUserInput - -> **InvalidUserInput**: `117` - -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(). - ---- - -### LanguageNotSupported - -> **LanguageNotSupported**: `105` - -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. - ---- - -### MemoryAllocationFailed - -> **MemoryAllocationFailed**: `33` - -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 allocate the requested memory. - ---- - -### MissingDataChunk - -> **MissingDataChunk**: `161` - -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 streaming transcription is attempted but audio data chunk is missing. - ---- - -### ModelGenerating - -> **ModelGenerating**: `104` - -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. - ---- - -### ModuleNotLoaded - -> **ModuleNotLoaded**: `102` - -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. - ---- - -### MultilingualConfiguration - -> **MultilingualConfiguration**: `160` - -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 there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. - ---- - -### NotFound - -> **NotFound**: `32` - -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) - -Requested resource could not be found. - ---- - -### NotImplemented - -> **NotImplemented**: `17` - -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) - -Operation is not yet implemented. - ---- - -### NotSupported - -> **NotSupported**: `16` - -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 supported in the current context. - ---- - -### Ok - -> **Ok**: `0` - -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) - -Status indicating a successful operation. - ---- - -### OperatorMissing - -> **OperatorMissing**: `20` - -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) - -Operator(s) missing in the operator registry. - ---- - -### OutOfResources - -> **OutOfResources**: `37` - -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) - -Does not have enough resources to perform the requested operation. - ---- - -### PlatformNotSupported - -> **PlatformNotSupported**: `119` - -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 a feature or platform is not supported in the current environment. - ---- - -### ResourceFetcherAdapterNotInitialized - -> **ResourceFetcherAdapterNotInitialized**: `186` - -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) - -Thrown when trying to load resources without fetcher initialization. - ---- - -### ResourceFetcherAlreadyOngoing - -> **ResourceFetcherAlreadyOngoing**: `183` - -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 resume a download that is already ongoing. - ---- - -### ResourceFetcherAlreadyPaused - -> **ResourceFetcherAlreadyPaused**: `182` - -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 pause a download that is already paused. - ---- - -### ResourceFetcherDownloadFailed - -> **ResourceFetcherDownloadFailed**: `180` - -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 resource fails to download. This could be due to invalid URL, or for example a network problem. - ---- - -### ResourceFetcherDownloadInProgress - -> **ResourceFetcherDownloadInProgress**: `181` - -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 a user tries to trigger a download that's already in progress. - ---- - -### ResourceFetcherMissingUri - -> **ResourceFetcherMissingUri**: `185` - -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 required URI information is missing for a download operation. - ---- - -### ResourceFetcherNotActive - -> **ResourceFetcherNotActive**: `184` - -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 trying to pause, resume, or cancel a download that is not active. - ---- - -### StreamingInProgress - -> **StreamingInProgress**: `163` - -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 trying to start a new streaming session while another is already in progress. - ---- - -### StreamingNotStarted - -> **StreamingNotStarted**: `162` - -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 stop or insert data into a stream that hasn't been started. - ---- - -### ThreadPoolError - -> **ThreadPoolError**: `113` - -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. - ---- - -### TokenizerError - -> **TokenizerError**: `167` - -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 an error occurs with the tokenizer or tokenization process. - ---- - -### UnexpectedNumInputs - -> **UnexpectedNumInputs**: `97` - -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. - ---- - -### UnknownError - -> **UnknownError**: `101` - -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. - ---- - -### WrongDimensions - -> **WrongDimensions**: `116` - -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 deleted file mode 100644 index bcd1869e08..0000000000 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ /dev/null @@ -1,225 +0,0 @@ -# Enumeration: ScalarType - -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. - -## Enumeration Members - -### BITS16 - -> **BITS16**: `22` - -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. - ---- - -### BOOL - -> **BOOL**: `11` - -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. - ---- - -### BYTE - -> **BYTE**: `0` - -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). - ---- - -### CHAR - -> **CHAR**: `1` - -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). - ---- - -### DOUBLE - -> **DOUBLE**: `7` - -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). - ---- - -### FLOAT - -> **FLOAT**: `6` - -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). - ---- - -### FLOAT8E4M3FN - -> **FLOAT8E4M3FN**: `24` - -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. - ---- - -### FLOAT8E4M3FNUZ - -> **FLOAT8E4M3FNUZ**: `26` - -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. - ---- - -### FLOAT8E5M2 - -> **FLOAT8E5M2**: `23` - -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. - ---- - -### FLOAT8E5M2FNUZ - -> **FLOAT8E5M2FNUZ**: `25` - -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. - ---- - -### HALF - -> **HALF**: `5` - -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). - ---- - -### INT - -> **INT**: `3` - -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). - ---- - -### LONG - -> **LONG**: `4` - -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). - ---- - -### QINT32 - -> **QINT32**: `14` - -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. - ---- - -### QINT8 - -> **QINT8**: `12` - -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. - ---- - -### QUINT2X4 - -> **QUINT2X4**: `17` - -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). - ---- - -### QUINT4X2 - -> **QUINT4X2**: `16` - -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). - ---- - -### QUINT8 - -> **QUINT8**: `13` - -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. - ---- - -### SHORT - -> **SHORT**: `2` - -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). - ---- - -### UINT16 - -> **UINT16**: `27` - -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. - ---- - -### UINT32 - -> **UINT32**: `28` - -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. - ---- - -### UINT64 - -> **UINT64**: `29` - -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 deleted file mode 100644 index fc04345125..0000000000 --- a/docs/docs/06-api-reference/enumerations/SelfieSegmentationLabel.md +++ /dev/null @@ -1,21 +0,0 @@ -# Enumeration: SelfieSegmentationLabel - -Defined in: [types/semanticSegmentation.ts:99](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L99) - -Labels used in the selfie semantic segmentation model. - -## Enumeration Members - -### BACKGROUND - -> **BACKGROUND**: `1` - -Defined in: [types/semanticSegmentation.ts:101](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L101) - ---- - -### SELFIE - -> **SELFIE**: `0` - -Defined in: [types/semanticSegmentation.ts:100](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L100) diff --git a/docs/docs/06-api-reference/enumerations/SourceType.md b/docs/docs/06-api-reference/enumerations/SourceType.md deleted file mode 100644 index 97308c82cc..0000000000 --- a/docs/docs/06-api-reference/enumerations/SourceType.md +++ /dev/null @@ -1,55 +0,0 @@ -# Enumeration: SourceType - -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 - -## Enumeration Members - -### DEV_MODE_FILE - -> **DEV_MODE_FILE**: `3` - -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. - ---- - -### LOCAL_FILE - -> **LOCAL_FILE**: `1` - -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. - ---- - -### OBJECT - -> **OBJECT**: `0` - -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. - ---- - -### RELEASE_MODE_FILE - -> **RELEASE_MODE_FILE**: `2` - -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. - ---- - -### REMOTE_FILE - -> **REMOTE_FILE**: `4` - -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 deleted file mode 100644 index 33c0ddb967..0000000000 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: DEFAULT_STRUCTURED_OUTPUT_PROMPT() - -> **DEFAULT_STRUCTURED_OUTPUT_PROMPT**(`structuredOutputSchema`): `string` - -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. - -## Parameters - -### structuredOutputSchema - -`string` - -A string representing the JSON schema for the desired output format. - -## Returns - -`string` - -A prompt string instructing the model to format its output according to the given schema. diff --git a/docs/docs/06-api-reference/functions/cleanupExecutorch.md b/docs/docs/06-api-reference/functions/cleanupExecutorch.md deleted file mode 100644 index 6a971e98ac..0000000000 --- a/docs/docs/06-api-reference/functions/cleanupExecutorch.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: cleanupExecutorch() - -> **cleanupExecutorch**(): `void` - -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. - -## Returns - -`void` diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md deleted file mode 100644 index 10ffeda0cb..0000000000 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ /dev/null @@ -1,33 +0,0 @@ -# Function: fixAndValidateStructuredOutput() - -> **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> - -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. - -## Type Parameters - -### T - -`T` _extends_ `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> - -## Parameters - -### output - -`string` - -The raw output string from the LLM. - -### responseSchema - -The schema (Zod or JSON Schema) to validate the output against. - -`Schema` | `T` - -## Returns - -`output`\<`T`\> - -The validated and parsed output. diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md deleted file mode 100644 index 6d8b0fba68..0000000000 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ /dev/null @@ -1,27 +0,0 @@ -# Function: getStructuredOutputPrompt() - -> **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` - -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. - -## Type Parameters - -### T - -`T` _extends_ `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> - -## Parameters - -### responseSchema - -The schema (Zod or JSON Schema) defining the desired output format. - -`T` | `Schema` - -## Returns - -`string` - -A prompt string instructing the model to format its output according to the given schema. diff --git a/docs/docs/06-api-reference/functions/initExecutorch.md b/docs/docs/06-api-reference/functions/initExecutorch.md deleted file mode 100644 index 3dec5e8c27..0000000000 --- a/docs/docs/06-api-reference/functions/initExecutorch.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: initExecutorch() - -> **initExecutorch**(`config`): `void` - -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. - -## Parameters - -### config - -[`ExecutorchConfig`](../interfaces/ExecutorchConfig.md) - -Configuration that you want to use in resource fetching. - -## Returns - -`void` diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md deleted file mode 100644 index 20f882cc23..0000000000 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useClassification() - -> **useClassification**(`ClassificationProps`): [`ClassificationType`](../interfaces/ClassificationType.md) - -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. - -## Parameters - -### ClassificationProps - -[`ClassificationProps`](../interfaces/ClassificationProps.md) - -Configuration object containing `model` source and optional `preventLoad` flag. - -## Returns - -[`ClassificationType`](../interfaces/ClassificationType.md) - -Ready to use Classification model. diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md deleted file mode 100644 index 5e6b54ffea..0000000000 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useExecutorchModule() - -> **useExecutorchModule**(`executorchModuleProps`): [`ExecutorchModuleType`](../interfaces/ExecutorchModuleType.md) - -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. - -## Parameters - -### executorchModuleProps - -[`ExecutorchModuleProps`](../interfaces/ExecutorchModuleProps.md) - -Configuration object containing `modelSource` and optional `preventLoad` flag. - -## Returns - -[`ExecutorchModuleType`](../interfaces/ExecutorchModuleType.md) - -Ready to use Executorch module. diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md deleted file mode 100644 index e0dcea7397..0000000000 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useImageEmbeddings() - -> **useImageEmbeddings**(`ImageEmbeddingsProps`): [`ImageEmbeddingsType`](../interfaces/ImageEmbeddingsType.md) - -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. - -## Parameters - -### ImageEmbeddingsProps - -[`ImageEmbeddingsProps`](../interfaces/ImageEmbeddingsProps.md) - -Configuration object containing `model` source and optional `preventLoad` flag. - -## Returns - -[`ImageEmbeddingsType`](../interfaces/ImageEmbeddingsType.md) - -Ready to use Image Embeddings model. diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md deleted file mode 100644 index f62640d900..0000000000 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useLLM() - -> **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) - -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. - -## Parameters - -### model - -[`LLMProps`](../interfaces/LLMProps.md) - -Object containing model, tokenizer, and tokenizer config sources. - -## Returns - -[`LLMType`](../interfaces/LLMType.md) - -An object implementing the `LLMType` interface for interacting with the LLM. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md deleted file mode 100644 index 3ebe2e2c95..0000000000 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useOCR() - -> **useOCR**(`OCRProps`): [`OCRType`](../interfaces/OCRType.md) - -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. - -## Parameters - -### OCRProps - -[`OCRProps`](../interfaces/OCRProps.md) - -Configuration object containing `model` sources and optional `preventLoad` flag. - -## Returns - -[`OCRType`](../interfaces/OCRType.md) - -Ready to use OCR model. diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md deleted file mode 100644 index 7ed5817607..0000000000 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ /dev/null @@ -1,29 +0,0 @@ -# Function: useObjectDetection() - -> **useObjectDetection**\<`C`\>(`props`): [`ObjectDetectionType`](../interfaces/ObjectDetectionType.md)\<[`ObjectDetectionLabels`](../type-aliases/ObjectDetectionLabels.md)\<`C`\[`"modelName"`\]\>\> - -Defined in: [hooks/computer_vision/useObjectDetection.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L22) - -React hook for managing an Object Detection model instance. - -## Type Parameters - -### C - -`C` _extends_ [`ObjectDetectionModelSources`](../type-aliases/ObjectDetectionModelSources.md) - -A [ObjectDetectionModelSources](../type-aliases/ObjectDetectionModelSources.md) config specifying which built-in model to load. - -## Parameters - -### props - -[`ObjectDetectionProps`](../interfaces/ObjectDetectionProps.md)\<`C`\> - -Configuration object containing `model` config and optional `preventLoad` flag. - -## Returns - -[`ObjectDetectionType`](../interfaces/ObjectDetectionType.md)\<[`ObjectDetectionLabels`](../type-aliases/ObjectDetectionLabels.md)\<`C`\[`"modelName"`\]\>\> - -An object with model state (`error`, `isReady`, `isGenerating`, `downloadProgress`) and typed `forward` and `runOnFrame` functions. diff --git a/docs/docs/06-api-reference/functions/useSemanticSegmentation.md b/docs/docs/06-api-reference/functions/useSemanticSegmentation.md deleted file mode 100644 index ee260c7f16..0000000000 --- a/docs/docs/06-api-reference/functions/useSemanticSegmentation.md +++ /dev/null @@ -1,37 +0,0 @@ -# Function: useSemanticSegmentation() - -> **useSemanticSegmentation**\<`C`\>(`props`): [`SemanticSegmentationType`](../interfaces/SemanticSegmentationType.md)\<[`SegmentationLabels`](../type-aliases/SegmentationLabels.md)\<[`ModelNameOf`](../type-aliases/ModelNameOf.md)\<`C`\>\>\> - -Defined in: [hooks/computer_vision/useSemanticSegmentation.ts:29](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/computer_vision/useSemanticSegmentation.ts#L29) - -React hook for managing a Semantic Segmentation model instance. - -## Type Parameters - -### C - -`C` _extends_ [`SemanticSegmentationModelSources`](../type-aliases/SemanticSegmentationModelSources.md) - -A [SemanticSegmentationModelSources](../type-aliases/SemanticSegmentationModelSources.md) config specifying which built-in model to load. - -## Parameters - -### props - -[`SemanticSegmentationProps`](../interfaces/SemanticSegmentationProps.md)\<`C`\> - -Configuration object containing `model` config and optional `preventLoad` flag. - -## Returns - -[`SemanticSegmentationType`](../interfaces/SemanticSegmentationType.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 - -```ts -const { isReady, forward } = useSemanticSegmentation({ - model: { modelName: 'deeplab-v3', modelSource: DEEPLAB_V3_RESNET50 }, -}); -``` diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md deleted file mode 100644 index 3eff9a1c3d..0000000000 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useSpeechToText() - -> **useSpeechToText**(`speechToTextProps`): [`SpeechToTextType`](../interfaces/SpeechToTextType.md) - -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. - -## Parameters - -### speechToTextProps - -[`SpeechToTextProps`](../interfaces/SpeechToTextProps.md) - -Configuration object containing `model` source and optional `preventLoad` flag. - -## Returns - -[`SpeechToTextType`](../interfaces/SpeechToTextType.md) - -Ready to use Speech to Text model. diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md deleted file mode 100644 index c312d8310e..0000000000 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useStyleTransfer() - -> **useStyleTransfer**(`StyleTransferProps`): [`StyleTransferType`](../interfaces/StyleTransferType.md) - -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. - -## Parameters - -### StyleTransferProps - -[`StyleTransferProps`](../interfaces/StyleTransferProps.md) - -Configuration object containing `model` source and optional `preventLoad` flag. - -## Returns - -[`StyleTransferType`](../interfaces/StyleTransferType.md) - -Ready to use Style Transfer model. diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md deleted file mode 100644 index d693af6773..0000000000 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useTextEmbeddings() - -> **useTextEmbeddings**(`TextEmbeddingsProps`): [`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) - -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. - -## Parameters - -### TextEmbeddingsProps - -[`TextEmbeddingsProps`](../interfaces/TextEmbeddingsProps.md) - -Configuration object containing `model` source and optional `preventLoad` flag. - -## Returns - -[`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) - -Ready to use Text Embeddings model. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md deleted file mode 100644 index 1faf63005a..0000000000 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useTextToImage() - -> **useTextToImage**(`TextToImageProps`): [`TextToImageType`](../interfaces/TextToImageType.md) - -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. - -## Parameters - -### TextToImageProps - -[`TextToImageProps`](../interfaces/TextToImageProps.md) - -Configuration object containing `model` source, `inferenceCallback`, and optional `preventLoad` flag. - -## Returns - -[`TextToImageType`](../interfaces/TextToImageType.md) - -Ready to use Text to Image model. diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md deleted file mode 100644 index 2571d91a50..0000000000 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useTextToSpeech() - -> **useTextToSpeech**(`TextToSpeechProps`): [`TextToSpeechType`](../interfaces/TextToSpeechType.md) - -Defined in: [hooks/natural_language_processing/useTextToSpeech.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L22) - -React hook for managing Text to Speech instance. - -## Parameters - -### TextToSpeechProps - -[`TextToSpeechProps`](../interfaces/TextToSpeechProps.md) - -Configuration object containing `model` source, `voice` and optional `preventLoad`. - -## Returns - -[`TextToSpeechType`](../interfaces/TextToSpeechType.md) - -Ready to use Text to Speech model. diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md deleted file mode 100644 index cf8dc784e6..0000000000 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useTokenizer() - -> **useTokenizer**(`tokenizerProps`): [`TokenizerType`](../interfaces/TokenizerType.md) - -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. - -## Parameters - -### tokenizerProps - -[`TokenizerProps`](../interfaces/TokenizerProps.md) - -Configuration object containing `tokenizer` source and optional `preventLoad` flag. - -## Returns - -[`TokenizerType`](../interfaces/TokenizerType.md) - -Ready to use Tokenizer model. diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md deleted file mode 100644 index eda7a330a9..0000000000 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useVAD() - -> **useVAD**(`VADProps`): [`VADType`](../interfaces/VADType.md) - -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. - -## Parameters - -### VADProps - -[`VADProps`](../interfaces/VADProps.md) - -Configuration object containing `model` source and optional `preventLoad` flag. - -## Returns - -[`VADType`](../interfaces/VADType.md) - -Ready to use VAD model. diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md deleted file mode 100644 index 36c765214a..0000000000 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: useVerticalOCR() - -> **useVerticalOCR**(`VerticalOCRProps`): [`OCRType`](../interfaces/OCRType.md) - -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. - -## Parameters - -### VerticalOCRProps - -[`VerticalOCRProps`](../interfaces/VerticalOCRProps.md) - -Configuration object containing `model` sources, optional `independentCharacters` and `preventLoad` flag. - -## Returns - -[`OCRType`](../interfaces/OCRType.md) - -Ready to use Vertical OCR model. diff --git a/docs/docs/06-api-reference/index.md b/docs/docs/06-api-reference/index.md deleted file mode 100644 index 967ab2af99..0000000000 --- a/docs/docs/06-api-reference/index.md +++ /dev/null @@ -1,344 +0,0 @@ -# react-native-executorch - -## Hooks - -- [useClassification](functions/useClassification.md) -- [useExecutorchModule](functions/useExecutorchModule.md) -- [useImageEmbeddings](functions/useImageEmbeddings.md) -- [useLLM](functions/useLLM.md) -- [useObjectDetection](functions/useObjectDetection.md) -- [useOCR](functions/useOCR.md) -- [useSemanticSegmentation](functions/useSemanticSegmentation.md) -- [useSpeechToText](functions/useSpeechToText.md) -- [useStyleTransfer](functions/useStyleTransfer.md) -- [useTextEmbeddings](functions/useTextEmbeddings.md) -- [useTextToImage](functions/useTextToImage.md) -- [useTextToSpeech](functions/useTextToSpeech.md) -- [useTokenizer](functions/useTokenizer.md) -- [useVAD](functions/useVAD.md) -- [useVerticalOCR](functions/useVerticalOCR.md) - -## Interfaces - -- [ResourceSourceExtended](interfaces/ResourceSourceExtended.md) - -## Models - Classification - -- [EFFICIENTNET_V2_S](variables/EFFICIENTNET_V2_S.md) - -## Models - Image Embeddings - -- [CLIP_VIT_BASE_PATCH32_IMAGE](variables/CLIP_VIT_BASE_PATCH32_IMAGE.md) - -## Models - Image Generation - -- [BK_SDM_TINY_VPRED_256](variables/BK_SDM_TINY_VPRED_256.md) -- [BK_SDM_TINY_VPRED_512](variables/BK_SDM_TINY_VPRED_512.md) - -## Models - LMM - -- [HAMMER2_1_0_5B](variables/HAMMER2_1_0_5B.md) -- [HAMMER2_1_0_5B_QUANTIZED](variables/HAMMER2_1_0_5B_QUANTIZED.md) -- [HAMMER2_1_1_5B](variables/HAMMER2_1_1_5B.md) -- [HAMMER2_1_1_5B_QUANTIZED](variables/HAMMER2_1_1_5B_QUANTIZED.md) -- [HAMMER2_1_3B](variables/HAMMER2_1_3B.md) -- [HAMMER2_1_3B_QUANTIZED](variables/HAMMER2_1_3B_QUANTIZED.md) -- [LFM2_5_1_2B_INSTRUCT](variables/LFM2_5_1_2B_INSTRUCT.md) -- [LFM2_5_1_2B_INSTRUCT_QUANTIZED](variables/LFM2_5_1_2B_INSTRUCT_QUANTIZED.md) -- [LLAMA3_2_1B](variables/LLAMA3_2_1B.md) -- [LLAMA3_2_1B_QLORA](variables/LLAMA3_2_1B_QLORA.md) -- [LLAMA3_2_1B_SPINQUANT](variables/LLAMA3_2_1B_SPINQUANT.md) -- [LLAMA3_2_3B](variables/LLAMA3_2_3B.md) -- [LLAMA3_2_3B_QLORA](variables/LLAMA3_2_3B_QLORA.md) -- [LLAMA3_2_3B_SPINQUANT](variables/LLAMA3_2_3B_SPINQUANT.md) -- [PHI_4_MINI_4B](variables/PHI_4_MINI_4B.md) -- [PHI_4_MINI_4B_QUANTIZED](variables/PHI_4_MINI_4B_QUANTIZED.md) -- [QWEN2_5_0_5B](variables/QWEN2_5_0_5B.md) -- [QWEN2_5_0_5B_QUANTIZED](variables/QWEN2_5_0_5B_QUANTIZED.md) -- [QWEN2_5_1_5B](variables/QWEN2_5_1_5B.md) -- [QWEN2_5_1_5B_QUANTIZED](variables/QWEN2_5_1_5B_QUANTIZED.md) -- [QWEN2_5_3B](variables/QWEN2_5_3B.md) -- [QWEN2_5_3B_QUANTIZED](variables/QWEN2_5_3B_QUANTIZED.md) -- [QWEN3_0_6B](variables/QWEN3_0_6B.md) -- [QWEN3_0_6B_QUANTIZED](variables/QWEN3_0_6B_QUANTIZED.md) -- [QWEN3_1_7B](variables/QWEN3_1_7B.md) -- [QWEN3_1_7B_QUANTIZED](variables/QWEN3_1_7B_QUANTIZED.md) -- [QWEN3_4B](variables/QWEN3_4B.md) -- [QWEN3_4B_QUANTIZED](variables/QWEN3_4B_QUANTIZED.md) -- [SMOLLM2_1_1_7B](variables/SMOLLM2_1_1_7B.md) -- [SMOLLM2_1_1_7B_QUANTIZED](variables/SMOLLM2_1_1_7B_QUANTIZED.md) -- [SMOLLM2_1_135M](variables/SMOLLM2_1_135M.md) -- [SMOLLM2_1_135M_QUANTIZED](variables/SMOLLM2_1_135M_QUANTIZED.md) -- [SMOLLM2_1_360M](variables/SMOLLM2_1_360M.md) -- [SMOLLM2_1_360M_QUANTIZED](variables/SMOLLM2_1_360M_QUANTIZED.md) - -## Models - Object Detection - -- [RF_DETR_NANO](variables/RF_DETR_NANO.md) -- [SSDLITE_320_MOBILENET_V3_LARGE](variables/SSDLITE_320_MOBILENET_V3_LARGE.md) - -## Models - Semantic Segmentation - -- [DEEPLAB_V3_MOBILENET_V3_LARGE](variables/DEEPLAB_V3_MOBILENET_V3_LARGE.md) -- [DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED](variables/DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED.md) -- [DEEPLAB_V3_RESNET101](variables/DEEPLAB_V3_RESNET101.md) -- [DEEPLAB_V3_RESNET101_QUANTIZED](variables/DEEPLAB_V3_RESNET101_QUANTIZED.md) -- [DEEPLAB_V3_RESNET50](variables/DEEPLAB_V3_RESNET50.md) -- [DEEPLAB_V3_RESNET50_QUANTIZED](variables/DEEPLAB_V3_RESNET50_QUANTIZED.md) -- [FCN_RESNET101](variables/FCN_RESNET101.md) -- [FCN_RESNET101_QUANTIZED](variables/FCN_RESNET101_QUANTIZED.md) -- [FCN_RESNET50](variables/FCN_RESNET50.md) -- [FCN_RESNET50_QUANTIZED](variables/FCN_RESNET50_QUANTIZED.md) -- [LRASPP_MOBILENET_V3_LARGE](variables/LRASPP_MOBILENET_V3_LARGE.md) -- [LRASPP_MOBILENET_V3_LARGE_QUANTIZED](variables/LRASPP_MOBILENET_V3_LARGE_QUANTIZED.md) -- [SELFIE_SEGMENTATION](variables/SELFIE_SEGMENTATION.md) - -## Models - Speech To Text - -- [WHISPER_BASE](variables/WHISPER_BASE.md) -- [WHISPER_BASE_EN](variables/WHISPER_BASE_EN.md) -- [WHISPER_SMALL](variables/WHISPER_SMALL.md) -- [WHISPER_SMALL_EN](variables/WHISPER_SMALL_EN.md) -- [WHISPER_TINY](variables/WHISPER_TINY.md) -- [WHISPER_TINY_EN](variables/WHISPER_TINY_EN.md) -- [WHISPER_TINY_EN_QUANTIZED](variables/WHISPER_TINY_EN_QUANTIZED.md) - -## Models - Style Transfer - -- [STYLE_TRANSFER_CANDY](variables/STYLE_TRANSFER_CANDY.md) -- [STYLE_TRANSFER_MOSAIC](variables/STYLE_TRANSFER_MOSAIC.md) -- [STYLE_TRANSFER_RAIN_PRINCESS](variables/STYLE_TRANSFER_RAIN_PRINCESS.md) -- [STYLE_TRANSFER_UDNIE](variables/STYLE_TRANSFER_UDNIE.md) - -## Models - Text Embeddings - -- [ALL_MINILM_L6_V2](variables/ALL_MINILM_L6_V2.md) -- [ALL_MPNET_BASE_V2](variables/ALL_MPNET_BASE_V2.md) -- [CLIP_VIT_BASE_PATCH32_TEXT](variables/CLIP_VIT_BASE_PATCH32_TEXT.md) -- [MULTI_QA_MINILM_L6_COS_V1](variables/MULTI_QA_MINILM_L6_COS_V1.md) -- [MULTI_QA_MPNET_BASE_DOT_V1](variables/MULTI_QA_MPNET_BASE_DOT_V1.md) - -## Models - Text to Speech - -- [KOKORO_MEDIUM](variables/KOKORO_MEDIUM.md) -- [KOKORO_SMALL](variables/KOKORO_SMALL.md) - -## Models - Voice Activity Detection - -- [FSMN_VAD](variables/FSMN_VAD.md) - -## OCR Supported Alphabets - -- [OCR_ABAZA](variables/OCR_ABAZA.md) -- [OCR_ADYGHE](variables/OCR_ADYGHE.md) -- [OCR_AFRIKAANS](variables/OCR_AFRIKAANS.md) -- [OCR_ALBANIAN](variables/OCR_ALBANIAN.md) -- [OCR_AVAR](variables/OCR_AVAR.md) -- [OCR_AZERBAIJANI](variables/OCR_AZERBAIJANI.md) -- [OCR_BELARUSIAN](variables/OCR_BELARUSIAN.md) -- [OCR_BOSNIAN](variables/OCR_BOSNIAN.md) -- [OCR_BULGARIAN](variables/OCR_BULGARIAN.md) -- [OCR_CHECHEN](variables/OCR_CHECHEN.md) -- [OCR_CROATIAN](variables/OCR_CROATIAN.md) -- [OCR_CZECH](variables/OCR_CZECH.md) -- [OCR_DANISH](variables/OCR_DANISH.md) -- [OCR_DARGWA](variables/OCR_DARGWA.md) -- [OCR_DUTCH](variables/OCR_DUTCH.md) -- [OCR_ENGLISH](variables/OCR_ENGLISH.md) -- [OCR_ESTONIAN](variables/OCR_ESTONIAN.md) -- [OCR_FRENCH](variables/OCR_FRENCH.md) -- [OCR_GERMAN](variables/OCR_GERMAN.md) -- [OCR_HUNGARIAN](variables/OCR_HUNGARIAN.md) -- [OCR_ICELANDIC](variables/OCR_ICELANDIC.md) -- [OCR_INDONESIAN](variables/OCR_INDONESIAN.md) -- [OCR_INGUSH](variables/OCR_INGUSH.md) -- [OCR_IRISH](variables/OCR_IRISH.md) -- [OCR_ITALIAN](variables/OCR_ITALIAN.md) -- [OCR_JAPANESE](variables/OCR_JAPANESE.md) -- [OCR_KANNADA](variables/OCR_KANNADA.md) -- [OCR_KARBADIAN](variables/OCR_KARBADIAN.md) -- [OCR_KOREAN](variables/OCR_KOREAN.md) -- [OCR_KURDISH](variables/OCR_KURDISH.md) -- [OCR_LAK](variables/OCR_LAK.md) -- [OCR_LATIN](variables/OCR_LATIN.md) -- [OCR_LATVIAN](variables/OCR_LATVIAN.md) -- [OCR_LEZGHIAN](variables/OCR_LEZGHIAN.md) -- [OCR_LITHUANIAN](variables/OCR_LITHUANIAN.md) -- [OCR_MALAY](variables/OCR_MALAY.md) -- [OCR_MALTESE](variables/OCR_MALTESE.md) -- [OCR_MAORI](variables/OCR_MAORI.md) -- [OCR_MONGOLIAN](variables/OCR_MONGOLIAN.md) -- [OCR_NORWEGIAN](variables/OCR_NORWEGIAN.md) -- [OCR_OCCITAN](variables/OCR_OCCITAN.md) -- [OCR_PALI](variables/OCR_PALI.md) -- [OCR_POLISH](variables/OCR_POLISH.md) -- [OCR_PORTUGUESE](variables/OCR_PORTUGUESE.md) -- [OCR_ROMANIAN](variables/OCR_ROMANIAN.md) -- [OCR_RUSSIAN](variables/OCR_RUSSIAN.md) -- [OCR_SERBIAN_CYRILLIC](variables/OCR_SERBIAN_CYRILLIC.md) -- [OCR_SERBIAN_LATIN](variables/OCR_SERBIAN_LATIN.md) -- [OCR_SIMPLIFIED_CHINESE](variables/OCR_SIMPLIFIED_CHINESE.md) -- [OCR_SLOVAK](variables/OCR_SLOVAK.md) -- [OCR_SLOVENIAN](variables/OCR_SLOVENIAN.md) -- [OCR_SPANISH](variables/OCR_SPANISH.md) -- [OCR_SWAHILI](variables/OCR_SWAHILI.md) -- [OCR_SWEDISH](variables/OCR_SWEDISH.md) -- [OCR_TABASSARAN](variables/OCR_TABASSARAN.md) -- [OCR_TAGALOG](variables/OCR_TAGALOG.md) -- [OCR_TAJIK](variables/OCR_TAJIK.md) -- [OCR_TELUGU](variables/OCR_TELUGU.md) -- [OCR_TURKISH](variables/OCR_TURKISH.md) -- [OCR_UKRAINIAN](variables/OCR_UKRAINIAN.md) -- [OCR_UZBEK](variables/OCR_UZBEK.md) -- [OCR_VIETNAMESE](variables/OCR_VIETNAMESE.md) -- [OCR_WELSH](variables/OCR_WELSH.md) - -## Other - -- [RnExecutorchErrorCode](enumerations/RnExecutorchErrorCode.md) -- [Logger](classes/Logger.md) -- [RnExecutorchError](classes/RnExecutorchError.md) -- [Frame](interfaces/Frame.md) -- [IMAGENET1K_MEAN](variables/IMAGENET1K_MEAN.md) -- [IMAGENET1K_STD](variables/IMAGENET1K_STD.md) - -## TTS Supported Voices - -- [KOKORO_VOICE_AF_HEART](variables/KOKORO_VOICE_AF_HEART.md) -- [KOKORO_VOICE_AF_RIVER](variables/KOKORO_VOICE_AF_RIVER.md) -- [KOKORO_VOICE_AF_SARAH](variables/KOKORO_VOICE_AF_SARAH.md) -- [KOKORO_VOICE_AM_ADAM](variables/KOKORO_VOICE_AM_ADAM.md) -- [KOKORO_VOICE_AM_MICHAEL](variables/KOKORO_VOICE_AM_MICHAEL.md) -- [KOKORO_VOICE_AM_SANTA](variables/KOKORO_VOICE_AM_SANTA.md) -- [KOKORO_VOICE_BF_EMMA](variables/KOKORO_VOICE_BF_EMMA.md) -- [KOKORO_VOICE_BM_DANIEL](variables/KOKORO_VOICE_BM_DANIEL.md) - -## Types - -- [CocoLabel](enumerations/CocoLabel.md) -- [DeeplabLabel](enumerations/DeeplabLabel.md) -- [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) -- [ClassificationProps](interfaces/ClassificationProps.md) -- [ClassificationType](interfaces/ClassificationType.md) -- [ContextStrategy](interfaces/ContextStrategy.md) -- [DecodingOptions](interfaces/DecodingOptions.md) -- [Detection](interfaces/Detection.md) -- [ExecutorchModuleProps](interfaces/ExecutorchModuleProps.md) -- [ExecutorchModuleType](interfaces/ExecutorchModuleType.md) -- [GenerationConfig](interfaces/GenerationConfig.md) -- [ImageEmbeddingsProps](interfaces/ImageEmbeddingsProps.md) -- [ImageEmbeddingsType](interfaces/ImageEmbeddingsType.md) -- [KokoroConfig](interfaces/KokoroConfig.md) -- [KokoroVoiceExtras](interfaces/KokoroVoiceExtras.md) -- [LLMConfig](interfaces/LLMConfig.md) -- [LLMProps](interfaces/LLMProps.md) -- [LLMType](interfaces/LLMType.md) -- [Message](interfaces/Message.md) -- [ObjectDetectionProps](interfaces/ObjectDetectionProps.md) -- [ObjectDetectionType](interfaces/ObjectDetectionType.md) -- [OCRDetection](interfaces/OCRDetection.md) -- [OCRProps](interfaces/OCRProps.md) -- [OCRType](interfaces/OCRType.md) -- [PixelData](interfaces/PixelData.md) -- [Point](interfaces/Point.md) -- [Segment](interfaces/Segment.md) -- [SemanticSegmentationProps](interfaces/SemanticSegmentationProps.md) -- [SemanticSegmentationType](interfaces/SemanticSegmentationType.md) -- [SpeechToTextModelConfig](interfaces/SpeechToTextModelConfig.md) -- [SpeechToTextProps](interfaces/SpeechToTextProps.md) -- [SpeechToTextType](interfaces/SpeechToTextType.md) -- [StyleTransferProps](interfaces/StyleTransferProps.md) -- [StyleTransferType](interfaces/StyleTransferType.md) -- [TensorPtr](interfaces/TensorPtr.md) -- [TextEmbeddingsProps](interfaces/TextEmbeddingsProps.md) -- [TextEmbeddingsType](interfaces/TextEmbeddingsType.md) -- [TextToImageProps](interfaces/TextToImageProps.md) -- [TextToImageType](interfaces/TextToImageType.md) -- [TextToSpeechConfig](interfaces/TextToSpeechConfig.md) -- [TextToSpeechInput](interfaces/TextToSpeechInput.md) -- [TextToSpeechPhonemeInput](interfaces/TextToSpeechPhonemeInput.md) -- [TextToSpeechProps](interfaces/TextToSpeechProps.md) -- [TextToSpeechStreamingCallbacks](interfaces/TextToSpeechStreamingCallbacks.md) -- [TextToSpeechStreamingInput](interfaces/TextToSpeechStreamingInput.md) -- [TextToSpeechStreamingPhonemeInput](interfaces/TextToSpeechStreamingPhonemeInput.md) -- [TextToSpeechType](interfaces/TextToSpeechType.md) -- [TokenizerProps](interfaces/TokenizerProps.md) -- [TokenizerType](interfaces/TokenizerType.md) -- [ToolCall](interfaces/ToolCall.md) -- [ToolsConfig](interfaces/ToolsConfig.md) -- [TranscriptionResult](interfaces/TranscriptionResult.md) -- [TranscriptionSegment](interfaces/TranscriptionSegment.md) -- [VADProps](interfaces/VADProps.md) -- [VADType](interfaces/VADType.md) -- [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) -- [ObjectDetectionConfig](type-aliases/ObjectDetectionConfig.md) -- [ObjectDetectionLabels](type-aliases/ObjectDetectionLabels.md) -- [ObjectDetectionModelName](type-aliases/ObjectDetectionModelName.md) -- [ObjectDetectionModelSources](type-aliases/ObjectDetectionModelSources.md) -- [OCRLanguage](type-aliases/OCRLanguage.md) -- [ResourceSource](type-aliases/ResourceSource.md) -- [SegmentationLabels](type-aliases/SegmentationLabels.md) -- [SemanticSegmentationConfig](type-aliases/SemanticSegmentationConfig.md) -- [SemanticSegmentationModelName](type-aliases/SemanticSegmentationModelName.md) -- [SemanticSegmentationModelSources](type-aliases/SemanticSegmentationModelSources.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 - -- [ClassificationModule](classes/ClassificationModule.md) -- [ExecutorchModule](classes/ExecutorchModule.md) -- [ImageEmbeddingsModule](classes/ImageEmbeddingsModule.md) -- [LLMModule](classes/LLMModule.md) -- [ObjectDetectionModule](classes/ObjectDetectionModule.md) -- [OCRModule](classes/OCRModule.md) -- [SemanticSegmentationModule](classes/SemanticSegmentationModule.md) -- [SpeechToTextModule](classes/SpeechToTextModule.md) -- [StyleTransferModule](classes/StyleTransferModule.md) -- [TextEmbeddingsModule](classes/TextEmbeddingsModule.md) -- [TextToImageModule](classes/TextToImageModule.md) -- [TextToSpeechModule](classes/TextToSpeechModule.md) -- [TokenizerModule](classes/TokenizerModule.md) -- [VADModule](classes/VADModule.md) -- [VerticalOCRModule](classes/VerticalOCRModule.md) - -## Utilities - General - -- [ResourceFetcherUtils](react-native-executorch/namespaces/ResourceFetcherUtils/index.md) -- [ResourceFetcher](classes/ResourceFetcher.md) -- [ExecutorchConfig](interfaces/ExecutorchConfig.md) -- [ResourceFetcherAdapter](interfaces/ResourceFetcherAdapter.md) -- [cleanupExecutorch](functions/cleanupExecutorch.md) -- [initExecutorch](functions/initExecutorch.md) - -## Utilities - LLM - -- [DEFAULT_CHAT_CONFIG](variables/DEFAULT_CHAT_CONFIG.md) -- [DEFAULT_CONTEXT_BUFFER_TOKENS](variables/DEFAULT_CONTEXT_BUFFER_TOKENS.md) -- [DEFAULT_MESSAGE_HISTORY](variables/DEFAULT_MESSAGE_HISTORY.md) -- [DEFAULT_SYSTEM_PROMPT](variables/DEFAULT_SYSTEM_PROMPT.md) -- [parseToolCall](variables/parseToolCall.md) -- [DEFAULT_STRUCTURED_OUTPUT_PROMPT](functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md) -- [fixAndValidateStructuredOutput](functions/fixAndValidateStructuredOutput.md) -- [getStructuredOutputPrompt](functions/getStructuredOutputPrompt.md) - -## Utils - -- [MessageCountContextStrategy](classes/MessageCountContextStrategy.md) -- [NoopContextStrategy](classes/NoopContextStrategy.md) -- [SlidingWindowContextStrategy](classes/SlidingWindowContextStrategy.md) diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md deleted file mode 100644 index 6eadedfb18..0000000000 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: Bbox - -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) - -Represents a bounding box for a detected object in an image. - -## Properties - -### x1 - -> **x1**: `number` - -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 x-coordinate of the bottom-left corner of the bounding box. - ---- - -### x2 - -> **x2**: `number` - -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 x-coordinate of the top-right corner of the bounding box. - ---- - -### y1 - -> **y1**: `number` - -Defined in: [types/objectDetection.ts:18](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L18) - -The y-coordinate of the bottom-left corner of the bounding box. - ---- - -### y2 - -> **y2**: `number` - -Defined in: [types/objectDetection.ts:19](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L19) - -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 deleted file mode 100644 index 1c4f07504f..0000000000 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: ChatConfig - -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. - -## Properties - -### contextStrategy - -> **contextStrategy**: [`ContextStrategy`](ContextStrategy.md) - -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. - ---- - -### initialMessageHistory - -> **initialMessageHistory**: [`Message`](Message.md)[] - -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. - ---- - -### systemPrompt - -> **systemPrompt**: `string` - -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 deleted file mode 100644 index 899c70f06c..0000000000 --- a/docs/docs/06-api-reference/interfaces/ClassificationProps.md +++ /dev/null @@ -1,29 +0,0 @@ -# Interface: ClassificationProps - -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. - -## Properties - -### model - -> **model**: `object` - -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. - -#### modelSource - -> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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 deleted file mode 100644 index 01fc48dd1a..0000000000 --- a/docs/docs/06-api-reference/interfaces/ClassificationType.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: ClassificationType - -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. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### forward() - -> **forward**: (`imageSource`) => `Promise`\<\{\[`category`: `string`\]: `number`; \}\> - -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. - -#### Parameters - -##### imageSource - -`string` - -A string representing the image source (e.g., a file path, URI, or base64 string) to be classified. - -#### Returns - -`Promise`\<\{\[`category`: `string`\]: `number`; \}\> - -A Promise that resolves to the classification result (typically containing labels and confidence scores). - -#### Throws - -If the model is not loaded or is currently processing another image. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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 deleted file mode 100644 index 2e4d7d9b08..0000000000 --- a/docs/docs/06-api-reference/interfaces/ContextStrategy.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: ContextStrategy - -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. - -## Methods - -### buildContext() - -> **buildContext**(`systemPrompt`, `history`, `maxContextLength`, `getTokenCount`): [`Message`](Message.md)[] - -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. - -- - -#### Parameters - -##### systemPrompt - -`string` - -The top-level instructions or persona assigned to the model. - -##### history - -[`Message`](Message.md)[] - -The complete conversation history up to the current point. - -##### maxContextLength - -`number` - -The maximum number of tokens that the model can keep in the context. - -##### getTokenCount - -(`messages`) => `number` - -A callback function provided by the LLM controller that calculates the exact number of tokens a specific array of messages will consume once formatted. - -#### Returns - -[`Message`](Message.md)[] - -The optimized array of messages, ready to be processed by the model. diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md deleted file mode 100644 index d0e0414715..0000000000 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: DecodingOptions - -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. - -## Properties - -### language? - -> `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) - -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. - ---- - -### verbose? - -> `optional` **verbose**: `boolean` - -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 deleted file mode 100644 index 44a7324aaf..0000000000 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ /dev/null @@ -1,43 +0,0 @@ -# Interface: Detection\ - -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) - -Represents a detected object within an image, including its bounding box, label, and confidence score. - -## Type Parameters - -### L - -`L` _extends_ [`LabelEnum`](../type-aliases/LabelEnum.md) = _typeof_ [`CocoLabel`](../enumerations/CocoLabel.md) - -The label enum type for the detected object. Defaults to [CocoLabel](../enumerations/CocoLabel.md). - -## Properties - -### bbox - -> **bbox**: [`Bbox`](Bbox.md) - -Defined in: [types/objectDetection.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L32) - -The bounding box of the detected object, defined by its top-left (x1, y1) and bottom-right (x2, y2) coordinates. - ---- - -### label - -> **label**: keyof `L` - -Defined in: [types/objectDetection.ts:33](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L33) - -The class label of the detected object. - ---- - -### score - -> **score**: `number` - -Defined in: [types/objectDetection.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L34) - -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 deleted file mode 100644 index a3c18901c8..0000000000 --- a/docs/docs/06-api-reference/interfaces/ExecutorchConfig.md +++ /dev/null @@ -1,14 +0,0 @@ -# Interface: ExecutorchConfig - -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. - -## Properties - -### resourceFetcher - -> **resourceFetcher**: [`ResourceFetcherAdapter`](ResourceFetcherAdapter.md) - -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 deleted file mode 100644 index 7f649d985e..0000000000 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: ExecutorchModuleProps - -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. - -## Properties - -### modelSource - -> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -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. - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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 deleted file mode 100644 index 675cd1cb80..0000000000 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: ExecutorchModuleType - -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. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### forward() - -> **forward**: (`inputTensor`) => `Promise`\<[`TensorPtr`](TensorPtr.md)[]\> - -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. - -#### Parameters - -##### inputTensor - -[`TensorPtr`](TensorPtr.md)[] - -An array of `TensorPtr` objects representing the input tensors required by the model. - -#### Returns - -`Promise`\<[`TensorPtr`](TensorPtr.md)[]\> - -A Promise that resolves to an array of output `TensorPtr` objects resulting from the model's inference. - -#### Throws - -If the model is not loaded or is currently processing another request. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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/Frame.md b/docs/docs/06-api-reference/interfaces/Frame.md deleted file mode 100644 index 149a3837f7..0000000000 --- a/docs/docs/06-api-reference/interfaces/Frame.md +++ /dev/null @@ -1,36 +0,0 @@ -# Interface: Frame - -Defined in: [types/common.ts:197](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L197) - -Frame data for vision model processing. - -## Methods - -### getNativeBuffer() - -> **getNativeBuffer**(): `object` - -Defined in: [types/common.ts:205](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L205) - -Pointer to native platform buffer (zero-copy, best performance). - -- On iOS: CVPixelBufferRef pointer -- On Android: AHardwareBuffer\* pointer - -Obtain from Vision Camera v5: `frame.getNativeBuffer().pointer` - -#### Returns - -`object` - -##### pointer - -> **pointer**: `bigint` - -##### release() - -> **release**(): `void` - -###### Returns - -`void` diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md deleted file mode 100644 index c1b06fbd99..0000000000 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: GenerationConfig - -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. - -## Properties - -### batchTimeInterval? - -> `optional` **batchTimeInterval**: `number` - -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. - ---- - -### outputTokenBatchSize? - -> `optional` **outputTokenBatchSize**: `number` - -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). - ---- - -### temperature? - -> `optional` **temperature**: `number` - -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. - ---- - -### topp? - -> `optional` **topp**: `number` - -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 deleted file mode 100644 index ddb620e360..0000000000 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md +++ /dev/null @@ -1,29 +0,0 @@ -# Interface: ImageEmbeddingsProps - -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. - -## Properties - -### model - -> **model**: `object` - -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. - -#### modelSource - -> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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 deleted file mode 100644 index e52068d919..0000000000 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: ImageEmbeddingsType - -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. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### forward() - -> **forward**: (`imageSource`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -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. - -#### Parameters - -##### imageSource - -`string` - -A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -A Promise that resolves to a `Float32Array` containing the generated embedding vector. - -#### Throws - -If the model is not loaded or is currently processing another image. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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/KokoroConfig.md b/docs/docs/06-api-reference/interfaces/KokoroConfig.md deleted file mode 100644 index 11ec077cfa..0000000000 --- a/docs/docs/06-api-reference/interfaces/KokoroConfig.md +++ /dev/null @@ -1,36 +0,0 @@ -# Interface: KokoroConfig - -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. - -## Properties - -### durationPredictorSource - -> **durationPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -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 - ---- - -### synthesizerSource - -> **synthesizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -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 - ---- - -### type - -> **type**: `"kokoro"` - -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 deleted file mode 100644 index 52c50e189d..0000000000 --- a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: KokoroVoiceExtras - -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 - -## Properties - -### lexiconSource - -> **lexiconSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -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 - ---- - -### taggerSource - -> **taggerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -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 deleted file mode 100644 index 3acf4d34bc..0000000000 --- a/docs/docs/06-api-reference/interfaces/LLMConfig.md +++ /dev/null @@ -1,55 +0,0 @@ -# Interface: LLMConfig - -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. - -## Properties - -### chatConfig? - -> `optional` **chatConfig**: `Partial`\<[`ChatConfig`](ChatConfig.md)\> - -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: - -`systemPrompt` - Often used to tell the model what is its purpose, for example - "Be a helpful translator". - -`initialMessageHistory` - An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. - -`contextStrategy` - Defines a strategy for managing the conversation context window and message history - ---- - -### generationConfig? - -> `optional` **generationConfig**: [`GenerationConfig`](GenerationConfig.md) - -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. - -`outputTokenBatchSize` - 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). - -`batchTimeInterval` - Upper limit on the time interval between consecutive token batches. - -`temperature` - Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. - -`topp` - Only samples from the smallest set of tokens whose cumulative probability exceeds topp. - ---- - -### toolsConfig? - -> `optional` **toolsConfig**: [`ToolsConfig`](ToolsConfig.md) - -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: - -`tools` - List of objects defining tools. - -`executeToolCallback` - Function that accepts `ToolCall`, executes tool and returns the string to model. - -`displayToolCalls` - If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. diff --git a/docs/docs/06-api-reference/interfaces/LLMProps.md b/docs/docs/06-api-reference/interfaces/LLMProps.md deleted file mode 100644 index 74ee2c1014..0000000000 --- a/docs/docs/06-api-reference/interfaces/LLMProps.md +++ /dev/null @@ -1,41 +0,0 @@ -# Interface: LLMProps - -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. - -## Properties - -### model - -> **model**: `object` - -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 - -> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` that specifies the location of the model binary. - -#### tokenizerConfigSource? - -> `optional` **tokenizerConfigSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` pointing to the JSON file which contains the tokenizer config. - -#### tokenizerSource - -> **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` pointing to the JSON file which contains the tokenizer. - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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 deleted file mode 100644 index 16f5cbf888..0000000000 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ /dev/null @@ -1,237 +0,0 @@ -# Interface: LLMType - -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. - -## Properties - -### configure() - -> **configure**: (`configuration`) => `void` - -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. - -#### Parameters - -##### configuration - -[`LLMConfig`](LLMConfig.md) - -Configuration object containing `chatConfig`, `toolsConfig`, and `generationConfig`. - -#### Returns - -`void` - ---- - -### deleteMessage() - -> **deleteMessage**: (`index`) => `void` - -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. - -#### Parameters - -##### index - -`number` - -The index of the message to delete from history. - -#### Returns - -`void` - ---- - -### downloadProgress - -> **downloadProgress**: `number` - -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. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### generate() - -> **generate**: (`messages`, `tools?`) => `Promise`\<`string`\> - -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. - -#### Parameters - -##### messages - -[`Message`](Message.md)[] - -Array of messages representing the chat history. - -##### tools? - -`Object`[] - -Optional array of tools that can be used during generation. - -#### Returns - -`Promise`\<`string`\> - -The generated tokens as `string`. - ---- - -### getGeneratedTokenCount() - -> **getGeneratedTokenCount**: () => `number` - -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. - -#### Returns - -`number` - -The count of generated tokens. - ---- - -### getPromptTokenCount() - -> **getPromptTokenCount**: () => `number` - -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. - -#### Returns - -`number` - -The count of prompt token. - ---- - -### getTotalTokenCount() - -> **getTotalTokenCount**: () => `number` - -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. - -#### Returns - -`number` - -The count of prompt and generated tokens. - ---- - -### interrupt() - -> **interrupt**: () => `void` - -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. - -#### Returns - -`void` - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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. - ---- - -### messageHistory - -> **messageHistory**: [`Message`](Message.md)[] - -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. - ---- - -### response - -> **response**: `string` - -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. - ---- - -### sendMessage() - -> **sendMessage**: (`message`) => `Promise`\<`string`\> - -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. - -#### Parameters - -##### message - -`string` - -The message string to send. - -#### Returns - -`Promise`\<`string`\> - -The model's response as a `string`. - ---- - -### token - -> **token**: `string` - -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 deleted file mode 100644 index 85821e43e9..0000000000 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: Message - -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. - -## Properties - -### content - -> **content**: `string` - -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. - ---- - -### role - -> **role**: [`MessageRole`](../type-aliases/MessageRole.md) - -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 deleted file mode 100644 index 65b7d5edec..0000000000 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ /dev/null @@ -1,36 +0,0 @@ -# Interface: OCRDetection - -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. - -## Properties - -### bbox - -> **bbox**: [`Point`](Point.md)[] - -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. - ---- - -### score - -> **score**: `number` - -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. - ---- - -### text - -> **text**: `string` - -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 deleted file mode 100644 index f894705a51..0000000000 --- a/docs/docs/06-api-reference/interfaces/OCRProps.md +++ /dev/null @@ -1,48 +0,0 @@ -# Interface: OCRProps - -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. - -## Extended by - -- [`VerticalOCRProps`](VerticalOCRProps.md) - -## Properties - -### model - -> **model**: `object` - -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. - -#### detectorSource - -> **detectorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` that specifies the location of the text detector model binary. - -#### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -The language configuration enum for the OCR model (e.g., English, Polish, etc.). - -#### recognizerSource - -> **recognizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` that specifies the location of the text recognizer model binary. - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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 deleted file mode 100644 index 4a32da9531..0000000000 --- a/docs/docs/06-api-reference/interfaces/OCRType.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: OCRType - -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). - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### forward() - -> **forward**: (`imageSource`) => `Promise`\<[`OCRDetection`](OCRDetection.md)[]\> - -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. - -#### Parameters - -##### imageSource - -`string` - -A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. - -#### Returns - -`Promise`\<[`OCRDetection`](OCRDetection.md)[]\> - -A Promise that resolves to the OCR results (typically containing the recognized text strings and their bounding boxes). - -#### Throws - -If the models are not loaded or are currently processing another image. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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 deleted file mode 100644 index 7199fe504f..0000000000 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md +++ /dev/null @@ -1,33 +0,0 @@ -# Interface: ObjectDetectionProps\ - -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) - -Props for the `useObjectDetection` hook. - -## Type Parameters - -### C - -`C` _extends_ [`ObjectDetectionModelSources`](../type-aliases/ObjectDetectionModelSources.md) - -A [ObjectDetectionModelSources](../type-aliases/ObjectDetectionModelSources.md) config specifying which built-in model to load. - -## Properties - -### model - -> **model**: `C` - -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) - -The model config containing `modelName` and `modelSource`. - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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) - -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 deleted file mode 100644 index 95a2bd4078..0000000000 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md +++ /dev/null @@ -1,116 +0,0 @@ -# Interface: ObjectDetectionType\ - -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) - -Return type for the `useObjectDetection` hook. -Manages the state and operations for Computer Vision object detection tasks. - -## Type Parameters - -### L - -`L` _extends_ [`LabelEnum`](../type-aliases/LabelEnum.md) - -The [LabelEnum](../type-aliases/LabelEnum.md) representing the model's class labels. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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) - -Represents the download progress of the model binary as a value between 0 and 1. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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) - -Contains the error object if the model failed to load, download, or encountered a runtime error during detection. - ---- - -### forward() - -> **forward**: (`input`, `detectionThreshold?`) => `Promise`\<[`Detection`](Detection.md)\<`L`\>[]\> - -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) - -Executes the model's forward pass with automatic input type detection. - -#### Parameters - -##### input - -Image source (string path/URI or PixelData object) - -`string` | [`PixelData`](PixelData.md) - -##### detectionThreshold? - -`number` - -An optional number between 0 and 1 representing the minimum confidence score. Default is 0.7. - -#### Returns - -`Promise`\<[`Detection`](Detection.md)\<`L`\>[]\> - -A Promise that resolves to an array of `Detection` objects. - -#### Throws - -If the model is not loaded or is currently processing another image. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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) - -Indicates whether the model is currently processing an image. - ---- - -### isReady - -> **isReady**: `boolean` - -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) - -Indicates whether the object detection model is loaded and ready to process images. - ---- - -### runOnFrame - -> **runOnFrame**: (`frame`, `detectionThreshold`) => [`Detection`](Detection.md)\<`L`\>[] \| `null` - -Defined in: [types/objectDetection.ts:132](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/objectDetection.ts#L132) - -Synchronous worklet function for real-time VisionCamera frame processing. -Automatically handles native buffer extraction and cleanup. - -**Use this for VisionCamera frame processing in worklets.** -For async processing, use `forward()` instead. - -Available after model is loaded (`isReady: true`). - -#### Param - -VisionCamera Frame object - -#### Param - -The threshold for detection sensitivity. - -#### Returns - -Array of Detection objects representing detected items in the frame. diff --git a/docs/docs/06-api-reference/interfaces/PixelData.md b/docs/docs/06-api-reference/interfaces/PixelData.md deleted file mode 100644 index 1cc9c60be3..0000000000 --- a/docs/docs/06-api-reference/interfaces/PixelData.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: PixelData - -Defined in: [types/common.ts:172](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L172) - -Represents raw pixel data in RGB format for vision models. - -This type extends TensorPtr with constraints specific to image data: - -- dataPtr must be Uint8Array (8-bit unsigned integers) -- scalarType is always BYTE (ScalarType.BYTE) -- sizes represents [height, width, channels] where channels must be 3 (RGB) - -## Example - -```typescript -const pixelData: PixelData = { - dataPtr: new Uint8Array(width * height * 3), // RGB pixel data - sizes: [height, width, 3], // [height, width, channels] - scalarType: ScalarType.BYTE, -}; -``` - -## Extends - -- `Pick`\<[`TensorPtr`](TensorPtr.md), `"sizes"`\> - -## Properties - -### dataPtr - -> **dataPtr**: `Uint8Array` - -Defined in: [types/common.ts:178](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L178) - -RGB pixel data as Uint8Array. -Expected format: RGB (3 channels), not RGBA or BGRA. -Size must equal: width _ height _ 3 - ---- - -### scalarType - -> **scalarType**: [`BYTE`](../enumerations/ScalarType.md#byte) - -Defined in: [types/common.ts:191](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L191) - -Scalar type is always BYTE for pixel data. - ---- - -### sizes - -> **sizes**: \[`number`, `number`, `3`\] - -Defined in: [types/common.ts:186](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/common.ts#L186) - -Dimensions of the pixel data: [height, width, channels]. - -- sizes[0]: height (number of rows) -- sizes[1]: width (number of columns) -- sizes[2]: channels (must be 3 for RGB) - -#### Overrides - -[`TensorPtr`](TensorPtr.md).[`sizes`](TensorPtr.md#sizes) diff --git a/docs/docs/06-api-reference/interfaces/Point.md b/docs/docs/06-api-reference/interfaces/Point.md deleted file mode 100644 index 528835a889..0000000000 --- a/docs/docs/06-api-reference/interfaces/Point.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: Point - -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. - -## Properties - -### x - -> **x**: `number` - -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. - ---- - -### y - -> **y**: `number` - -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 deleted file mode 100644 index d98b5015dd..0000000000 --- a/docs/docs/06-api-reference/interfaces/ResourceFetcherAdapter.md +++ /dev/null @@ -1,77 +0,0 @@ -# Interface: ResourceFetcherAdapter - -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:** - -- `fetch`: Download resources to local storage (used by all modules) -- `readAsString`: Read file contents as string (used for config files) - -## Remarks - -This interface is intentionally minimal. Custom fetchers only need to implement -these two methods for the library to function correctly. - -## Methods - -### fetch() - -> **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> - -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. - -#### Parameters - -##### callback - -(`downloadProgress`) => `void` - -Optional callback to track progress of all downloads, reported between 0 and 1. - -##### sources - -...[`ResourceSource`](../type-aliases/ResourceSource.md)[] - -Multiple resources that can be strings, asset references, or objects. - -#### Returns - -`Promise`\<`string`[] \| `null`\> - -If the fetch was successful, it returns a promise which resolves to an array of local file paths for the downloaded/stored resources (without file:// prefix). -If the fetch was interrupted, it returns a promise which resolves to `null`. - -#### Remarks - -**REQUIRED**: Used by all library modules for downloading models and resources. - ---- - -### readAsString() - -> **readAsString**(`path`): `Promise`\<`string`\> - -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. - -#### Parameters - -##### path - -`string` - -Absolute file path - -#### Returns - -`Promise`\<`string`\> - -File contents as string - -#### Remarks - -**REQUIRED**: Used internally for reading configuration files (e.g., tokenizer configs). diff --git a/docs/docs/06-api-reference/interfaces/ResourceSourceExtended.md b/docs/docs/06-api-reference/interfaces/ResourceSourceExtended.md deleted file mode 100644 index 0789456b56..0000000000 --- a/docs/docs/06-api-reference/interfaces/ResourceSourceExtended.md +++ /dev/null @@ -1,95 +0,0 @@ -# Interface: ResourceSourceExtended - -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. - -## Properties - -### cacheFileUri? - -> `optional` **cacheFileUri**: `string` - -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. - ---- - -### callback()? - -> `optional` **callback**: (`downloadProgress`) => `void` - -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). - -#### Parameters - -##### downloadProgress - -`number` - -#### Returns - -`void` - ---- - -### fileUri? - -> `optional` **fileUri**: `string` - -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. - ---- - -### next? - -> `optional` **next**: `ResourceSourceExtended` - -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. - ---- - -### results - -> **results**: `string`[] - -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. - ---- - -### source - -> **source**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -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. - ---- - -### sourceType - -> **sourceType**: [`SourceType`](../enumerations/SourceType.md) - -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.). - ---- - -### uri? - -> `optional` **uri**: `string` - -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 deleted file mode 100644 index 19916521de..0000000000 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: Segment - -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. - -## Properties - -### end - -> **end**: `number` - -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. - ---- - -### start - -> **start**: `number` - -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/SemanticSegmentationProps.md b/docs/docs/06-api-reference/interfaces/SemanticSegmentationProps.md deleted file mode 100644 index 9d7f204379..0000000000 --- a/docs/docs/06-api-reference/interfaces/SemanticSegmentationProps.md +++ /dev/null @@ -1,33 +0,0 @@ -# Interface: SemanticSegmentationProps\ - -Defined in: [types/semanticSegmentation.ts:113](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L113) - -Props for the `useSemanticSegmentation` hook. - -## Type Parameters - -### C - -`C` _extends_ [`SemanticSegmentationModelSources`](../type-aliases/SemanticSegmentationModelSources.md) - -A [SemanticSegmentationModelSources](../type-aliases/SemanticSegmentationModelSources.md) config specifying which built-in model to load. - -## Properties - -### model - -> **model**: `C` - -Defined in: [types/semanticSegmentation.ts:116](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L116) - -The model config containing `modelName` and `modelSource`. - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -Defined in: [types/semanticSegmentation.ts:117](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L117) - -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/SemanticSegmentationType.md b/docs/docs/06-api-reference/interfaces/SemanticSegmentationType.md deleted file mode 100644 index e5628b1e3e..0000000000 --- a/docs/docs/06-api-reference/interfaces/SemanticSegmentationType.md +++ /dev/null @@ -1,100 +0,0 @@ -# Interface: SemanticSegmentationType\ - -Defined in: [types/semanticSegmentation.ts:128](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L128) - -Return type for the `useSemanticSegmentation` hook. -Manages the state and operations for semantic 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 - -### downloadProgress - -> **downloadProgress**: `number` - -Defined in: [types/semanticSegmentation.ts:147](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L147) - -Represents the download progress of the model binary as a value between 0 and 1. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -Defined in: [types/semanticSegmentation.ts:132](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L132) - -Contains the error object if the model failed to load, download, or encountered a runtime error during segmentation. - ---- - -### forward() - -> **forward**: \<`K`\>(`imageSource`, `classesOfInterest?`, `resizeToInput?`) => `Promise`\<`Record`\<`"ARGMAX"`, `Int32Array`\<`ArrayBufferLike`\>\> & `Record`\<`K`, `Float32Array`\<`ArrayBufferLike`\>\>\> - -Defined in: [types/semanticSegmentation.ts:157](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L157) - -Executes the model's forward pass to perform semantic segmentation on the provided image. - -#### Type Parameters - -##### K - -`K` _extends_ `string` \| `number` \| `symbol` - -#### Parameters - -##### imageSource - -`string` - -A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. - -##### classesOfInterest? - -`K`[] - -An optional array of label keys indicating which per-class probability masks to include in the output. `ARGMAX` is always returned regardless. - -##### resizeToInput? - -`boolean` - -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`\<`Record`\<`"ARGMAX"`, `Int32Array`\<`ArrayBufferLike`\>\> & `Record`\<`K`, `Float32Array`\<`ArrayBufferLike`\>\>\> - -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 - -If the model is not loaded or is currently processing another image. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -Defined in: [types/semanticSegmentation.ts:142](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L142) - -Indicates whether the model is currently processing an image. - ---- - -### isReady - -> **isReady**: `boolean` - -Defined in: [types/semanticSegmentation.ts:137](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L137) - -Indicates whether the segmentation model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md deleted file mode 100644 index f919d07e36..0000000000 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: SpeechToTextModelConfig - -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. - -## Properties - -### decoderSource - -> **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -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. - ---- - -### encoderSource - -> **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -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. - ---- - -### isMultilingual - -> **isMultilingual**: `boolean` - -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. - ---- - -### tokenizerSource - -> **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -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 deleted file mode 100644 index 735e8c5d12..0000000000 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextProps.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: SpeechToTextProps - -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. - -## Properties - -### model - -> **model**: [`SpeechToTextModelConfig`](SpeechToTextModelConfig.md) - -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. - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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 deleted file mode 100644 index ef4ec766d9..0000000000 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md +++ /dev/null @@ -1,193 +0,0 @@ -# Interface: SpeechToTextType - -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. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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. - -## Methods - -### decode() - -> **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -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. - -#### Parameters - -##### tokens - -`Int32Array` - -The encoded audio data. - -##### encoderOutput - -`Float32Array` - -The output from the encoder. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -A promise resolving to the decoded text. - ---- - -### encode() - -> **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -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. - -#### Parameters - -##### waveform - -`Float32Array` - -The input audio waveform array. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -A promise resolving to the encoded data. - ---- - -### stream() - -> **stream**(`options?`): `AsyncGenerator`\<\{ `committed`: [`TranscriptionResult`](TranscriptionResult.md); `nonCommitted`: [`TranscriptionResult`](TranscriptionResult.md); \}, `void`, `unknown`\> - -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. -Updates `committedTranscription` and `nonCommittedTranscription` as transcription progresses. - -#### Parameters - -##### options? - -[`DecodingOptions`](DecodingOptions.md) - -Decoding options including language. - -#### Returns - -`AsyncGenerator`\<\{ `committed`: [`TranscriptionResult`](TranscriptionResult.md); `nonCommitted`: [`TranscriptionResult`](TranscriptionResult.md); \}, `void`, `unknown`\> - -Asynchronous generator that returns `committed` and `nonCommitted` transcription. -Both `committed` and `nonCommitted` are of type `TranscriptionResult` - ---- - -### streamInsert() - -> **streamInsert**(`waveform`): `void` - -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. - -#### Parameters - -##### waveform - -`Float32Array` - -The audio chunk to insert. - -#### Returns - -`void` - ---- - -### streamStop() - -> **streamStop**(): `void` - -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. - -#### Returns - -`void` - ---- - -### transcribe() - -> **transcribe**(`waveform`, `options?`): `Promise`\<[`TranscriptionResult`](TranscriptionResult.md)\> - -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. - -#### Parameters - -##### waveform - -`Float32Array` - -The input audio waveform. - -##### options? - -[`DecodingOptions`](DecodingOptions.md) - -Decoding options, check API reference for more details. - -#### Returns - -`Promise`\<[`TranscriptionResult`](TranscriptionResult.md)\> - -Resolves a promise with the output transcription. Result of transcription is -object of type `TranscriptionResult`. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md deleted file mode 100644 index 97655a44b0..0000000000 --- a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md +++ /dev/null @@ -1,29 +0,0 @@ -# Interface: StyleTransferProps - -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. - -## Properties - -### model - -> **model**: `object` - -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. - -#### modelSource - -> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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 deleted file mode 100644 index 4b50a43f72..0000000000 --- a/docs/docs/06-api-reference/interfaces/StyleTransferType.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: StyleTransferType - -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. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### forward() - -> **forward**: (`imageSource`) => `Promise`\<`string`\> - -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. - -#### Parameters - -##### imageSource - -`string` - -A string representing the input image source (e.g., a file path, URI, or base64 string) to be stylized. - -#### Returns - -`Promise`\<`string`\> - -A Promise that resolves to a string containing the stylized image (typically as a base64 string or a file URI). - -#### Throws - -If the model is not loaded or is currently processing another image. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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 deleted file mode 100644 index df80727f1d..0000000000 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: TensorPtr - -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. - -## Properties - -### dataPtr - -> **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) - -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. - ---- - -### scalarType - -> **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) - -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. - ---- - -### sizes - -> **sizes**: `number`[] - -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 deleted file mode 100644 index 539d421e73..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: TextEmbeddingsProps - -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. - -## Properties - -### model - -> **model**: `object` - -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. - -#### modelSource - -> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -The source of the text embeddings model binary. - -#### tokenizerSource - -> **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -The source of the tokenizer JSON file. - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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 deleted file mode 100644 index 541d8bc09a..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md +++ /dev/null @@ -1,73 +0,0 @@ -# Interface: TextEmbeddingsType - -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. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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). - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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. - -## Methods - -### forward() - -> **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -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. - -#### Parameters - -##### input - -`string` - -The text string to embed. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -A promise resolving to a Float32Array containing the vector embeddings. - -#### Throws - -If the model is not loaded or is currently processing another request. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageProps.md b/docs/docs/06-api-reference/interfaces/TextToImageProps.md deleted file mode 100644 index 88f61fb7b9..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextToImageProps.md +++ /dev/null @@ -1,79 +0,0 @@ -# Interface: TextToImageProps - -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. - -## Properties - -### inferenceCallback()? - -> `optional` **inferenceCallback**: (`stepIdx`) => `void` - -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. - -#### Parameters - -##### stepIdx - -`number` - -The index of the current inference step. - -#### Returns - -`void` - ---- - -### model - -> **model**: `object` - -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. - -#### decoderSource - -> **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -Source for the VAE decoder model binary, used to decode the final image. - -#### encoderSource - -> **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -Source for the text encoder model binary. - -#### schedulerSource - -> **schedulerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -Source for the diffusion scheduler binary/config. - -#### tokenizerSource - -> **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -Source for the text tokenizer binary/config. - -#### unetSource - -> **unetSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -Source for the UNet (noise predictor) model binary. - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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 deleted file mode 100644 index 5d29900ce2..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextToImageType.md +++ /dev/null @@ -1,106 +0,0 @@ -# Interface: TextToImageType - -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. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### generate() - -> **generate**: (`input`, `imageSize?`, `numSteps?`, `seed?`) => `Promise`\<`string`\> - -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. - -#### Parameters - -##### input - -`string` - -The text prompt describing the desired image. - -##### imageSize? - -`number` - -Optional. The target width and height of the generated image (e.g., 512 for 512x512). Defaults to the model's standard size if omitted. - -##### numSteps? - -`number` - -Optional. The number of denoising steps for the diffusion process. More steps generally yield higher quality at the cost of generation time. - -##### seed? - -`number` - -Optional. A random seed for reproducible generation. Should be a positive integer. - -#### Returns - -`Promise`\<`string`\> - -A Promise that resolves to a string representing the generated image (e.g., base64 string or file URI). - -#### Throws - -If the model is not loaded or is currently generating another image. - ---- - -### interrupt() - -> **interrupt**: () => `void` - -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. - -#### Returns - -`void` - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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 deleted file mode 100644 index 6f2e04ab5b..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md +++ /dev/null @@ -1,29 +0,0 @@ -# Interface: TextToSpeechConfig - -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 - -## Extended by - -- [`TextToSpeechProps`](TextToSpeechProps.md) - -## Properties - -### model - -> **model**: [`KokoroConfig`](KokoroConfig.md) - -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 - ---- - -### voice - -> **voice**: [`VoiceConfig`](VoiceConfig.md) - -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 deleted file mode 100644 index 73414dd7fc..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md +++ /dev/null @@ -1,29 +0,0 @@ -# Interface: TextToSpeechInput - -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 - -## Extended by - -- [`TextToSpeechStreamingInput`](TextToSpeechStreamingInput.md) - -## Properties - -### speed? - -> `optional` **speed**: `number` - -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 - ---- - -### text - -> **text**: `string` - -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/TextToSpeechPhonemeInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechPhonemeInput.md deleted file mode 100644 index 17adbebce1..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechPhonemeInput.md +++ /dev/null @@ -1,32 +0,0 @@ -# Interface: TextToSpeechPhonemeInput - -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) - -Text to Speech module input for pre-computed phonemes. -Use this when you have your own phonemizer (e.g. the Python `phonemizer` -library, espeak-ng, or any custom G2P system) and want to bypass the -built-in phonemizer pipeline. - -## Extended by - -- [`TextToSpeechStreamingPhonemeInput`](TextToSpeechStreamingPhonemeInput.md) - -## Properties - -### phonemes - -> **phonemes**: `string` - -Defined in: [types/tts.ts:104](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L104) - -pre-computed IPA phoneme string - ---- - -### speed? - -> `optional` **speed**: `number` - -Defined in: [types/tts.ts:105](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L105) - -optional speed argument - the higher it is, the faster the speech becomes diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md deleted file mode 100644 index 2cf0a88107..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md +++ /dev/null @@ -1,47 +0,0 @@ -# Interface: TextToSpeechProps - -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. - -## Extends - -- [`TextToSpeechConfig`](TextToSpeechConfig.md) - -## Properties - -### model - -> **model**: [`KokoroConfig`](KokoroConfig.md) - -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 - -#### Inherited from - -[`TextToSpeechConfig`](TextToSpeechConfig.md).[`model`](TextToSpeechConfig.md#model) - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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. - ---- - -### voice - -> **voice**: [`VoiceConfig`](VoiceConfig.md) - -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 - -#### Inherited from - -[`TextToSpeechConfig`](TextToSpeechConfig.md).[`voice`](TextToSpeechConfig.md#voice) diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingCallbacks.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingCallbacks.md deleted file mode 100644 index 132ef96fa5..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingCallbacks.md +++ /dev/null @@ -1,58 +0,0 @@ -# Interface: TextToSpeechStreamingCallbacks - -Defined in: [types/tts.ts:189](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L189) - -Shared streaming lifecycle callbacks for TTS streaming modes. - -## Extended by - -- [`TextToSpeechStreamingInput`](TextToSpeechStreamingInput.md) -- [`TextToSpeechStreamingPhonemeInput`](TextToSpeechStreamingPhonemeInput.md) - -## Properties - -### onBegin()? - -> `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> - -Defined in: [types/tts.ts:190](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L190) - -Called when streaming begins - -#### Returns - -`void` \| `Promise`\<`void`\> - ---- - -### onEnd()? - -> `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> - -Defined in: [types/tts.ts:192](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L192) - -Called when streaming ends - -#### Returns - -`void` \| `Promise`\<`void`\> - ---- - -### onNext()? - -> `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> - -Defined in: [types/tts.ts:191](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L191) - -Called after each audio chunk gets calculated. - -#### Parameters - -##### audio - -`Float32Array` - -#### Returns - -`void` \| `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md deleted file mode 100644 index c6b7dd1a9f..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md +++ /dev/null @@ -1,102 +0,0 @@ -# Interface: TextToSpeechStreamingInput - -Defined in: [types/tts.ts:205](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L205) - -Text to Speech streaming input definition - -Streaming mode in T2S is synchronized by passing specific callbacks -executed at given moments of the streaming. -Actions such as playing the audio should happen within the onNext callback. -Callbacks can be both synchronous or asynchronous. - -## Extends - -- [`TextToSpeechInput`](TextToSpeechInput.md).[`TextToSpeechStreamingCallbacks`](TextToSpeechStreamingCallbacks.md) - -## Properties - -### onBegin()? - -> `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> - -Defined in: [types/tts.ts:190](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L190) - -Called when streaming begins - -#### Returns - -`void` \| `Promise`\<`void`\> - -#### Inherited from - -[`TextToSpeechStreamingCallbacks`](TextToSpeechStreamingCallbacks.md).[`onBegin`](TextToSpeechStreamingCallbacks.md#onbegin) - ---- - -### onEnd()? - -> `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> - -Defined in: [types/tts.ts:192](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L192) - -Called when streaming ends - -#### Returns - -`void` \| `Promise`\<`void`\> - -#### Inherited from - -[`TextToSpeechStreamingCallbacks`](TextToSpeechStreamingCallbacks.md).[`onEnd`](TextToSpeechStreamingCallbacks.md#onend) - ---- - -### onNext()? - -> `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> - -Defined in: [types/tts.ts:191](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L191) - -Called after each audio chunk gets calculated. - -#### Parameters - -##### audio - -`Float32Array` - -#### Returns - -`void` \| `Promise`\<`void`\> - -#### Inherited from - -[`TextToSpeechStreamingCallbacks`](TextToSpeechStreamingCallbacks.md).[`onNext`](TextToSpeechStreamingCallbacks.md#onnext) - ---- - -### speed? - -> `optional` **speed**: `number` - -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 - -#### Inherited from - -[`TextToSpeechInput`](TextToSpeechInput.md).[`speed`](TextToSpeechInput.md#speed) - ---- - -### text - -> **text**: `string` - -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 - -#### Inherited from - -[`TextToSpeechInput`](TextToSpeechInput.md).[`text`](TextToSpeechInput.md#text) diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingPhonemeInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingPhonemeInput.md deleted file mode 100644 index 23a91b9add..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingPhonemeInput.md +++ /dev/null @@ -1,98 +0,0 @@ -# Interface: TextToSpeechStreamingPhonemeInput - -Defined in: [types/tts.ts:214](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L214) - -Streaming input definition for pre-computed phonemes. -Same as `TextToSpeechStreamingInput` but accepts `phonemes` instead of `text`. - -## Extends - -- [`TextToSpeechPhonemeInput`](TextToSpeechPhonemeInput.md).[`TextToSpeechStreamingCallbacks`](TextToSpeechStreamingCallbacks.md) - -## Properties - -### onBegin()? - -> `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> - -Defined in: [types/tts.ts:190](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L190) - -Called when streaming begins - -#### Returns - -`void` \| `Promise`\<`void`\> - -#### Inherited from - -[`TextToSpeechStreamingCallbacks`](TextToSpeechStreamingCallbacks.md).[`onBegin`](TextToSpeechStreamingCallbacks.md#onbegin) - ---- - -### onEnd()? - -> `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> - -Defined in: [types/tts.ts:192](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L192) - -Called when streaming ends - -#### Returns - -`void` \| `Promise`\<`void`\> - -#### Inherited from - -[`TextToSpeechStreamingCallbacks`](TextToSpeechStreamingCallbacks.md).[`onEnd`](TextToSpeechStreamingCallbacks.md#onend) - ---- - -### onNext()? - -> `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> - -Defined in: [types/tts.ts:191](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L191) - -Called after each audio chunk gets calculated. - -#### Parameters - -##### audio - -`Float32Array` - -#### Returns - -`void` \| `Promise`\<`void`\> - -#### Inherited from - -[`TextToSpeechStreamingCallbacks`](TextToSpeechStreamingCallbacks.md).[`onNext`](TextToSpeechStreamingCallbacks.md#onnext) - ---- - -### phonemes - -> **phonemes**: `string` - -Defined in: [types/tts.ts:104](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L104) - -pre-computed IPA phoneme string - -#### Inherited from - -[`TextToSpeechPhonemeInput`](TextToSpeechPhonemeInput.md).[`phonemes`](TextToSpeechPhonemeInput.md#phonemes) - ---- - -### speed? - -> `optional` **speed**: `number` - -Defined in: [types/tts.ts:105](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L105) - -optional speed argument - the higher it is, the faster the speech becomes - -#### Inherited from - -[`TextToSpeechPhonemeInput`](TextToSpeechPhonemeInput.md).[`speed`](TextToSpeechPhonemeInput.md#speed) diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md deleted file mode 100644 index 5c28bc9a8d..0000000000 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md +++ /dev/null @@ -1,178 +0,0 @@ -# Interface: TextToSpeechType - -Defined in: [types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L114) - -Return type for the `useTextToSpeech` hook. -Manages the state and operations for Text-to-Speech generation. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -Defined in: [types/tts.ts:133](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L133) - -Represents the download progress of the model and voice assets as a value between 0 and 1. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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) - -Contains the error object if the model failed to load or encountered an error during inference. - ---- - -### forward() - -> **forward**: (`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -Defined in: [types/tts.ts:141](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L141) - -Runs the model to convert the provided text into speech audio in a single pass. - -- - -#### Parameters - -##### input - -[`TextToSpeechInput`](TextToSpeechInput.md) - -The `TextToSpeechInput` object containing the `text` to synthesize and optional `speed`. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -A Promise that resolves with the generated audio data (typically a `Float32Array`). - -#### Throws - -If the model is not loaded or is currently generating. - ---- - -### forwardFromPhonemes() - -> **forwardFromPhonemes**: (`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -Defined in: [types/tts.ts:151](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L151) - -Synthesizes pre-computed phonemes into speech audio in a single pass. -Bypasses the built-in phonemizer, allowing use of external G2P systems. - -#### Parameters - -##### input - -[`TextToSpeechPhonemeInput`](TextToSpeechPhonemeInput.md) - -The `TextToSpeechPhonemeInput` object containing pre-computed `phonemes` and optional `speed`. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -A Promise that resolves with the generated audio data. - -#### Throws - -If the model is not loaded or is currently generating. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -Defined in: [types/tts.ts:128](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L128) - -Indicates whether the model is currently generating audio. - ---- - -### isReady - -> **isReady**: `boolean` - -Defined in: [types/tts.ts:123](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L123) - -Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. - ---- - -### stream() - -> **stream**: (`input`) => `Promise`\<`void`\> - -Defined in: [types/tts.ts:162](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L162) - -Streams the generated audio data incrementally. -This is optimal for real-time playback, allowing audio to start playing before the full text is synthesized. - -- - -#### Parameters - -##### input - -[`TextToSpeechStreamingInput`](TextToSpeechStreamingInput.md) - -The `TextToSpeechStreamingInput` object containing `text`, optional `speed`, and lifecycle callbacks (`onBegin`, `onNext`, `onEnd`). - -#### Returns - -`Promise`\<`void`\> - -A Promise that resolves when the streaming process is complete. - -#### Throws - -If the model is not loaded or is currently generating. - ---- - -### streamFromPhonemes() - -> **streamFromPhonemes**: (`input`) => `Promise`\<`void`\> - -Defined in: [types/tts.ts:171](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L171) - -Streams pre-computed phonemes incrementally, bypassing the built-in phonemizer. - -#### Parameters - -##### input - -[`TextToSpeechStreamingPhonemeInput`](TextToSpeechStreamingPhonemeInput.md) - -The streaming input with pre-computed `phonemes` instead of `text`. - -#### Returns - -`Promise`\<`void`\> - -A Promise that resolves when the streaming process is complete. - -#### Throws - -If the model is not loaded or is currently generating. - ---- - -### streamStop() - -> **streamStop**: () => `void` - -Defined in: [types/tts.ts:178](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/tts.ts#L178) - -Interrupts and stops the currently active audio generation stream. - -#### Returns - -`void` diff --git a/docs/docs/06-api-reference/interfaces/TokenizerProps.md b/docs/docs/06-api-reference/interfaces/TokenizerProps.md deleted file mode 100644 index 8ffacfc478..0000000000 --- a/docs/docs/06-api-reference/interfaces/TokenizerProps.md +++ /dev/null @@ -1,31 +0,0 @@ -# Interface: TokenizerProps - -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. - -## Properties - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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. - ---- - -### tokenizer - -> **tokenizer**: `object` - -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: - -`tokenizerSource` - A `ResourceSource` that specifies the location of the tokenizer. - -#### tokenizerSource - -> **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) diff --git a/docs/docs/06-api-reference/interfaces/TokenizerType.md b/docs/docs/06-api-reference/interfaces/TokenizerType.md deleted file mode 100644 index 7ccc1bd6fc..0000000000 --- a/docs/docs/06-api-reference/interfaces/TokenizerType.md +++ /dev/null @@ -1,163 +0,0 @@ -# Interface: TokenizerType - -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. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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). - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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. - -## Methods - -### decode() - -> **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> - -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. - -#### Parameters - -##### tokens - -`number`[] - -An array or `number[]` of token IDs to decode. - -##### skipSpecialTokens - -Optional boolean to indicate whether special tokens should be skipped during decoding. - -`boolean` | `undefined` - -#### Returns - -`Promise`\<`string`\> - -A promise resolving to the decoded text string. - ---- - -### encode() - -> **encode**(`text`): `Promise`\<`number`[]\> - -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. - -#### Parameters - -##### text - -`string` - -The input text string to tokenize. - -#### Returns - -`Promise`\<`number`[]\> - -A promise resolving to an array `number[]` containing the encoded token IDs. - ---- - -### getVocabSize() - -> **getVocabSize**(): `Promise`\<`number`\> - -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. - -#### Returns - -`Promise`\<`number`\> - -A promise resolving to the vocabulary size. - ---- - -### idToToken() - -> **idToToken**(`id`): `Promise`\<`string`\> - -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. - -#### Parameters - -##### id - -`number` - -The numeric token ID. - -#### Returns - -`Promise`\<`string`\> - -A promise resolving to the token string representation. - ---- - -### tokenToId() - -> **tokenToId**(`token`): `Promise`\<`number`\> - -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. - -#### Parameters - -##### token - -`string` - -The token string. - -#### Returns - -`Promise`\<`number`\> - -A promise resolving to the token ID. diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md deleted file mode 100644 index a8110815d9..0000000000 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: ToolCall - -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. - -## Properties - -### arguments - -> **arguments**: `Object` - -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. - ---- - -### toolName - -> **toolName**: `string` - -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 deleted file mode 100644 index c206936ffe..0000000000 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: ToolsConfig - -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**. - -## Properties - -### displayToolCalls? - -> `optional` **displayToolCalls**: `boolean` - -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. - ---- - -### executeToolCallback() - -> **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> - -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. - -#### Parameters - -##### call - -[`ToolCall`](ToolCall.md) - -#### Returns - -`Promise`\<`string` \| `null`\> - ---- - -### tools - -> **tools**: `Object`[] - -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 deleted file mode 100644 index 109560de65..0000000000 --- a/docs/docs/06-api-reference/interfaces/TranscriptionResult.md +++ /dev/null @@ -1,56 +0,0 @@ -# Interface: TranscriptionResult - -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`). - -## Properties - -### duration - -> **duration**: `number` - -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. - ---- - -### language - -> **language**: `string` - -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. - ---- - -### segments? - -> `optional` **segments**: [`TranscriptionSegment`](TranscriptionSegment.md)[] - -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. - ---- - -### task? - -> `optional` **task**: `"transcribe"` \| `"stream"` - -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'. - ---- - -### text - -> **text**: `string` - -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 deleted file mode 100644 index 5769cf2dcc..0000000000 --- a/docs/docs/06-api-reference/interfaces/TranscriptionSegment.md +++ /dev/null @@ -1,86 +0,0 @@ -# Interface: TranscriptionSegment - -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. - -## Properties - -### avgLogprob - -> **avgLogprob**: `number` - -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. - ---- - -### compressionRatio - -> **compressionRatio**: `number` - -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. - ---- - -### end - -> **end**: `number` - -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). - ---- - -### start - -> **start**: `number` - -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). - ---- - -### temperature - -> **temperature**: `number` - -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. - ---- - -### text - -> **text**: `string` - -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. - ---- - -### tokens - -> **tokens**: `number`[] - -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. - ---- - -### words? - -> `optional` **words**: [`Word`](Word.md)[] - -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 deleted file mode 100644 index 3c4e7748db..0000000000 --- a/docs/docs/06-api-reference/interfaces/VADProps.md +++ /dev/null @@ -1,29 +0,0 @@ -# Interface: VADProps - -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. - -## Properties - -### model - -> **model**: `object` - -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. - -#### modelSource - -> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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 deleted file mode 100644 index 38d8092e60..0000000000 --- a/docs/docs/06-api-reference/interfaces/VADType.md +++ /dev/null @@ -1,73 +0,0 @@ -# Interface: VADType - -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. - -## Properties - -### downloadProgress - -> **downloadProgress**: `number` - -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. - ---- - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -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. - ---- - -### isGenerating - -> **isGenerating**: `boolean` - -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. - ---- - -### isReady - -> **isReady**: `boolean` - -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. - -## Methods - -### forward() - -> **forward**(`waveform`): `Promise`\<[`Segment`](Segment.md)[]\> - -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. - -#### Parameters - -##### waveform - -`Float32Array` - -The input audio waveform array. - -#### Returns - -`Promise`\<[`Segment`](Segment.md)[]\> - -A promise resolving to an array of detected audio segments (e.g., timestamps for speech). - -#### Throws - -If the model is not loaded or is currently processing another request. diff --git a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md deleted file mode 100644 index 59a2ec3969..0000000000 --- a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md +++ /dev/null @@ -1,67 +0,0 @@ -# Interface: VerticalOCRProps - -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. - -## Extends - -- [`OCRProps`](OCRProps.md) - -## Properties - -### independentCharacters? - -> `optional` **independentCharacters**: `boolean` - -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`. - ---- - -### model - -> **model**: `object` - -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. - -#### detectorSource - -> **detectorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` that specifies the location of the text detector model binary. - -#### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -The language configuration enum for the OCR model (e.g., English, Polish, etc.). - -#### recognizerSource - -> **recognizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` that specifies the location of the text recognizer model binary. - -#### Inherited from - -[`OCRProps`](OCRProps.md).[`model`](OCRProps.md#model) - ---- - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -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`. - -#### Inherited from - -[`OCRProps`](OCRProps.md).[`preventLoad`](OCRProps.md#preventload) diff --git a/docs/docs/06-api-reference/interfaces/VoiceConfig.md b/docs/docs/06-api-reference/interfaces/VoiceConfig.md deleted file mode 100644 index 0bfbc1d011..0000000000 --- a/docs/docs/06-api-reference/interfaces/VoiceConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: VoiceConfig - -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 - -So far in Kokoro, each voice is directly associated with a language. - -## Properties - -### extra? - -> `optional` **extra**: [`KokoroVoiceExtras`](KokoroVoiceExtras.md) - -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 - ---- - -### lang - -> **lang**: [`TextToSpeechLanguage`](../type-aliases/TextToSpeechLanguage.md) - -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 - ---- - -### voiceSource - -> **voiceSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -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 deleted file mode 100644 index 79c262948b..0000000000 --- a/docs/docs/06-api-reference/interfaces/Word.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: Word - -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. - -## Properties - -### end - -> **end**: `number` - -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). - ---- - -### start - -> **start**: `number` - -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). - ---- - -### word - -> **word**: `string` - -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 deleted file mode 100644 index 0e6b55b376..0000000000 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/calculateDownloadProgress.md +++ /dev/null @@ -1,50 +0,0 @@ -# Function: calculateDownloadProgress() - -> **calculateDownloadProgress**(`totalLength`, `previousFilesTotalLength`, `currentFileLength`, `setProgress`): (`progress`) => `void` - -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. - -## Parameters - -### totalLength - -`number` - -The total size of all files in the download batch. - -### previousFilesTotalLength - -`number` - -The sum of sizes of files already downloaded. - -### currentFileLength - -`number` - -The size of the file currently being downloaded. - -### setProgress - -(`downloadProgress`) => `void` - -The main callback to update the global progress. - -## Returns - -A function that accepts the progress (0-1) of the current file. - -> (`progress`): `void` - -### Parameters - -#### progress - -`number` - -### Returns - -`void` 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 deleted file mode 100644 index 42704f548b..0000000000 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/getFilenameFromUri.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: getFilenameFromUri() - -> **getFilenameFromUri**(`uri`): `string` - -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. - -## Parameters - -### uri - -`string` - -The source URI. - -## Returns - -`string` - -A sanitized filename string. 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 deleted file mode 100644 index 927eed1db8..0000000000 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/hashObject.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: hashObject() - -> **hashObject**(`jsonString`): `string` - -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. - -## Parameters - -### jsonString - -`string` - -The stringified JSON object to hash. - -## Returns - -`string` - -The resulting hash as a string. 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 deleted file mode 100644 index bada306c66..0000000000 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/removeFilePrefix.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: removeFilePrefix() - -> **removeFilePrefix**(`uri`): `string` - -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. - -## Parameters - -### uri - -`string` - -The URI to process. - -## Returns - -`string` - -The URI without the 'file://' prefix. 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 deleted file mode 100644 index 7a0dba6170..0000000000 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/functions/triggerHuggingFaceDownloadCounter.md +++ /dev/null @@ -1,20 +0,0 @@ -# Function: triggerHuggingFaceDownloadCounter() - -> **triggerHuggingFaceDownloadCounter**(`uri`): `Promise`\<`void`\> - -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 - -## Parameters - -### uri - -`string` - -The URI of the file being downloaded. - -## Returns - -`Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/index.md b/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/index.md deleted file mode 100644 index 6da4f1f5b4..0000000000 --- a/docs/docs/06-api-reference/react-native-executorch/namespaces/ResourceFetcherUtils/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# ResourceFetcherUtils - -Utility functions for fetching and managing resources. - -## Functions - -- [calculateDownloadProgress](functions/calculateDownloadProgress.md) -- [getFilenameFromUri](functions/getFilenameFromUri.md) -- [hashObject](functions/hashObject.md) -- [removeFilePrefix](functions/removeFilePrefix.md) -- [triggerHuggingFaceDownloadCounter](functions/triggerHuggingFaceDownloadCounter.md) diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md deleted file mode 100644 index 1247bb1f91..0000000000 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: LLMTool - -> **LLMTool** = `Object` - -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. -Unfortunately there's no one standard so it's hard to type it better. diff --git a/docs/docs/06-api-reference/type-aliases/LabelEnum.md b/docs/docs/06-api-reference/type-aliases/LabelEnum.md deleted file mode 100644 index d7e161150b..0000000000 --- a/docs/docs/06-api-reference/type-aliases/LabelEnum.md +++ /dev/null @@ -1,8 +0,0 @@ -# Type Alias: LabelEnum - -> **LabelEnum** = `Readonly`\<`Record`\<`string`, `number` \| `string`\>\> - -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 deleted file mode 100644 index 2a03ef04be..0000000000 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: MessageRole - -> **MessageRole** = `"user"` \| `"assistant"` \| `"system"` - -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 deleted file mode 100644 index cfc2dfcd02..0000000000 --- a/docs/docs/06-api-reference/type-aliases/ModelNameOf.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: ModelNameOf\ - -> **ModelNameOf**\<`C`\> = `C`\[`"modelName"`\] - -Defined in: [types/semanticSegmentation.ts:62](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L62) - -Extracts the model name from a [SemanticSegmentationModelSources](SemanticSegmentationModelSources.md) config object. - -## Type Parameters - -### C - -`C` _extends_ [`SemanticSegmentationModelSources`](SemanticSegmentationModelSources.md) diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md deleted file mode 100644 index 0dd89381ee..0000000000 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: OCRLanguage - -> **OCRLanguage** = keyof _typeof_ `symbols` - -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/ObjectDetectionConfig.md b/docs/docs/06-api-reference/type-aliases/ObjectDetectionConfig.md deleted file mode 100644 index 5705f34d27..0000000000 --- a/docs/docs/06-api-reference/type-aliases/ObjectDetectionConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -# Type Alias: ObjectDetectionConfig\ - -> **ObjectDetectionConfig**\<`T`\> = `object` - -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) - -Configuration for a custom object detection model. - -## Type Parameters - -### T - -`T` _extends_ [`LabelEnum`](LabelEnum.md) - -## Properties - -### labelMap - -> **labelMap**: `T` - -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) - ---- - -### preprocessorConfig? - -> `optional` **preprocessorConfig**: `object` - -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) - -#### normMean? - -> `optional` **normMean**: [`Triple`](Triple.md)\<`number`\> - -#### normStd? - -> `optional` **normStd**: [`Triple`](Triple.md)\<`number`\> diff --git a/docs/docs/06-api-reference/type-aliases/ObjectDetectionLabels.md b/docs/docs/06-api-reference/type-aliases/ObjectDetectionLabels.md deleted file mode 100644 index 21453f6aab..0000000000 --- a/docs/docs/06-api-reference/type-aliases/ObjectDetectionLabels.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: ObjectDetectionLabels\ - -> **ObjectDetectionLabels**\<`M`\> = `ResolveLabelsFor`\<`M`, `ModelConfigsType`\> - -Defined in: [modules/computer_vision/ObjectDetectionModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L42) - -Resolves the [LabelEnum](LabelEnum.md) for a given built-in object detection model name. - -## Type Parameters - -### M - -`M` _extends_ [`ObjectDetectionModelName`](ObjectDetectionModelName.md) - -A built-in model name from [ObjectDetectionModelName](ObjectDetectionModelName.md). diff --git a/docs/docs/06-api-reference/type-aliases/ObjectDetectionModelName.md b/docs/docs/06-api-reference/type-aliases/ObjectDetectionModelName.md deleted file mode 100644 index 8bfff7d4a9..0000000000 --- a/docs/docs/06-api-reference/type-aliases/ObjectDetectionModelName.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: ObjectDetectionModelName - -> **ObjectDetectionModelName** = [`ObjectDetectionModelSources`](ObjectDetectionModelSources.md)\[`"modelName"`\] - -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) - -Union of all built-in object detection model names. diff --git a/docs/docs/06-api-reference/type-aliases/ObjectDetectionModelSources.md b/docs/docs/06-api-reference/type-aliases/ObjectDetectionModelSources.md deleted file mode 100644 index 91be339999..0000000000 --- a/docs/docs/06-api-reference/type-aliases/ObjectDetectionModelSources.md +++ /dev/null @@ -1,8 +0,0 @@ -# Type Alias: ObjectDetectionModelSources - -> **ObjectDetectionModelSources** = \{ `modelName`: `"ssdlite-320-mobilenet-v3-large"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"rf-detr-nano"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} - -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) - -Per-model config for [ObjectDetectionModule.fromModelName](../classes/ObjectDetectionModule.md#frommodelname). -Each model name maps to its required fields. diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md deleted file mode 100644 index 6a956d2f90..0000000000 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: ResourceSource - -> **ResourceSource** = `string` \| `number` \| `object` - -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/SegmentationLabels.md b/docs/docs/06-api-reference/type-aliases/SegmentationLabels.md deleted file mode 100644 index 5f62875c0f..0000000000 --- a/docs/docs/06-api-reference/type-aliases/SegmentationLabels.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: SegmentationLabels\ - -> **SegmentationLabels**\<`M`\> = `ModelConfigsType`\[`M`\]\[`"labelMap"`\] - -Defined in: [modules/computer_vision/SemanticSegmentationModule.ts:58](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/SemanticSegmentationModule.ts#L58) - -Resolves the [LabelEnum](LabelEnum.md) for a given built-in model name. - -## Type Parameters - -### M - -`M` _extends_ [`SemanticSegmentationModelName`](SemanticSegmentationModelName.md) - -A built-in model name from [SemanticSegmentationModelName](SemanticSegmentationModelName.md). diff --git a/docs/docs/06-api-reference/type-aliases/SemanticSegmentationConfig.md b/docs/docs/06-api-reference/type-aliases/SemanticSegmentationConfig.md deleted file mode 100644 index 72651f4bf2..0000000000 --- a/docs/docs/06-api-reference/type-aliases/SemanticSegmentationConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -# Type Alias: SemanticSegmentationConfig\ - -> **SemanticSegmentationConfig**\<`T`\> = `object` - -Defined in: [types/semanticSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L15) - -Configuration for a custom semantic segmentation model. - -## Type Parameters - -### T - -`T` _extends_ [`LabelEnum`](LabelEnum.md) - -The [LabelEnum](LabelEnum.md) type for the model. - -## Properties - -### labelMap - -> **labelMap**: `T` - -Defined in: [types/semanticSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L16) - -The enum-like object mapping class names to indices. - ---- - -### preprocessorConfig? - -> `optional` **preprocessorConfig**: `object` - -Defined in: [types/semanticSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L17) - -Optional preprocessing parameters. - -#### normMean? - -> `optional` **normMean**: [`Triple`](Triple.md)\<`number`\> - -#### normStd? - -> `optional` **normStd**: [`Triple`](Triple.md)\<`number`\> diff --git a/docs/docs/06-api-reference/type-aliases/SemanticSegmentationModelName.md b/docs/docs/06-api-reference/type-aliases/SemanticSegmentationModelName.md deleted file mode 100644 index e99d28b750..0000000000 --- a/docs/docs/06-api-reference/type-aliases/SemanticSegmentationModelName.md +++ /dev/null @@ -1,8 +0,0 @@ -# Type Alias: SemanticSegmentationModelName - -> **SemanticSegmentationModelName** = [`SemanticSegmentationModelSources`](SemanticSegmentationModelSources.md)\[`"modelName"`\] - -Defined in: [types/semanticSegmentation.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L54) - -Union of all built-in semantic segmentation model names -(e.g. `'deeplab-v3-resnet50'`, `'selfie-segmentation'`). diff --git a/docs/docs/06-api-reference/type-aliases/SemanticSegmentationModelSources.md b/docs/docs/06-api-reference/type-aliases/SemanticSegmentationModelSources.md deleted file mode 100644 index d59e3bb041..0000000000 --- a/docs/docs/06-api-reference/type-aliases/SemanticSegmentationModelSources.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: SemanticSegmentationModelSources - -> **SemanticSegmentationModelSources** = \{ `modelName`: `"deeplab-v3-resnet50"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"deeplab-v3-resnet101"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"deeplab-v3-mobilenet-v3-large"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"lraspp-mobilenet-v3-large"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"fcn-resnet50"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"fcn-resnet101"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"deeplab-v3-resnet50-quantized"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"deeplab-v3-resnet101-quantized"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"deeplab-v3-mobilenet-v3-large-quantized"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"lraspp-mobilenet-v3-large-quantized"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"fcn-resnet50-quantized"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"fcn-resnet101-quantized"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} \| \{ `modelName`: `"selfie-segmentation"`; `modelSource`: [`ResourceSource`](ResourceSource.md); \} - -Defined in: [types/semanticSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/semanticSegmentation.ts#L27) - -Per-model config for [SemanticSegmentationModule.fromModelName](../classes/SemanticSegmentationModule.md#frommodelname). -Each model name maps to its required fields. -Add new union members here when a model needs extra sources or options. diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md deleted file mode 100644 index 5e9653afb2..0000000000 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: SpeechToTextLanguage - -> **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: [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 deleted file mode 100644 index 62ac207e19..0000000000 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: TensorBuffer - -> **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` - -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 deleted file mode 100644 index 51caa86982..0000000000 --- a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: TextToSpeechLanguage - -> **TextToSpeechLanguage** = `"en-us"` \| `"en-gb"` - -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 deleted file mode 100644 index b8d8308974..0000000000 --- a/docs/docs/06-api-reference/type-aliases/Triple.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: Triple\ - -> **Triple**\<`T`\> = readonly \[`T`, `T`, `T`\] - -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. - -## Type Parameters - -### T - -`T` diff --git a/docs/docs/06-api-reference/typedoc-sidebar.cjs b/docs/docs/06-api-reference/typedoc-sidebar.cjs deleted file mode 100644 index b465e97bf3..0000000000 --- a/docs/docs/06-api-reference/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @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/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/useSemanticSegmentation",label:"useSemanticSegmentation"},{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 - 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/LFM2_5_1_2B_INSTRUCT",label:"LFM2_5_1_2B_INSTRUCT"},{type:"doc",id:"06-api-reference/variables/LFM2_5_1_2B_INSTRUCT_QUANTIZED",label:"LFM2_5_1_2B_INSTRUCT_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/RF_DETR_NANO",label:"RF_DETR_NANO"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"}]},{type:"category",label:"Models - Semantic Segmentation",items:[{type:"doc",id:"06-api-reference/variables/DEEPLAB_V3_MOBILENET_V3_LARGE",label:"DEEPLAB_V3_MOBILENET_V3_LARGE"},{type:"doc",id:"06-api-reference/variables/DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED",label:"DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/DEEPLAB_V3_RESNET101",label:"DEEPLAB_V3_RESNET101"},{type:"doc",id:"06-api-reference/variables/DEEPLAB_V3_RESNET101_QUANTIZED",label:"DEEPLAB_V3_RESNET101_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEEPLAB_V3_RESNET50_QUANTIZED",label:"DEEPLAB_V3_RESNET50_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/FCN_RESNET101",label:"FCN_RESNET101"},{type:"doc",id:"06-api-reference/variables/FCN_RESNET101_QUANTIZED",label:"FCN_RESNET101_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/FCN_RESNET50",label:"FCN_RESNET50"},{type:"doc",id:"06-api-reference/variables/FCN_RESNET50_QUANTIZED",label:"FCN_RESNET50_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/LRASPP_MOBILENET_V3_LARGE",label:"LRASPP_MOBILENET_V3_LARGE"},{type:"doc",id:"06-api-reference/variables/LRASPP_MOBILENET_V3_LARGE_QUANTIZED",label:"LRASPP_MOBILENET_V3_LARGE_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/SELFIE_SEGMENTATION",label:"SELFIE_SEGMENTATION"}]},{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:"doc",id:"06-api-reference/interfaces/Frame",label:"Frame"},{type:"doc",id:"06-api-reference/variables/IMAGENET1K_MEAN",label:"IMAGENET1K_MEAN"},{type:"doc",id:"06-api-reference/variables/IMAGENET1K_STD",label:"IMAGENET1K_STD"}]},{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/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/PixelData",label:"PixelData"},{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/SemanticSegmentationProps",label:"SemanticSegmentationProps"},{type:"doc",id:"06-api-reference/interfaces/SemanticSegmentationType",label:"SemanticSegmentationType"},{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/TextToSpeechPhonemeInput",label:"TextToSpeechPhonemeInput"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechProps",label:"TextToSpeechProps"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechStreamingCallbacks",label:"TextToSpeechStreamingCallbacks"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechStreamingInput",label:"TextToSpeechStreamingInput"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechStreamingPhonemeInput",label:"TextToSpeechStreamingPhonemeInput"},{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/ObjectDetectionConfig",label:"ObjectDetectionConfig"},{type:"doc",id:"06-api-reference/type-aliases/ObjectDetectionLabels",label:"ObjectDetectionLabels"},{type:"doc",id:"06-api-reference/type-aliases/ObjectDetectionModelName",label:"ObjectDetectionModelName"},{type:"doc",id:"06-api-reference/type-aliases/ObjectDetectionModelSources",label:"ObjectDetectionModelSources"},{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/SegmentationLabels",label:"SegmentationLabels"},{type:"doc",id:"06-api-reference/type-aliases/SemanticSegmentationConfig",label:"SemanticSegmentationConfig"},{type:"doc",id:"06-api-reference/type-aliases/SemanticSegmentationModelName",label:"SemanticSegmentationModelName"},{type:"doc",id:"06-api-reference/type-aliases/SemanticSegmentationModelSources",label:"SemanticSegmentationModelSources"},{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/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/SemanticSegmentationModule",label:"SemanticSegmentationModule"},{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 deleted file mode 100644 index dfd9f28911..0000000000 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: ALL_MINILM_L6_V2 - -> `const` **ALL_MINILM_L6_V2**: `object` - -Defined in: [constants/modelUrls.ts:695](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L695) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `ALL_MINILM_L6_V2_MODEL` - -### tokenizerSource - -> **tokenizerSource**: `string` = `ALL_MINILM_L6_V2_TOKENIZER` 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 deleted file mode 100644 index cb51bee2de..0000000000 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: ALL_MPNET_BASE_V2 - -> `const` **ALL_MPNET_BASE_V2**: `object` - -Defined in: [constants/modelUrls.ts:703](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L703) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `ALL_MPNET_BASE_V2_MODEL` - -### tokenizerSource - -> **tokenizerSource**: `string` = `ALL_MPNET_BASE_V2_TOKENIZER` 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 deleted file mode 100644 index bd2a89eba9..0000000000 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ /dev/null @@ -1,27 +0,0 @@ -# Variable: BK_SDM_TINY_VPRED_256 - -> `const` **BK_SDM_TINY_VPRED_256**: `object` - -Defined in: [constants/modelUrls.ts:748](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L748) - -## Type Declaration - -### decoderSource - -> **decoderSource**: `string` - -### encoderSource - -> **encoderSource**: `string` - -### schedulerSource - -> **schedulerSource**: `string` - -### tokenizerSource - -> **tokenizerSource**: `string` - -### unetSource - -> **unetSource**: `string` 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 deleted file mode 100644 index ec21972f18..0000000000 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ /dev/null @@ -1,27 +0,0 @@ -# Variable: BK_SDM_TINY_VPRED_512 - -> `const` **BK_SDM_TINY_VPRED_512**: `object` - -Defined in: [constants/modelUrls.ts:737](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L737) - -## Type Declaration - -### decoderSource - -> **decoderSource**: `string` - -### encoderSource - -> **encoderSource**: `string` - -### schedulerSource - -> **schedulerSource**: `string` - -### tokenizerSource - -> **tokenizerSource**: `string` - -### unetSource - -> **unetSource**: `string` 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 deleted file mode 100644 index 0dc8afce7b..0000000000 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ /dev/null @@ -1,11 +0,0 @@ -# Variable: CLIP_VIT_BASE_PATCH32_IMAGE - -> `const` **CLIP_VIT_BASE_PATCH32_IMAGE**: `object` - -Defined in: [constants/modelUrls.ts:676](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L676) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `CLIP_VIT_BASE_PATCH32_IMAGE_MODEL` 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 deleted file mode 100644 index 94fc574b32..0000000000 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: CLIP_VIT_BASE_PATCH32_TEXT - -> `const` **CLIP_VIT_BASE_PATCH32_TEXT**: `object` - -Defined in: [constants/modelUrls.ts:727](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L727) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `CLIP_VIT_BASE_PATCH32_TEXT_MODEL` - -### tokenizerSource - -> **tokenizerSource**: `string` = `CLIP_VIT_BASE_PATCH32_TEXT_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/DEEPLAB_V3_MOBILENET_V3_LARGE.md b/docs/docs/06-api-reference/variables/DEEPLAB_V3_MOBILENET_V3_LARGE.md deleted file mode 100644 index e2154c4aca..0000000000 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_MOBILENET_V3_LARGE.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: DEEPLAB_V3_MOBILENET_V3_LARGE - -> `const` **DEEPLAB_V3_MOBILENET_V3_LARGE**: `object` - -Defined in: [constants/modelUrls.ts:584](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L584) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"deeplab-v3-mobilenet-v3-large"` = `'deeplab-v3-mobilenet-v3-large'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-deeplab-v3/resolve/v0.8.0/deeplab-v3-mobilenet-v3-large/xnnpack/deeplabv3_mobilenet_v3_large_xnnpack_fp32.pte"` = `DEEPLAB_V3_MOBILENET_V3_LARGE_MODEL` diff --git a/docs/docs/06-api-reference/variables/DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED.md b/docs/docs/06-api-reference/variables/DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED.md deleted file mode 100644 index 341d3f629f..0000000000 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED - -> `const` **DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED**: `object` - -Defined in: [constants/modelUrls.ts:632](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L632) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"deeplab-v3-mobilenet-v3-large-quantized"` = `'deeplab-v3-mobilenet-v3-large-quantized'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-deeplab-v3/resolve/v0.8.0/deeplab-v3-mobilenet-v3-large/xnnpack/deeplabv3_mobilenet_v3_large_xnnpack_int8.pte"` = `DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED_MODEL` diff --git a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101.md b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101.md deleted file mode 100644 index e40e1170b1..0000000000 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: DEEPLAB_V3_RESNET101 - -> `const` **DEEPLAB_V3_RESNET101**: `object` - -Defined in: [constants/modelUrls.ts:576](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L576) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"deeplab-v3-resnet101"` = `'deeplab-v3-resnet101'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-deeplab-v3/resolve/v0.8.0/deeplab-v3-resnet101/xnnpack/deeplabv3_resnet101_xnnpack_fp32.pte"` = `DEEPLAB_V3_RESNET101_MODEL` diff --git a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101_QUANTIZED.md b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101_QUANTIZED.md deleted file mode 100644 index 4d7cf74983..0000000000 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101_QUANTIZED.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: DEEPLAB_V3_RESNET101_QUANTIZED - -> `const` **DEEPLAB_V3_RESNET101_QUANTIZED**: `object` - -Defined in: [constants/modelUrls.ts:624](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L624) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"deeplab-v3-resnet101-quantized"` = `'deeplab-v3-resnet101-quantized'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-deeplab-v3/resolve/v0.8.0/deeplab-v3-resnet101/xnnpack/deeplabv3_resnet101_xnnpack_int8.pte"` = `DEEPLAB_V3_RESNET101_QUANTIZED_MODEL` diff --git a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md deleted file mode 100644 index b713260260..0000000000 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: DEEPLAB_V3_RESNET50 - -> `const` **DEEPLAB_V3_RESNET50**: `object` - -Defined in: [constants/modelUrls.ts:568](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L568) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"deeplab-v3-resnet50"` = `'deeplab-v3-resnet50'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-deeplab-v3/resolve/v0.8.0/deeplab-v3-resnet50/xnnpack/deeplabv3_resnet50_xnnpack_fp32.pte"` = `DEEPLAB_V3_RESNET50_MODEL` diff --git a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50_QUANTIZED.md b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50_QUANTIZED.md deleted file mode 100644 index c82d5bf261..0000000000 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50_QUANTIZED.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: DEEPLAB_V3_RESNET50_QUANTIZED - -> `const` **DEEPLAB_V3_RESNET50_QUANTIZED**: `object` - -Defined in: [constants/modelUrls.ts:616](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L616) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"deeplab-v3-resnet50-quantized"` = `'deeplab-v3-resnet50-quantized'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-deeplab-v3/resolve/v0.8.0/deeplab-v3-resnet50/xnnpack/deeplabv3_resnet50_xnnpack_int8.pte"` = `DEEPLAB_V3_RESNET50_QUANTIZED_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 deleted file mode 100644 index 1666a1c8bc..0000000000 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ /dev/null @@ -1,7 +0,0 @@ -# Variable: DEFAULT_CHAT_CONFIG - -> `const` **DEFAULT_CHAT_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) - -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 deleted file mode 100644 index c38006996a..0000000000 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_BUFFER_TOKENS.md +++ /dev/null @@ -1,7 +0,0 @@ -# Variable: DEFAULT_CONTEXT_BUFFER_TOKENS - -> `const` **DEFAULT_CONTEXT_BUFFER_TOKENS**: `512` = `512` - -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 deleted file mode 100644 index bec42f0005..0000000000 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ /dev/null @@ -1,7 +0,0 @@ -# Variable: DEFAULT_MESSAGE_HISTORY - -> `const` **DEFAULT_MESSAGE_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` - -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 deleted file mode 100644 index 10f772ba6b..0000000000 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ /dev/null @@ -1,7 +0,0 @@ -# Variable: DEFAULT_SYSTEM_PROMPT - -> `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: [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 deleted file mode 100644 index d1fc00ae01..0000000000 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ /dev/null @@ -1,11 +0,0 @@ -# Variable: EFFICIENTNET_V2_S - -> `const` **EFFICIENTNET_V2_S**: `object` - -Defined in: [constants/modelUrls.ts:383](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L383) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `EFFICIENTNET_V2_S_MODEL` diff --git a/docs/docs/06-api-reference/variables/FCN_RESNET101.md b/docs/docs/06-api-reference/variables/FCN_RESNET101.md deleted file mode 100644 index 07f4783d3d..0000000000 --- a/docs/docs/06-api-reference/variables/FCN_RESNET101.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: FCN_RESNET101 - -> `const` **FCN_RESNET101**: `object` - -Defined in: [constants/modelUrls.ts:608](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L608) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"fcn-resnet101"` = `'fcn-resnet101'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-fcn/resolve/v0.8.0/fcn-resnet101/xnnpack/fcn_resnet101_xnnpack_fp32.pte"` = `FCN_RESNET101_MODEL` diff --git a/docs/docs/06-api-reference/variables/FCN_RESNET101_QUANTIZED.md b/docs/docs/06-api-reference/variables/FCN_RESNET101_QUANTIZED.md deleted file mode 100644 index 377dc667aa..0000000000 --- a/docs/docs/06-api-reference/variables/FCN_RESNET101_QUANTIZED.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: FCN_RESNET101_QUANTIZED - -> `const` **FCN_RESNET101_QUANTIZED**: `object` - -Defined in: [constants/modelUrls.ts:656](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L656) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"fcn-resnet101-quantized"` = `'fcn-resnet101-quantized'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-fcn/resolve/v0.8.0/fcn-resnet101/xnnpack/fcn_resnet101_xnnpack_int8.pte"` = `FCN_RESNET101_QUANTIZED_MODEL` diff --git a/docs/docs/06-api-reference/variables/FCN_RESNET50.md b/docs/docs/06-api-reference/variables/FCN_RESNET50.md deleted file mode 100644 index 2546001f32..0000000000 --- a/docs/docs/06-api-reference/variables/FCN_RESNET50.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: FCN_RESNET50 - -> `const` **FCN_RESNET50**: `object` - -Defined in: [constants/modelUrls.ts:600](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L600) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"fcn-resnet50"` = `'fcn-resnet50'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-fcn/resolve/v0.8.0/fcn-resnet50/xnnpack/fcn_resnet50_xnnpack_fp32.pte"` = `FCN_RESNET50_MODEL` diff --git a/docs/docs/06-api-reference/variables/FCN_RESNET50_QUANTIZED.md b/docs/docs/06-api-reference/variables/FCN_RESNET50_QUANTIZED.md deleted file mode 100644 index b24a1757ef..0000000000 --- a/docs/docs/06-api-reference/variables/FCN_RESNET50_QUANTIZED.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: FCN_RESNET50_QUANTIZED - -> `const` **FCN_RESNET50_QUANTIZED**: `object` - -Defined in: [constants/modelUrls.ts:648](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L648) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"fcn-resnet50-quantized"` = `'fcn-resnet50-quantized'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-fcn/resolve/v0.8.0/fcn-resnet50/xnnpack/fcn_resnet50_xnnpack_int8.pte"` = `FCN_RESNET50_QUANTIZED_MODEL` diff --git a/docs/docs/06-api-reference/variables/FSMN_VAD.md b/docs/docs/06-api-reference/variables/FSMN_VAD.md deleted file mode 100644 index 646e2dbae8..0000000000 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ /dev/null @@ -1,11 +0,0 @@ -# Variable: FSMN_VAD - -> `const` **FSMN_VAD**: `object` - -Defined in: [constants/modelUrls.ts:762](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L762) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `FSMN_VAD_MODEL` 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 deleted file mode 100644 index c87e3a7ab4..0000000000 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: HAMMER2_1_0_5B - -> `const` **HAMMER2_1_0_5B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `HAMMER2_1_0_5B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` 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 deleted file mode 100644 index f96fd1ddc2..0000000000 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: HAMMER2_1_0_5B_QUANTIZED - -> `const` **HAMMER2_1_0_5B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `HAMMER2_1_0_5B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` 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 deleted file mode 100644 index 7f48f15e92..0000000000 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: HAMMER2_1_1_5B - -> `const` **HAMMER2_1_1_5B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `HAMMER2_1_1_5B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` 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 deleted file mode 100644 index c478c15b1c..0000000000 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: HAMMER2_1_1_5B_QUANTIZED - -> `const` **HAMMER2_1_1_5B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `HAMMER2_1_1_5B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md deleted file mode 100644 index a5adf62760..0000000000 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: HAMMER2_1_3B - -> `const` **HAMMER2_1_3B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `HAMMER2_1_3B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` 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 deleted file mode 100644 index 8e5815fffd..0000000000 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: HAMMER2_1_3B_QUANTIZED - -> `const` **HAMMER2_1_3B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `HAMMER2_1_3B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/IMAGENET1K_MEAN.md b/docs/docs/06-api-reference/variables/IMAGENET1K_MEAN.md deleted file mode 100644 index 6bd352c29a..0000000000 --- a/docs/docs/06-api-reference/variables/IMAGENET1K_MEAN.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: IMAGENET1K_MEAN - -> `const` **IMAGENET1K_MEAN**: [`Triple`](../type-aliases/Triple.md)\<`number`\> - -Defined in: [constants/commonVision.ts:3](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L3) diff --git a/docs/docs/06-api-reference/variables/IMAGENET1K_STD.md b/docs/docs/06-api-reference/variables/IMAGENET1K_STD.md deleted file mode 100644 index 4d7e72b620..0000000000 --- a/docs/docs/06-api-reference/variables/IMAGENET1K_STD.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: IMAGENET1K_STD - -> `const` **IMAGENET1K_STD**: [`Triple`](../type-aliases/Triple.md)\<`number`\> - -Defined in: [constants/commonVision.ts:4](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/commonVision.ts#L4) diff --git a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md deleted file mode 100644 index cb5913cbe4..0000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md +++ /dev/null @@ -1,21 +0,0 @@ -# Variable: KOKORO_MEDIUM - -> `const` **KOKORO_MEDIUM**: `object` - -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. - -## Type Declaration - -### durationPredictorSource - -> **durationPredictorSource**: `string` - -### synthesizerSource - -> **synthesizerSource**: `string` - -### type - -> **type**: `"kokoro"` diff --git a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md deleted file mode 100644 index 098f4f631d..0000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md +++ /dev/null @@ -1,23 +0,0 @@ -# Variable: KOKORO_SMALL - -> `const` **KOKORO_SMALL**: `object` - -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 -a lower quality speech due to forced, aggressive text splitting. - -## Type Declaration - -### durationPredictorSource - -> **durationPredictorSource**: `string` - -### synthesizerSource - -> **synthesizerSource**: `string` - -### type - -> **type**: `"kokoro"` 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 deleted file mode 100644 index 634fedb9f2..0000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: KOKORO_VOICE_AF_HEART - -> `const` **KOKORO_VOICE_AF_HEART**: [`VoiceConfig`](../interfaces/VoiceConfig.md) - -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 deleted file mode 100644 index 718229b655..0000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: KOKORO_VOICE_AF_RIVER - -> `const` **KOKORO_VOICE_AF_RIVER**: [`VoiceConfig`](../interfaces/VoiceConfig.md) - -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 deleted file mode 100644 index 0a9a242730..0000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: KOKORO_VOICE_AF_SARAH - -> `const` **KOKORO_VOICE_AF_SARAH**: [`VoiceConfig`](../interfaces/VoiceConfig.md) - -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 deleted file mode 100644 index 336bce9ad1..0000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: KOKORO_VOICE_AM_ADAM - -> `const` **KOKORO_VOICE_AM_ADAM**: [`VoiceConfig`](../interfaces/VoiceConfig.md) - -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 deleted file mode 100644 index 337ddbf601..0000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: KOKORO_VOICE_AM_MICHAEL - -> `const` **KOKORO_VOICE_AM_MICHAEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) - -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 deleted file mode 100644 index a9884a680b..0000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: KOKORO_VOICE_AM_SANTA - -> `const` **KOKORO_VOICE_AM_SANTA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) - -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 deleted file mode 100644 index 9b28f60b94..0000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: KOKORO_VOICE_BF_EMMA - -> `const` **KOKORO_VOICE_BF_EMMA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) - -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 deleted file mode 100644 index 90eaa42dde..0000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: KOKORO_VOICE_BM_DANIEL - -> `const` **KOKORO_VOICE_BM_DANIEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) - -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/LFM2_5_1_2B_INSTRUCT.md b/docs/docs/06-api-reference/variables/LFM2_5_1_2B_INSTRUCT.md deleted file mode 100644 index 9340462347..0000000000 --- a/docs/docs/06-api-reference/variables/LFM2_5_1_2B_INSTRUCT.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: LFM2_5_1_2B_INSTRUCT - -> `const` **LFM2_5_1_2B_INSTRUCT**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `LFM2_5_1_2B_INSTRUCT_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `LFM2_5_1_2B_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `LFM2_5_1_2B_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/LFM2_5_1_2B_INSTRUCT_QUANTIZED.md b/docs/docs/06-api-reference/variables/LFM2_5_1_2B_INSTRUCT_QUANTIZED.md deleted file mode 100644 index 2854374cd5..0000000000 --- a/docs/docs/06-api-reference/variables/LFM2_5_1_2B_INSTRUCT_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: LFM2_5_1_2B_INSTRUCT_QUANTIZED - -> `const` **LFM2_5_1_2B_INSTRUCT_QUANTIZED**: `object` - -Defined in: [constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L368) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `LFM2_5_1_2B_INSTRUCT_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `LFM2_5_1_2B_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `LFM2_5_1_2B_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md deleted file mode 100644 index ba19386eed..0000000000 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: LLAMA3_2_1B - -> `const` **LLAMA3_2_1B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `LLAMA3_2_1B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` 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 deleted file mode 100644 index 509a28ab09..0000000000 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: LLAMA3_2_1B_QLORA - -> `const` **LLAMA3_2_1B_QLORA**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `LLAMA3_2_1B_QLORA_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` 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 deleted file mode 100644 index 26bd6ae6d9..0000000000 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: LLAMA3_2_1B_SPINQUANT - -> `const` **LLAMA3_2_1B_SPINQUANT**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `LLAMA3_2_1B_SPINQUANT_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md deleted file mode 100644 index 792f3c5c9a..0000000000 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: LLAMA3_2_3B - -> `const` **LLAMA3_2_3B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `LLAMA3_2_3B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` 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 deleted file mode 100644 index eb0adfbba2..0000000000 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: LLAMA3_2_3B_QLORA - -> `const` **LLAMA3_2_3B_QLORA**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `LLAMA3_2_3B_QLORA_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` 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 deleted file mode 100644 index fb9d2c05ca..0000000000 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: LLAMA3_2_3B_SPINQUANT - -> `const` **LLAMA3_2_3B_SPINQUANT**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `LLAMA3_2_3B_SPINQUANT_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/LRASPP_MOBILENET_V3_LARGE.md b/docs/docs/06-api-reference/variables/LRASPP_MOBILENET_V3_LARGE.md deleted file mode 100644 index 1ad79ff022..0000000000 --- a/docs/docs/06-api-reference/variables/LRASPP_MOBILENET_V3_LARGE.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: LRASPP_MOBILENET_V3_LARGE - -> `const` **LRASPP_MOBILENET_V3_LARGE**: `object` - -Defined in: [constants/modelUrls.ts:592](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L592) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"lraspp-mobilenet-v3-large"` = `'lraspp-mobilenet-v3-large'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-lraspp/resolve/v0.8.0/xnnpack/lraspp_mobilenet_v3_large_xnnpack_fp32.pte"` = `LRASPP_MOBILENET_V3_LARGE_MODEL` diff --git a/docs/docs/06-api-reference/variables/LRASPP_MOBILENET_V3_LARGE_QUANTIZED.md b/docs/docs/06-api-reference/variables/LRASPP_MOBILENET_V3_LARGE_QUANTIZED.md deleted file mode 100644 index 0f5e16f41e..0000000000 --- a/docs/docs/06-api-reference/variables/LRASPP_MOBILENET_V3_LARGE_QUANTIZED.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: LRASPP_MOBILENET_V3_LARGE_QUANTIZED - -> `const` **LRASPP_MOBILENET_V3_LARGE_QUANTIZED**: `object` - -Defined in: [constants/modelUrls.ts:640](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L640) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"lraspp-mobilenet-v3-large-quantized"` = `'lraspp-mobilenet-v3-large-quantized'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-lraspp/resolve/v0.8.0/xnnpack/lraspp_mobilenet_v3_large_xnnpack_int8.pte"` = `LRASPP_MOBILENET_V3_LARGE_QUANTIZED_MODEL` 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 deleted file mode 100644 index a7378ea8a3..0000000000 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: MULTI_QA_MINILM_L6_COS_V1 - -> `const` **MULTI_QA_MINILM_L6_COS_V1**: `object` - -Defined in: [constants/modelUrls.ts:711](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L711) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `MULTI_QA_MINILM_L6_COS_V1_MODEL` - -### tokenizerSource - -> **tokenizerSource**: `string` = `MULTI_QA_MINILM_L6_COS_V1_TOKENIZER` 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 deleted file mode 100644 index 0c22cb2b9e..0000000000 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: MULTI_QA_MPNET_BASE_DOT_V1 - -> `const` **MULTI_QA_MPNET_BASE_DOT_V1**: `object` - -Defined in: [constants/modelUrls.ts:719](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L719) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `MULTI_QA_MPNET_BASE_DOT_V1_MODEL` - -### tokenizerSource - -> **tokenizerSource**: `string` = `MULTI_QA_MPNET_BASE_DOT_V1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md deleted file mode 100644 index fef48f0213..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_ABAZA - -> `const` **OCR_ABAZA**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md deleted file mode 100644 index 7648f0e5ff..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_ADYGHE - -> `const` **OCR_ADYGHE**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md deleted file mode 100644 index a7fe470b89..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_AFRIKAANS - -> `const` **OCR_AFRIKAANS**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md deleted file mode 100644 index 8812c4d9cd..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_ALBANIAN - -> `const` **OCR_ALBANIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md deleted file mode 100644 index 3f0636de5e..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_AVAR - -> `const` **OCR_AVAR**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md deleted file mode 100644 index a0661a6ff8..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_AZERBAIJANI - -> `const` **OCR_AZERBAIJANI**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md deleted file mode 100644 index f6c87ab1c5..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_BELARUSIAN - -> `const` **OCR_BELARUSIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md deleted file mode 100644 index 1ebdd507ca..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_BOSNIAN - -> `const` **OCR_BOSNIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md deleted file mode 100644 index 56e2d0ceca..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_BULGARIAN - -> `const` **OCR_BULGARIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md deleted file mode 100644 index 93d71ef8a5..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_CHECHEN - -> `const` **OCR_CHECHEN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md deleted file mode 100644 index 44ab528a4c..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_CROATIAN - -> `const` **OCR_CROATIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md deleted file mode 100644 index fc3b62d4d0..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_CZECH - -> `const` **OCR_CZECH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md deleted file mode 100644 index a154758814..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_DANISH - -> `const` **OCR_DANISH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md deleted file mode 100644 index c8836b4ae3..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_DARGWA - -> `const` **OCR_DARGWA**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md deleted file mode 100644 index 2f33d3ba79..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_DUTCH - -> `const` **OCR_DUTCH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md deleted file mode 100644 index 594ffe9518..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_ENGLISH - -> `const` **OCR_ENGLISH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md deleted file mode 100644 index 916aca8375..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_ESTONIAN - -> `const` **OCR_ESTONIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md deleted file mode 100644 index 9698e383c2..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_FRENCH - -> `const` **OCR_FRENCH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md deleted file mode 100644 index a664bd2639..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_GERMAN - -> `const` **OCR_GERMAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md deleted file mode 100644 index 536756310a..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_HUNGARIAN - -> `const` **OCR_HUNGARIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md deleted file mode 100644 index 5a219bda50..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_ICELANDIC - -> `const` **OCR_ICELANDIC**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md deleted file mode 100644 index e9adad3d58..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_INDONESIAN - -> `const` **OCR_INDONESIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md deleted file mode 100644 index 0a86e9f8d0..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_INGUSH - -> `const` **OCR_INGUSH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md deleted file mode 100644 index 2a323f4046..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_IRISH - -> `const` **OCR_IRISH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md deleted file mode 100644 index fa26171452..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_ITALIAN - -> `const` **OCR_ITALIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md deleted file mode 100644 index 97dcab0188..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_JAPANESE - -> `const` **OCR_JAPANESE**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md deleted file mode 100644 index fc3b792d17..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_KANNADA - -> `const` **OCR_KANNADA**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md deleted file mode 100644 index 6418b51715..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_KARBADIAN - -> `const` **OCR_KARBADIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md deleted file mode 100644 index 50b82b93ad..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_KOREAN - -> `const` **OCR_KOREAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md deleted file mode 100644 index 8ecc9099bd..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_KURDISH - -> `const` **OCR_KURDISH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md deleted file mode 100644 index b285759cd4..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_LAK - -> `const` **OCR_LAK**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md deleted file mode 100644 index e2d54f19d3..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_LATIN - -> `const` **OCR_LATIN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md deleted file mode 100644 index ebd4832522..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_LATVIAN - -> `const` **OCR_LATVIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md deleted file mode 100644 index 23c7f25611..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_LEZGHIAN - -> `const` **OCR_LEZGHIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md deleted file mode 100644 index 52e87ca781..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_LITHUANIAN - -> `const` **OCR_LITHUANIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md deleted file mode 100644 index f7b507731b..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_MALAY - -> `const` **OCR_MALAY**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md deleted file mode 100644 index 7fbb990ca4..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_MALTESE - -> `const` **OCR_MALTESE**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md deleted file mode 100644 index 448736ae12..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_MAORI - -> `const` **OCR_MAORI**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md deleted file mode 100644 index ab60aef783..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_MONGOLIAN - -> `const` **OCR_MONGOLIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md deleted file mode 100644 index 251dde90af..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_NORWEGIAN - -> `const` **OCR_NORWEGIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md deleted file mode 100644 index 8140561b08..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_OCCITAN - -> `const` **OCR_OCCITAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md deleted file mode 100644 index 906364c00b..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_PALI - -> `const` **OCR_PALI**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md deleted file mode 100644 index ccd12ff6b9..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_POLISH - -> `const` **OCR_POLISH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md deleted file mode 100644 index cd8987230b..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_PORTUGUESE - -> `const` **OCR_PORTUGUESE**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md deleted file mode 100644 index 58052f9452..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_ROMANIAN - -> `const` **OCR_ROMANIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md deleted file mode 100644 index 3e76f334b8..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_RUSSIAN - -> `const` **OCR_RUSSIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md deleted file mode 100644 index 4ff34c72f4..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_SERBIAN_CYRILLIC - -> `const` **OCR_SERBIAN_CYRILLIC**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md deleted file mode 100644 index 4c9d21a7cb..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_SERBIAN_LATIN - -> `const` **OCR_SERBIAN_LATIN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md deleted file mode 100644 index 631e7f80b4..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_SIMPLIFIED_CHINESE - -> `const` **OCR_SIMPLIFIED_CHINESE**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md deleted file mode 100644 index c27a61484a..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_SLOVAK - -> `const` **OCR_SLOVAK**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md deleted file mode 100644 index 2d76050f43..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_SLOVENIAN - -> `const` **OCR_SLOVENIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md deleted file mode 100644 index d9c3ecd041..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_SPANISH - -> `const` **OCR_SPANISH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md deleted file mode 100644 index 45aa67e60c..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_SWAHILI - -> `const` **OCR_SWAHILI**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md deleted file mode 100644 index 564ffa0ed0..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_SWEDISH - -> `const` **OCR_SWEDISH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md deleted file mode 100644 index 15b94d72d0..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_TABASSARAN - -> `const` **OCR_TABASSARAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md deleted file mode 100644 index 91496254d2..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_TAGALOG - -> `const` **OCR_TAGALOG**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md deleted file mode 100644 index a448882adc..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_TAJIK - -> `const` **OCR_TAJIK**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md deleted file mode 100644 index 0d767de822..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_TELUGU - -> `const` **OCR_TELUGU**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md deleted file mode 100644 index f48ea3cd87..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_TURKISH - -> `const` **OCR_TURKISH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md deleted file mode 100644 index 55ec639251..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_UKRAINIAN - -> `const` **OCR_UKRAINIAN**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md deleted file mode 100644 index 77b0185ca9..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_UZBEK - -> `const` **OCR_UZBEK**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md deleted file mode 100644 index c47d7e8df8..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_VIETNAMESE - -> `const` **OCR_VIETNAMESE**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md deleted file mode 100644 index 3086be6cec..0000000000 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: OCR_WELSH - -> `const` **OCR_WELSH**: `object` - -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 - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` 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 deleted file mode 100644 index ad438ab3df..0000000000 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: PHI_4_MINI_4B - -> `const` **PHI_4_MINI_4B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `PHI_4_MINI_4B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `PHI_4_MINI_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `PHI_4_MINI_TOKENIZER` 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 deleted file mode 100644 index f85068fd3b..0000000000 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: PHI_4_MINI_4B_QUANTIZED - -> `const` **PHI_4_MINI_4B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `PHI_4_MINI_4B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `PHI_4_MINI_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `PHI_4_MINI_TOKENIZER` 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 deleted file mode 100644 index 156f5dac0b..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN2_5_0_5B - -> `const` **QWEN2_5_0_5B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN2_5_0_5B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` 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 deleted file mode 100644 index aebad7bc80..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN2_5_0_5B_QUANTIZED - -> `const` **QWEN2_5_0_5B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN2_5_0_5B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` 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 deleted file mode 100644 index 8b76b6a518..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN2_5_1_5B - -> `const` **QWEN2_5_1_5B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN2_5_1_5B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` 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 deleted file mode 100644 index c8be4d14c9..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN2_5_1_5B_QUANTIZED - -> `const` **QWEN2_5_1_5B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN2_5_1_5B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md deleted file mode 100644 index 82d6c3a783..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN2_5_3B - -> `const` **QWEN2_5_3B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN2_5_3B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` 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 deleted file mode 100644 index 8469195713..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN2_5_3B_QUANTIZED - -> `const` **QWEN2_5_3B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN2_5_3B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md deleted file mode 100644 index 80b34b4661..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN3_0_6B - -> `const` **QWEN3_0_6B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN3_0_6B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` 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 deleted file mode 100644 index e5a946d5a3..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN3_0_6B_QUANTIZED - -> `const` **QWEN3_0_6B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN3_0_6B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md deleted file mode 100644 index fb941f7c64..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN3_1_7B - -> `const` **QWEN3_1_7B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN3_1_7B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` 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 deleted file mode 100644 index fc7dd7ae72..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN3_1_7B_QUANTIZED - -> `const` **QWEN3_1_7B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN3_1_7B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md deleted file mode 100644 index f11eab3439..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN3_4B - -> `const` **QWEN3_4B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN3_4B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md deleted file mode 100644 index 4345b2eb84..0000000000 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: QWEN3_4B_QUANTIZED - -> `const` **QWEN3_4B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `QWEN3_4B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/RF_DETR_NANO.md b/docs/docs/06-api-reference/variables/RF_DETR_NANO.md deleted file mode 100644 index 7a27c149db..0000000000 --- a/docs/docs/06-api-reference/variables/RF_DETR_NANO.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: RF_DETR_NANO - -> `const` **RF_DETR_NANO**: `object` - -Defined in: [constants/modelUrls.ts:402](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L402) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"rf-detr-nano"` = `'rf-detr-nano'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-rfdetr-nano-detector/resolve/v0.8.0/rfdetr_detector.pte"` = `RF_DETR_NANO_MODEL` diff --git a/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md b/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md deleted file mode 100644 index bc6f0eeef3..0000000000 --- a/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: SELFIE_SEGMENTATION - -> `const` **SELFIE_SEGMENTATION**: `object` - -Defined in: [constants/modelUrls.ts:665](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L665) - -## Type Declaration - -### modelName - -> `readonly` **modelName**: `"selfie-segmentation"` = `'selfie-segmentation'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-selfie-segmentation/resolve/v0.8.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 deleted file mode 100644 index d827c05835..0000000000 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: SMOLLM2_1_135M - -> `const` **SMOLLM2_1_135M**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `SMOLLM2_1_135M_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` 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 deleted file mode 100644 index db395e6e43..0000000000 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: SMOLLM2_1_135M_QUANTIZED - -> `const` **SMOLLM2_1_135M_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `SMOLLM2_1_135M_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` 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 deleted file mode 100644 index b44e61632c..0000000000 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: SMOLLM2_1_1_7B - -> `const` **SMOLLM2_1_1_7B**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `SMOLLM2_1_1_7B_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` 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 deleted file mode 100644 index af5bfd9a5a..0000000000 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: SMOLLM2_1_1_7B_QUANTIZED - -> `const` **SMOLLM2_1_1_7B_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `SMOLLM2_1_1_7B_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md deleted file mode 100644 index 0f8ecc7d32..0000000000 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: SMOLLM2_1_360M - -> `const` **SMOLLM2_1_360M**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `SMOLLM2_1_360M_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` 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 deleted file mode 100644 index ead0bc9967..0000000000 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: SMOLLM2_1_360M_QUANTIZED - -> `const` **SMOLLM2_1_360M_QUANTIZED**: `object` - -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 - -### modelSource - -> **modelSource**: `string` = `SMOLLM2_1_360M_QUANTIZED_MODEL` - -### tokenizerConfigSource - -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` - -### tokenizerSource - -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md deleted file mode 100644 index 0b2a1accee..0000000000 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ /dev/null @@ -1,37 +0,0 @@ -# Variable: SPECIAL_TOKENS - -> `const` **SPECIAL_TOKENS**: `object` - -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). - -## Type Declaration - -### BOS_TOKEN - -> **BOS_TOKEN**: `string` = `'bos_token'` - -### CLS_TOKEN - -> **CLS_TOKEN**: `string` = `'cls_token'` - -### EOS_TOKEN - -> **EOS_TOKEN**: `string` = `'eos_token'` - -### MASK_TOKEN - -> **MASK_TOKEN**: `string` = `'mask_token'` - -### PAD_TOKEN - -> **PAD_TOKEN**: `string` = `'pad_token'` - -### SEP_TOKEN - -> **SEP_TOKEN**: `string` = `'sep_token'` - -### UNK_TOKEN - -> **UNK_TOKEN**: `string` = `'unk_token'` 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 deleted file mode 100644 index 4c28e4ff4f..0000000000 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: SSDLITE_320_MOBILENET_V3_LARGE - -> `const` **SSDLITE_320_MOBILENET_V3_LARGE**: `object` - -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 - -### modelName - -> `readonly` **modelName**: `"ssdlite-320-mobilenet-v3-large"` = `'ssdlite-320-mobilenet-v3-large'` - -### modelSource - -> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-ssdlite320-mobilenet-v3-large/resolve/v0.7.0/ssdlite320-mobilenetv3-large.pte"` = `SSDLITE_320_MOBILENET_V3_LARGE_MODEL` diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md deleted file mode 100644 index c829796428..0000000000 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ /dev/null @@ -1,11 +0,0 @@ -# Variable: STYLE_TRANSFER_CANDY - -> `const` **STYLE_TRANSFER_CANDY**: `object` - -Defined in: [constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L428) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `STYLE_TRANSFER_CANDY_MODEL` diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md deleted file mode 100644 index f57bb8859b..0000000000 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ /dev/null @@ -1,11 +0,0 @@ -# Variable: STYLE_TRANSFER_MOSAIC - -> `const` **STYLE_TRANSFER_MOSAIC**: `object` - -Defined in: [constants/modelUrls.ts:435](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L435) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `STYLE_TRANSFER_MOSAIC_MODEL` 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 deleted file mode 100644 index 8cf07fd19b..0000000000 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ /dev/null @@ -1,11 +0,0 @@ -# Variable: STYLE_TRANSFER_RAIN_PRINCESS - -> `const` **STYLE_TRANSFER_RAIN_PRINCESS**: `object` - -Defined in: [constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L442) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `STYLE_TRANSFER_RAIN_PRINCESS_MODEL` diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md deleted file mode 100644 index 20cd7cb3bc..0000000000 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ /dev/null @@ -1,11 +0,0 @@ -# Variable: STYLE_TRANSFER_UDNIE - -> `const` **STYLE_TRANSFER_UDNIE**: `object` - -Defined in: [constants/modelUrls.ts:449](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L449) - -## Type Declaration - -### modelSource - -> **modelSource**: `string` = `STYLE_TRANSFER_UDNIE_MODEL` diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md deleted file mode 100644 index c48856a935..0000000000 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ /dev/null @@ -1,23 +0,0 @@ -# Variable: WHISPER_BASE - -> `const` **WHISPER_BASE**: `object` - -Defined in: [constants/modelUrls.ts:534](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L534) - -## Type Declaration - -### decoderSource - -> **decoderSource**: `string` = `WHISPER_BASE_DECODER_MODEL` - -### encoderSource - -> **encoderSource**: `string` = `WHISPER_BASE_ENCODER_MODEL` - -### isMultilingual - -> **isMultilingual**: `boolean` = `true` - -### tokenizerSource - -> **tokenizerSource**: `string` = `WHISPER_BASE_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md deleted file mode 100644 index ab44fad163..0000000000 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ /dev/null @@ -1,23 +0,0 @@ -# Variable: WHISPER_BASE_EN - -> `const` **WHISPER_BASE_EN**: `object` - -Defined in: [constants/modelUrls.ts:504](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L504) - -## Type Declaration - -### decoderSource - -> **decoderSource**: `string` = `WHISPER_BASE_EN_DECODER` - -### encoderSource - -> **encoderSource**: `string` = `WHISPER_BASE_EN_ENCODER` - -### isMultilingual - -> **isMultilingual**: `boolean` = `false` - -### tokenizerSource - -> **tokenizerSource**: `string` = `WHISPER_BASE_EN_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md deleted file mode 100644 index dde353cccb..0000000000 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ /dev/null @@ -1,23 +0,0 @@ -# Variable: WHISPER_SMALL - -> `const` **WHISPER_SMALL**: `object` - -Defined in: [constants/modelUrls.ts:544](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L544) - -## Type Declaration - -### decoderSource - -> **decoderSource**: `string` = `WHISPER_SMALL_DECODER_MODEL` - -### encoderSource - -> **encoderSource**: `string` = `WHISPER_SMALL_ENCODER_MODEL` - -### isMultilingual - -> **isMultilingual**: `boolean` = `true` - -### tokenizerSource - -> **tokenizerSource**: `string` = `WHISPER_SMALL_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md deleted file mode 100644 index b832832c37..0000000000 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ /dev/null @@ -1,23 +0,0 @@ -# Variable: WHISPER_SMALL_EN - -> `const` **WHISPER_SMALL_EN**: `object` - -Defined in: [constants/modelUrls.ts:514](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L514) - -## Type Declaration - -### decoderSource - -> **decoderSource**: `string` = `WHISPER_SMALL_EN_DECODER` - -### encoderSource - -> **encoderSource**: `string` = `WHISPER_SMALL_EN_ENCODER` - -### isMultilingual - -> **isMultilingual**: `boolean` = `false` - -### tokenizerSource - -> **tokenizerSource**: `string` = `WHISPER_SMALL_EN_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md deleted file mode 100644 index 27f0abd750..0000000000 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ /dev/null @@ -1,23 +0,0 @@ -# Variable: WHISPER_TINY - -> `const` **WHISPER_TINY**: `object` - -Defined in: [constants/modelUrls.ts:524](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L524) - -## Type Declaration - -### decoderSource - -> **decoderSource**: `string` = `WHISPER_TINY_DECODER_MODEL` - -### encoderSource - -> **encoderSource**: `string` = `WHISPER_TINY_ENCODER_MODEL` - -### isMultilingual - -> **isMultilingual**: `boolean` = `true` - -### tokenizerSource - -> **tokenizerSource**: `string` = `WHISPER_TINY_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md deleted file mode 100644 index b54b13ba83..0000000000 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ /dev/null @@ -1,23 +0,0 @@ -# Variable: WHISPER_TINY_EN - -> `const` **WHISPER_TINY_EN**: `object` - -Defined in: [constants/modelUrls.ts:484](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L484) - -## Type Declaration - -### decoderSource - -> **decoderSource**: `string` = `WHISPER_TINY_EN_DECODER` - -### encoderSource - -> **encoderSource**: `string` = `WHISPER_TINY_EN_ENCODER` - -### isMultilingual - -> **isMultilingual**: `boolean` = `false` - -### tokenizerSource - -> **tokenizerSource**: `string` = `WHISPER_TINY_EN_TOKENIZER` 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 deleted file mode 100644 index 29266d1b7a..0000000000 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ /dev/null @@ -1,23 +0,0 @@ -# Variable: WHISPER_TINY_EN_QUANTIZED - -> `const` **WHISPER_TINY_EN_QUANTIZED**: `object` - -Defined in: [constants/modelUrls.ts:494](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L494) - -## Type Declaration - -### decoderSource - -> **decoderSource**: `string` = `WHISPER_TINY_EN_DECODER_QUANTIZED` - -### encoderSource - -> **encoderSource**: `string` = `WHISPER_TINY_EN_ENCODER_QUANTIZED` - -### isMultilingual - -> **isMultilingual**: `boolean` = `false` - -### tokenizerSource - -> **tokenizerSource**: `string` = `WHISPER_TINY_EN_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md deleted file mode 100644 index 2492e294b0..0000000000 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ /dev/null @@ -1,21 +0,0 @@ -# Variable: parseToolCall() - -> `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] - -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. - -## Parameters - -### message - -`string` - -The message string containing tool calls in JSON format. - -## Returns - -[`ToolCall`](../interfaces/ToolCall.md)[] - -An array of `ToolCall` objects extracted from the message.