From dc7e8b74a500a34ef98db54e87a821e9647fc7e5 Mon Sep 17 00:00:00 2001 From: chmjkb Date: Thu, 5 Mar 2026 12:44:31 +0100 Subject: [PATCH 1/8] refactor!: make ClassificationModule a factory - Remove abstract load() from BaseModule (enables clean factory subclasses) - Remove no-op load() overrides from BaseLabeledModule and VisionLabeledModule - Add deps parameter to useModuleFactory, relax Config generic constraint - Update useObjectDetection and useSemanticSegmentation to pass explicit deps - Convert ClassificationModule: private constructor + static fromModelName() - Migrate useClassification from useModule to useModuleFactory Co-Authored-By: Claude Sonnet 4.6 --- .../ClassificationModule.md | 19 ++++++++------- .../computer_vision/useClassification.ts | 23 +++++++++++++------ .../computer_vision/useObjectDetection.ts | 1 + .../useSemanticSegmentation.ts | 1 + .../src/hooks/useModuleFactory.ts | 9 ++++---- .../src/modules/BaseLabeledModule.ts | 3 --- .../src/modules/BaseModule.ts | 16 +------------ .../computer_vision/ClassificationModule.ts | 21 ++++++++++------- .../computer_vision/VisionLabeledModule.ts | 3 --- 9 files changed, 45 insertions(+), 51 deletions(-) diff --git a/docs/docs/04-typescript-api/02-computer-vision/ClassificationModule.md b/docs/docs/04-typescript-api/02-computer-vision/ClassificationModule.md index df94656e7..03eca5ad8 100644 --- a/docs/docs/04-typescript-api/02-computer-vision/ClassificationModule.md +++ b/docs/docs/04-typescript-api/02-computer-vision/ClassificationModule.md @@ -19,11 +19,10 @@ import { const imageUri = 'path/to/image.png'; -// Creating an instance -const classificationModule = new ClassificationModule(); - -// Loading the model -await classificationModule.load(EFFICIENTNET_V2_S); +// Creating and loading the module +const classificationModule = await ClassificationModule.fromModelName({ + modelSource: EFFICIENTNET_V2_S, +}); // Running the model const classesWithProbabilities = await classificationModule.forward(imageUri); @@ -35,14 +34,14 @@ All methods of `ClassificationModule` are explained in details here: [`Classific ## Loading the model -To initialize the module, create an instance and call the [`load`](../../06-api-reference/classes/ClassificationModule.md#load) method with the following parameters: +To create a ready-to-use instance, call the static [`fromModelName`](../../06-api-reference/classes/ClassificationModule.md#frommodelname) factory with the following parameters: -- [`model`](../../06-api-reference/classes/ClassificationModule.md#model) - Object containing: - - [`modelSource`](../../06-api-reference/classes/ClassificationModule.md#modelsource) - Location of the used model. +- `model` - Object containing: + - `modelSource` - Location of the model binary. -- [`onDownloadProgressCallback`](../../06-api-reference/classes/ClassificationModule.md#ondownloadprogresscallback) - Callback to track download progress. +- `onDownloadProgress` - Optional callback to track download progress (value between 0 and 1). -This method returns a promise, which can resolve to an error or void. +The factory returns a promise that resolves to a loaded `ClassificationModule` instance. For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts b/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts index bee943d67..844d57b7d 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts @@ -1,9 +1,9 @@ -import { useModule } from '../useModule'; import { ClassificationModule } from '../../modules/computer_vision/ClassificationModule'; import { ClassificationProps, ClassificationType, } from '../../types/classification'; +import { useModuleFactory } from '../useModuleFactory'; /** * React hook for managing a Classification model instance. @@ -15,9 +15,18 @@ import { export const useClassification = ({ model, preventLoad = false, -}: ClassificationProps): ClassificationType => - useModule({ - module: ClassificationModule, - model, - preventLoad: preventLoad, - }); +}: ClassificationProps): ClassificationType => { + const { error, isReady, isGenerating, downloadProgress, runForward } = + useModuleFactory({ + factory: (config, onProgress) => + ClassificationModule.fromModelName(config, onProgress), + config: model, + deps: [model.modelSource], + preventLoad, + }); + + const forward = (imageSource: string) => + runForward((inst) => inst.forward(imageSource)); + + return { error, isReady, isGenerating, downloadProgress, forward }; +}; diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts b/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts index 5333b8a32..81c81ce22 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts @@ -36,6 +36,7 @@ export const useObjectDetection = ({ factory: (config, onProgress) => ObjectDetectionModule.fromModelName(config, onProgress), config: model, + deps: [model.modelName, model.modelSource], preventLoad, }); diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useSemanticSegmentation.ts b/packages/react-native-executorch/src/hooks/computer_vision/useSemanticSegmentation.ts index cad249110..dd43aaf8b 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useSemanticSegmentation.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useSemanticSegmentation.ts @@ -39,6 +39,7 @@ export const useSemanticSegmentation = < factory: (config, onProgress) => SemanticSegmentationModule.fromModelName(config, onProgress), config: model, + deps: [model.modelName, model.modelSource], preventLoad, }); diff --git a/packages/react-native-executorch/src/hooks/useModuleFactory.ts b/packages/react-native-executorch/src/hooks/useModuleFactory.ts index 2be882126..68f3e4c1c 100644 --- a/packages/react-native-executorch/src/hooks/useModuleFactory.ts +++ b/packages/react-native-executorch/src/hooks/useModuleFactory.ts @@ -14,12 +14,10 @@ type Deletable = { delete: () => void }; * * @internal */ -export function useModuleFactory< - M extends Deletable, - Config extends { modelName: string; modelSource: unknown }, ->({ +export function useModuleFactory({ factory, config, + deps, preventLoad = false, }: { factory: ( @@ -27,6 +25,7 @@ export function useModuleFactory< onProgress: (progress: number) => void ) => Promise; config: Config; + deps: ReadonlyArray; preventLoad?: boolean; }) { const [error, setError] = useState(null); @@ -58,7 +57,7 @@ export function useModuleFactory< }; // eslint-disable-next-line react-hooks/exhaustive-deps - }, [config.modelName, config.modelSource, preventLoad]); + }, [...deps, preventLoad]); const runForward = async (fn: (instance: M) => Promise): Promise => { if (!isReady || !instance) { diff --git a/packages/react-native-executorch/src/modules/BaseLabeledModule.ts b/packages/react-native-executorch/src/modules/BaseLabeledModule.ts index 6d8719b65..01678f83d 100644 --- a/packages/react-native-executorch/src/modules/BaseLabeledModule.ts +++ b/packages/react-native-executorch/src/modules/BaseLabeledModule.ts @@ -56,7 +56,4 @@ export abstract class BaseLabeledModule< this.labelMap = labelMap; this.nativeModule = nativeModule; } - - // TODO: figure it out so we can delete this (we need this because of basemodule inheritance) - override async load() {} } diff --git a/packages/react-native-executorch/src/modules/BaseModule.ts b/packages/react-native-executorch/src/modules/BaseModule.ts index 41a2da6cf..c844cf358 100644 --- a/packages/react-native-executorch/src/modules/BaseModule.ts +++ b/packages/react-native-executorch/src/modules/BaseModule.ts @@ -1,4 +1,4 @@ -import { Frame, ResourceSource } from '../types/common'; +import { Frame } from '../types/common'; import { TensorPtr } from '../types/common'; /** @@ -55,20 +55,6 @@ export abstract class BaseModule { */ public generateFromFrame!: (frameData: Frame, ...args: any[]) => any; - /** - * Load the model and prepare it for inference. - * - * @param modelSource - Resource location of the model binary - * @param onDownloadProgressCallback - Optional callback to monitor download progress (0-1) - * @param args - Additional model-specific loading arguments - */ - - abstract load( - modelSource: ResourceSource, - onDownloadProgressCallback: (_: number) => void, - ...args: any[] - ): Promise; - /** * Runs the model's forward method with the given input tensors. * It returns the output tensors that mimic the structure of output from ExecuTorch. diff --git a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts index 45b7e2b39..fa730d4cd 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts @@ -11,20 +11,25 @@ import { Logger } from '../../common/Logger'; * @category Typescript API */ export class ClassificationModule extends BaseModule { + private constructor(nativeModule: unknown) { + super(); + this.nativeModule = nativeModule; + } + /** - * 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`. + * Creates a `ClassificationModule` instance and loads the model. * * @param model - Object containing `modelSource`. - * @param onDownloadProgressCallback - Optional callback to monitor download progress. + * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). + * @returns A Promise resolving to a ready-to-use `ClassificationModule` instance. */ - async load( + static async fromModelName( model: { modelSource: ResourceSource }, - onDownloadProgressCallback: (progress: number) => void = () => {} - ): Promise { + onDownloadProgress: (progress: number) => void = () => {} + ): Promise { try { const paths = await ResourceFetcher.fetch( - onDownloadProgressCallback, + onDownloadProgress, model.modelSource ); @@ -35,7 +40,7 @@ export class ClassificationModule extends BaseModule { ); } - this.nativeModule = global.loadClassification(paths[0]); + return new ClassificationModule(global.loadClassification(paths[0])); } catch (error) { Logger.error('Load failed:', error); throw parseUnknownError(error); diff --git a/packages/react-native-executorch/src/modules/computer_vision/VisionLabeledModule.ts b/packages/react-native-executorch/src/modules/computer_vision/VisionLabeledModule.ts index 914ea6195..61a0bab09 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/VisionLabeledModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/VisionLabeledModule.ts @@ -20,7 +20,4 @@ export abstract class VisionLabeledModule< this.labelMap = labelMap; this.nativeModule = nativeModule; } - - // TODO: figure it out so we can delete this (we need this because of basemodule inheritance) - override async load() {} } From d964948d0d5394380a9e2b5ec4a8e68cfbfb404c Mon Sep 17 00:00:00 2001 From: chmjkb Date: Thu, 5 Mar 2026 12:46:47 +0100 Subject: [PATCH 2/8] refactor!: make ImageEmbeddingsModule a factory Co-Authored-By: Claude Sonnet 4.6 --- .../ImageEmbeddingsModule.md | 19 ++++++++------- .../computer_vision/useImageEmbeddings.ts | 23 +++++++++++++------ .../computer_vision/ImageEmbeddingsModule.ts | 20 ++++++++++------ 3 files changed, 38 insertions(+), 24 deletions(-) diff --git a/docs/docs/04-typescript-api/02-computer-vision/ImageEmbeddingsModule.md b/docs/docs/04-typescript-api/02-computer-vision/ImageEmbeddingsModule.md index 8c6691754..14673064c 100644 --- a/docs/docs/04-typescript-api/02-computer-vision/ImageEmbeddingsModule.md +++ b/docs/docs/04-typescript-api/02-computer-vision/ImageEmbeddingsModule.md @@ -17,11 +17,10 @@ import { CLIP_VIT_BASE_PATCH32_IMAGE, } from 'react-native-executorch'; -// Creating an instance -const imageEmbeddingsModule = new ImageEmbeddingsModule(); - -// Loading the model -await imageEmbeddingsModule.load(CLIP_VIT_BASE_PATCH32_IMAGE); +// Creating and loading the module +const imageEmbeddingsModule = await ImageEmbeddingsModule.fromModelName({ + modelSource: CLIP_VIT_BASE_PATCH32_IMAGE, +}); // Running the model const embedding = await imageEmbeddingsModule.forward( @@ -35,14 +34,14 @@ All methods of `ImageEmbeddingsModule` are explained in details here: [`ImageEmb ## Loading the model -To initialize the module, create an instance and call the [`load`](../../06-api-reference/classes/ImageEmbeddingsModule.md#load) method with the following parameters: +To create a ready-to-use instance, call the static [`fromModelName`](../../06-api-reference/classes/ImageEmbeddingsModule.md#frommodelname) factory with the following parameters: -- [`model`](../../06-api-reference/classes/ImageEmbeddingsModule.md#model) - Object containing: - - [`modelSource`](../../06-api-reference/classes/ImageEmbeddingsModule.md#modelsource) - Location of the used model. +- `model` - Object containing: + - `modelSource` - Location of the model binary. -- [`onDownloadProgressCallback`](../../06-api-reference/classes/ImageEmbeddingsModule.md#ondownloadprogresscallback) - Callback to track download progress. +- `onDownloadProgress` - Optional callback to track download progress (value between 0 and 1). -This method returns a promise, which can resolve to an error or void. +The factory returns a promise that resolves to a loaded `ImageEmbeddingsModule` instance. For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts b/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts index d5d82f68f..fa2e644fc 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts @@ -3,7 +3,7 @@ import { ImageEmbeddingsProps, ImageEmbeddingsType, } from '../../types/imageEmbeddings'; -import { useModule } from '../useModule'; +import { useModuleFactory } from '../useModuleFactory'; /** * React hook for managing an Image Embeddings model instance. @@ -15,9 +15,18 @@ import { useModule } from '../useModule'; export const useImageEmbeddings = ({ model, preventLoad = false, -}: ImageEmbeddingsProps): ImageEmbeddingsType => - useModule({ - module: ImageEmbeddingsModule, - model, - preventLoad, - }); +}: ImageEmbeddingsProps): ImageEmbeddingsType => { + const { error, isReady, isGenerating, downloadProgress, runForward } = + useModuleFactory({ + factory: (config, onProgress) => + ImageEmbeddingsModule.fromModelName(config, onProgress), + config: model, + deps: [model.modelSource], + preventLoad, + }); + + const forward = (imageSource: string) => + runForward((inst) => inst.forward(imageSource)); + + return { error, isReady, isGenerating, downloadProgress, forward }; +}; diff --git a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts index 3e62f450d..9f5dbe8a5 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts @@ -11,19 +11,25 @@ import { Logger } from '../../common/Logger'; * @category Typescript API */ export class ImageEmbeddingsModule extends BaseModule { + private constructor(nativeModule: unknown) { + super(); + this.nativeModule = nativeModule; + } + /** - * Loads the model, where `modelSource` is a string that specifies the location of the model binary. + * Creates an `ImageEmbeddingsModule` instance and loads the model. * * @param model - Object containing `modelSource`. - * @param onDownloadProgressCallback - Optional callback to monitor download progress. + * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). + * @returns A Promise resolving to a ready-to-use `ImageEmbeddingsModule` instance. */ - async load( + static async fromModelName( model: { modelSource: ResourceSource }, - onDownloadProgressCallback: (progress: number) => void = () => {} - ): Promise { + onDownloadProgress: (progress: number) => void = () => {} + ): Promise { try { const paths = await ResourceFetcher.fetch( - onDownloadProgressCallback, + onDownloadProgress, model.modelSource ); @@ -34,7 +40,7 @@ export class ImageEmbeddingsModule extends BaseModule { ); } - this.nativeModule = global.loadImageEmbeddings(paths[0]); + return new ImageEmbeddingsModule(global.loadImageEmbeddings(paths[0])); } catch (error) { Logger.error('Load failed:', error); throw parseUnknownError(error); From 919401277086d9a1fa1ed444ecad016e209f523e Mon Sep 17 00:00:00 2001 From: chmjkb Date: Thu, 5 Mar 2026 12:48:22 +0100 Subject: [PATCH 3/8] refactor!: make StyleTransferModule a factory Co-Authored-By: Claude Sonnet 4.6 --- .../02-computer-vision/StyleTransferModule.md | 19 ++++++++------- .../hooks/computer_vision/useStyleTransfer.ts | 23 +++++++++++++------ .../computer_vision/StyleTransferModule.ts | 21 ++++++++++------- 3 files changed, 38 insertions(+), 25 deletions(-) diff --git a/docs/docs/04-typescript-api/02-computer-vision/StyleTransferModule.md b/docs/docs/04-typescript-api/02-computer-vision/StyleTransferModule.md index 3f26a44bb..a3d432c75 100644 --- a/docs/docs/04-typescript-api/02-computer-vision/StyleTransferModule.md +++ b/docs/docs/04-typescript-api/02-computer-vision/StyleTransferModule.md @@ -19,11 +19,10 @@ import { const imageUri = 'path/to/image.png'; -// Creating an instance -const styleTransferModule = new StyleTransferModule(); - -// Loading the model -await styleTransferModule.load(STYLE_TRANSFER_CANDY); +// Creating and loading the module +const styleTransferModule = await StyleTransferModule.fromModelName({ + modelSource: STYLE_TRANSFER_CANDY, +}); // Running the model const generatedImageUrl = await styleTransferModule.forward(imageUri); @@ -35,14 +34,14 @@ All methods of `StyleTransferModule` are explained in details here: [`StyleTrans ## Loading the model -To load the model, create a new instance of the module and use the [`load`](../../06-api-reference/classes/StyleTransferModule.md#load) method on it. It accepts an object: +To create a ready-to-use instance, call the static [`fromModelName`](../../06-api-reference/classes/StyleTransferModule.md#frommodelname) factory with the following parameters: -- [`model`](../../06-api-reference/classes/StyleTransferModule.md#model) - Object containing: - - [`modelSource`](../../06-api-reference/classes/StyleTransferModule.md#modelsource) - Location of the used model. +- `model` - Object containing: + - `modelSource` - Location of the model binary. -- [`onDownloadProgressCallback`](../../06-api-reference/classes/StyleTransferModule.md#ondownloadprogresscallback) - Callback to track download progress. +- `onDownloadProgress` - Optional callback to track download progress (value between 0 and 1). -This method returns a promise, which can resolve to an error or void. +The factory returns a promise that resolves to a loaded `StyleTransferModule` instance. For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts b/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts index d51ff7a9e..402f54457 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts @@ -1,9 +1,9 @@ -import { useModule } from '../useModule'; import { StyleTransferModule } from '../../modules/computer_vision/StyleTransferModule'; import { StyleTransferProps, StyleTransferType, } from '../../types/styleTransfer'; +import { useModuleFactory } from '../useModuleFactory'; /** * React hook for managing a Style Transfer model instance. @@ -15,9 +15,18 @@ import { export const useStyleTransfer = ({ model, preventLoad = false, -}: StyleTransferProps): StyleTransferType => - useModule({ - module: StyleTransferModule, - model, - preventLoad: preventLoad, - }); +}: StyleTransferProps): StyleTransferType => { + const { error, isReady, isGenerating, downloadProgress, runForward } = + useModuleFactory({ + factory: (config, onProgress) => + StyleTransferModule.fromModelName(config, onProgress), + config: model, + deps: [model.modelSource], + preventLoad, + }); + + const forward = (imageSource: string) => + runForward((inst) => inst.forward(imageSource)); + + return { error, isReady, isGenerating, downloadProgress, forward }; +}; diff --git a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts b/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts index 90e5242de..860095be8 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts @@ -11,20 +11,25 @@ import { Logger } from '../../common/Logger'; * @category Typescript API */ export class StyleTransferModule extends BaseModule { + private constructor(nativeModule: unknown) { + super(); + this.nativeModule = nativeModule; + } + /** - * 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`. + * Creates a `StyleTransferModule` instance and loads the model. * * @param model - Object containing `modelSource`. - * @param onDownloadProgressCallback - Optional callback to monitor download progress. + * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). + * @returns A Promise resolving to a ready-to-use `StyleTransferModule` instance. */ - async load( + static async fromModelName( model: { modelSource: ResourceSource }, - onDownloadProgressCallback: (progress: number) => void = () => {} - ): Promise { + onDownloadProgress: (progress: number) => void = () => {} + ): Promise { try { const paths = await ResourceFetcher.fetch( - onDownloadProgressCallback, + onDownloadProgress, model.modelSource ); @@ -35,7 +40,7 @@ export class StyleTransferModule extends BaseModule { ); } - this.nativeModule = global.loadStyleTransfer(paths[0]); + return new StyleTransferModule(global.loadStyleTransfer(paths[0])); } catch (error) { Logger.error('Load failed:', error); throw parseUnknownError(error); From c312bb0fe245d9c1977b4a85c3f302e2aa8016f1 Mon Sep 17 00:00:00 2001 From: chmjkb Date: Thu, 5 Mar 2026 12:54:10 +0100 Subject: [PATCH 4/8] refactor!: make VADModule a factory Co-Authored-By: Claude Sonnet 4.6 --- .../VADModule.md | 18 +++++++-------- lefthook.yml | 1 - .../natural_language_processing/useVAD.ts | 23 +++++++++++++------ .../natural_language_processing/VADModule.ts | 21 ++++++++++------- 4 files changed, 38 insertions(+), 25 deletions(-) diff --git a/docs/docs/04-typescript-api/01-natural-language-processing/VADModule.md b/docs/docs/04-typescript-api/01-natural-language-processing/VADModule.md index aa3d14455..17b3ef233 100644 --- a/docs/docs/04-typescript-api/01-natural-language-processing/VADModule.md +++ b/docs/docs/04-typescript-api/01-natural-language-processing/VADModule.md @@ -14,10 +14,10 @@ TypeScript API implementation of the [useVAD](../../03-hooks/01-natural-language ```typescript import { VADModule, FSMN_VAD } from 'react-native-executorch'; -const model = new VADModule(); -await model.load(FSMN_VAD, (progress) => { - console.log(progress); -}); +const model = await VADModule.fromModelName( + { modelSource: FSMN_VAD }, + (progress) => console.log(progress) +); await model.forward(waveform); ``` @@ -28,14 +28,14 @@ All methods of `VADModule` are explained in details here: [`VADModule` API Refer ## Loading the model -To initialize the module, create an instance and call the [`load`](../../06-api-reference/classes/VADModule.md#load) method with the following parameters: +To create a ready-to-use instance, call the static [`fromModelName`](../../06-api-reference/classes/VADModule.md#frommodelname) factory with the following parameters: -- [`model`](../../06-api-reference/classes/VADModule.md#model) - Object containing: - - [`modelSource`](../../06-api-reference/classes/VADModule.md#modelsource) - Location of the used model. +- `model` - Object containing: + - `modelSource` - Location of the model binary. -- [`onDownloadProgressCallback`](../../06-api-reference/classes/VADModule.md#ondownloadprogresscallback) - Callback to track download progress. +- `onDownloadProgress` - Optional callback to track download progress (value between 0 and 1). -This method returns a promise, which can resolve to an error or void. +The factory returns a promise that resolves to a loaded `VADModule` instance. For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. diff --git a/lefthook.yml b/lefthook.yml index cac8c651f..74ea19fed 100644 --- a/lefthook.yml +++ b/lefthook.yml @@ -1,5 +1,4 @@ pre-commit: - parallel: true commands: lint: glob: '*.{js,ts,jsx,tsx}' diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts index abb3dca6a..bfe3b5a8a 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts @@ -1,6 +1,6 @@ -import { useModule } from '../useModule'; import { VADModule } from '../../modules/natural_language_processing/VADModule'; import { VADType, VADProps } from '../../types/vad'; +import { useModuleFactory } from '../useModuleFactory'; /** * React hook for managing a VAD model instance. @@ -9,9 +9,18 @@ import { VADType, VADProps } from '../../types/vad'; * @param VADProps - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use VAD model. */ -export const useVAD = ({ model, preventLoad = false }: VADProps): VADType => - useModule({ - module: VADModule, - model, - preventLoad: preventLoad, - }); +export const useVAD = ({ model, preventLoad = false }: VADProps): VADType => { + const { error, isReady, isGenerating, downloadProgress, runForward } = + useModuleFactory({ + factory: (config, onProgress) => + VADModule.fromModelName(config, onProgress), + config: model, + deps: [model.modelSource], + preventLoad, + }); + + const forward = (waveform: Float32Array) => + runForward((inst) => inst.forward(waveform)); + + return { error, isReady, isGenerating, downloadProgress, forward }; +}; diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts index 7039c5924..686a3e692 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts @@ -12,20 +12,25 @@ import { Logger } from '../../common/Logger'; * @category Typescript API */ export class VADModule extends BaseModule { + private constructor(nativeModule: unknown) { + super(); + this.nativeModule = nativeModule; + } + /** - * 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`. + * Creates a `VADModule` instance and loads the model. * * @param model - Object containing `modelSource`. - * @param onDownloadProgressCallback - Optional callback to monitor download progress. + * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). + * @returns A Promise resolving to a ready-to-use `VADModule` instance. */ - async load( + static async fromModelName( model: { modelSource: ResourceSource }, - onDownloadProgressCallback: (progress: number) => void = () => {} - ): Promise { + onDownloadProgress: (progress: number) => void = () => {} + ): Promise { try { const paths = await ResourceFetcher.fetch( - onDownloadProgressCallback, + onDownloadProgress, model.modelSource ); if (!paths?.[0]) { @@ -34,7 +39,7 @@ export class VADModule extends BaseModule { 'The download has been interrupted. As a result, not every file was downloaded. Please retry the download.' ); } - this.nativeModule = global.loadVAD(paths[0]); + return new VADModule(global.loadVAD(paths[0])); } catch (error) { Logger.error('Load failed:', error); throw parseUnknownError(error); From ad5b7b37a203342131b41f455c47b22bff2669dd Mon Sep 17 00:00:00 2001 From: chmjkb Date: Thu, 5 Mar 2026 13:05:59 +0100 Subject: [PATCH 5/8] feat: add modelName to all model constants for union discrimination and telemetry Co-Authored-By: Claude Sonnet 4.6 --- .../src/constants/modelUrls.ts | 166 ++++++++++++------ .../src/constants/ocr/models.ts | 1 + .../src/constants/tts/models.ts | 2 + .../computer_vision/useClassification.ts | 2 +- .../computer_vision/useImageEmbeddings.ts | 2 +- .../hooks/computer_vision/useStyleTransfer.ts | 2 +- .../useTextEmbeddings.ts | 22 ++- .../natural_language_processing/useVAD.ts | 2 +- .../computer_vision/ClassificationModule.ts | 2 +- .../computer_vision/ImageEmbeddingsModule.ts | 2 +- .../computer_vision/StyleTransferModule.ts | 2 +- .../TextEmbeddingsModule.ts | 47 ++--- .../natural_language_processing/VADModule.ts | 2 +- .../src/types/classification.ts | 2 +- .../src/types/imageEmbeddings.ts | 2 +- .../src/types/styleTransfer.ts | 2 +- .../src/types/textEmbeddings.ts | 4 + .../react-native-executorch/src/types/vad.ts | 2 +- 18 files changed, 172 insertions(+), 94 deletions(-) diff --git a/packages/react-native-executorch/src/constants/modelUrls.ts b/packages/react-native-executorch/src/constants/modelUrls.ts index e19801cfd..88640f358 100644 --- a/packages/react-native-executorch/src/constants/modelUrls.ts +++ b/packages/react-native-executorch/src/constants/modelUrls.ts @@ -17,55 +17,61 @@ const LLAMA3_2_TOKENIZER_CONFIG = `${URL_PREFIX}-llama-3.2/${VERSION_TAG}/tokeni * @category Models - LMM */ export const LLAMA3_2_3B = { + modelName: 'llama-3.2-3b', modelSource: LLAMA3_2_3B_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const LLAMA3_2_3B_QLORA = { + modelName: 'llama-3.2-3b-qlora', modelSource: LLAMA3_2_3B_QLORA_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const LLAMA3_2_3B_SPINQUANT = { + modelName: 'llama-3.2-3b-spinquant', modelSource: LLAMA3_2_3B_SPINQUANT_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const LLAMA3_2_1B = { + modelName: 'llama-3.2-1b', modelSource: LLAMA3_2_1B_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const LLAMA3_2_1B_QLORA = { + modelName: 'llama-3.2-1b-qlora', modelSource: LLAMA3_2_1B_QLORA_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const LLAMA3_2_1B_SPINQUANT = { + modelName: 'llama-3.2-1b-spinquant', modelSource: LLAMA3_2_1B_SPINQUANT_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, -}; +} as const; // QWEN 3 const QWEN3_0_6B_MODEL = `${URL_PREFIX}-qwen-3/${VERSION_TAG}/qwen-3-0.6B/original/qwen3_0_6b_bf16.pte`; @@ -81,55 +87,61 @@ const QWEN3_TOKENIZER_CONFIG = `${URL_PREFIX}-qwen-3/${VERSION_TAG}/tokenizer_co * @category Models - LMM */ export const QWEN3_0_6B = { + modelName: 'qwen3-0.6b', modelSource: QWEN3_0_6B_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const QWEN3_0_6B_QUANTIZED = { + modelName: 'qwen3-0.6b-quantized', modelSource: QWEN3_0_6B_QUANTIZED_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const QWEN3_1_7B = { + modelName: 'qwen3-1.7b', modelSource: QWEN3_1_7B_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const QWEN3_1_7B_QUANTIZED = { + modelName: 'qwen3-1.7b-quantized', modelSource: QWEN3_1_7B_QUANTIZED_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const QWEN3_4B = { + modelName: 'qwen3-4b', modelSource: QWEN3_4B_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const QWEN3_4B_QUANTIZED = { + modelName: 'qwen3-4b-quantized', modelSource: QWEN3_4B_QUANTIZED_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, -}; +} as const; // HAMMER 2.1 const HAMMER2_1_0_5B_MODEL = `${URL_PREFIX}-hammer-2.1/${VERSION_TAG}/hammer-2.1-0.5B/original/hammer2_1_0_5B_bf16.pte`; @@ -145,55 +157,61 @@ const HAMMER2_1_TOKENIZER_CONFIG = `${URL_PREFIX}-hammer-2.1/${VERSION_TAG}/toke * @category Models - LMM */ export const HAMMER2_1_0_5B = { + modelName: 'hammer2.1-0.5b', modelSource: HAMMER2_1_0_5B_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const HAMMER2_1_0_5B_QUANTIZED = { + modelName: 'hammer2.1-0.5b-quantized', modelSource: HAMMER2_1_0_5B_QUANTIZED_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const HAMMER2_1_1_5B = { + modelName: 'hammer2.1-1.5b', modelSource: HAMMER2_1_1_5B_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const HAMMER2_1_1_5B_QUANTIZED = { + modelName: 'hammer2.1-1.5b-quantized', modelSource: HAMMER2_1_1_5B_QUANTIZED_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const HAMMER2_1_3B = { + modelName: 'hammer2.1-3b', modelSource: HAMMER2_1_3B_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const HAMMER2_1_3B_QUANTIZED = { + modelName: 'hammer2.1-3b-quantized', modelSource: HAMMER2_1_3B_QUANTIZED_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, -}; +} as const; // SMOLLM2 const SMOLLM2_1_135M_MODEL = `${URL_PREFIX}-smolLm-2/${VERSION_TAG}/smolLm-2-135M/original/smolLm2_135M_bf16.pte`; @@ -209,55 +227,61 @@ const SMOLLM2_1_TOKENIZER_CONFIG = `${URL_PREFIX}-smolLm-2/${VERSION_TAG}/tokeni * @category Models - LMM */ export const SMOLLM2_1_135M = { + modelName: 'smollm2.1-135m', modelSource: SMOLLM2_1_135M_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const SMOLLM2_1_135M_QUANTIZED = { + modelName: 'smollm2.1-135m-quantized', modelSource: SMOLLM2_1_135M_QUANTIZED_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const SMOLLM2_1_360M = { + modelName: 'smollm2.1-360m', modelSource: SMOLLM2_1_360M_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const SMOLLM2_1_360M_QUANTIZED = { + modelName: 'smollm2.1-360m-quantized', modelSource: SMOLLM2_1_360M_QUANTIZED_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const SMOLLM2_1_1_7B = { + modelName: 'smollm2.1-1.7b', modelSource: SMOLLM2_1_1_7B_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const SMOLLM2_1_1_7B_QUANTIZED = { + modelName: 'smollm2.1-1.7b-quantized', modelSource: SMOLLM2_1_1_7B_QUANTIZED_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, -}; +} as const; // QWEN 2.5 const QWEN2_5_0_5B_MODEL = `${URL_PREFIX}-qwen-2.5/${VERSION_TAG}/qwen-2.5-0.5B/original/qwen2_5_0_5b_bf16.pte`; @@ -273,55 +297,61 @@ const QWEN2_5_TOKENIZER_CONFIG = `${URL_PREFIX}-qwen-2.5/${VERSION_TAG}/tokenize * @category Models - LMM */ export const QWEN2_5_0_5B = { + modelName: 'qwen2.5-0.5b', modelSource: QWEN2_5_0_5B_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const QWEN2_5_0_5B_QUANTIZED = { + modelName: 'qwen2.5-0.5b-quantized', modelSource: QWEN2_5_0_5B_QUANTIZED_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const QWEN2_5_1_5B = { + modelName: 'qwen2.5-1.5b', modelSource: QWEN2_5_1_5B_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const QWEN2_5_1_5B_QUANTIZED = { + modelName: 'qwen2.5-1.5b-quantized', modelSource: QWEN2_5_1_5B_QUANTIZED_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const QWEN2_5_3B = { + modelName: 'qwen2.5-3b', modelSource: QWEN2_5_3B_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const QWEN2_5_3B_QUANTIZED = { + modelName: 'qwen2.5-3b-quantized', modelSource: QWEN2_5_3B_QUANTIZED_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, -}; +} as const; // PHI 4 const PHI_4_MINI_4B_MODEL = `${URL_PREFIX}-phi-4-mini/${VERSION_TAG}/original/phi-4-mini_bf16.pte`; @@ -333,19 +363,21 @@ const PHI_4_MINI_TOKENIZER_CONFIG = `${URL_PREFIX}-phi-4-mini/${VERSION_TAG}/tok * @category Models - LMM */ export const PHI_4_MINI_4B = { + modelName: 'phi-4-mini-4b', modelSource: PHI_4_MINI_4B_MODEL, tokenizerSource: PHI_4_MINI_TOKENIZER, tokenizerConfigSource: PHI_4_MINI_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const PHI_4_MINI_4B_QUANTIZED = { + modelName: 'phi-4-mini-4b-quantized', modelSource: PHI_4_MINI_4B_QUANTIZED_MODEL, tokenizerSource: PHI_4_MINI_TOKENIZER, tokenizerConfigSource: PHI_4_MINI_TOKENIZER_CONFIG, -}; +} as const; // LFM2.5-1.2B-Instruct const LFM2_5_1_2B_INSTRUCT_MODEL = `${URL_PREFIX}-lfm2.5-1.2B-instruct/${NEXT_VERSION_TAG}/original/lfm2_5_1_2b_fp16.pte`; @@ -357,19 +389,21 @@ const LFM2_5_1_2B_TOKENIZER_CONFIG = `${URL_PREFIX}-lfm2.5-1.2B-instruct/${NEXT_ * @category Models - LMM */ export const LFM2_5_1_2B_INSTRUCT = { + modelName: 'lfm2.5-1.2b-instruct', modelSource: LFM2_5_1_2B_INSTRUCT_MODEL, tokenizerSource: LFM2_5_1_2B_TOKENIZER, tokenizerConfigSource: LFM2_5_1_2B_TOKENIZER_CONFIG, -}; +} as const; /** * @category Models - LMM */ export const LFM2_5_1_2B_INSTRUCT_QUANTIZED = { + modelName: 'lfm2.5-1.2b-instruct-quantized', modelSource: LFM2_5_1_2B_INSTRUCT_QUANTIZED_MODEL, tokenizerSource: LFM2_5_1_2B_TOKENIZER, tokenizerConfigSource: LFM2_5_1_2B_TOKENIZER_CONFIG, -}; +} as const; // Classification const EFFICIENTNET_V2_S_MODEL = @@ -381,8 +415,9 @@ const EFFICIENTNET_V2_S_MODEL = * @category Models - Classification */ export const EFFICIENTNET_V2_S = { + modelName: 'efficientnet-v2-s', modelSource: EFFICIENTNET_V2_S_MODEL, -}; +} as const; // Object detection const SSDLITE_320_MOBILENET_V3_LARGE_MODEL = `${URL_PREFIX}-ssdlite320-mobilenet-v3-large/${VERSION_TAG}/ssdlite320-mobilenetv3-large.pte`; @@ -426,29 +461,33 @@ const STYLE_TRANSFER_UDNIE_MODEL = * @category Models - Style Transfer */ export const STYLE_TRANSFER_CANDY = { + modelName: 'style-transfer-candy', modelSource: STYLE_TRANSFER_CANDY_MODEL, -}; +} as const; /** * @category Models - Style Transfer */ export const STYLE_TRANSFER_MOSAIC = { + modelName: 'style-transfer-mosaic', modelSource: STYLE_TRANSFER_MOSAIC_MODEL, -}; +} as const; /** * @category Models - Style Transfer */ export const STYLE_TRANSFER_RAIN_PRINCESS = { + modelName: 'style-transfer-rain-princess', modelSource: STYLE_TRANSFER_RAIN_PRINCESS_MODEL, -}; +} as const; /** * @category Models - Style Transfer */ export const STYLE_TRANSFER_UDNIE = { + modelName: 'style-transfer-udnie', modelSource: STYLE_TRANSFER_UDNIE_MODEL, -}; +} as const; // S2T const WHISPER_TINY_EN_TOKENIZER = `${URL_PREFIX}-whisper-tiny.en/${VERSION_TAG}/tokenizer.json`; @@ -482,71 +521,78 @@ const WHISPER_SMALL_DECODER_MODEL = `${URL_PREFIX}-whisper-small/${VERSION_TAG}/ * @category Models - Speech To Text */ export const WHISPER_TINY_EN = { + modelName: 'whisper-tiny-en', isMultilingual: false, encoderSource: WHISPER_TINY_EN_ENCODER, decoderSource: WHISPER_TINY_EN_DECODER, tokenizerSource: WHISPER_TINY_EN_TOKENIZER, -}; +} as const; /** * @category Models - Speech To Text */ export const WHISPER_TINY_EN_QUANTIZED = { + modelName: 'whisper-tiny-en-quantized', isMultilingual: false, encoderSource: WHISPER_TINY_EN_ENCODER_QUANTIZED, decoderSource: WHISPER_TINY_EN_DECODER_QUANTIZED, tokenizerSource: WHISPER_TINY_EN_TOKENIZER, -}; +} as const; /** * @category Models - Speech To Text */ export const WHISPER_BASE_EN = { + modelName: 'whisper-base-en', isMultilingual: false, encoderSource: WHISPER_BASE_EN_ENCODER, decoderSource: WHISPER_BASE_EN_DECODER, tokenizerSource: WHISPER_BASE_EN_TOKENIZER, -}; +} as const; /** * @category Models - Speech To Text */ export const WHISPER_SMALL_EN = { + modelName: 'whisper-small-en', isMultilingual: false, encoderSource: WHISPER_SMALL_EN_ENCODER, decoderSource: WHISPER_SMALL_EN_DECODER, tokenizerSource: WHISPER_SMALL_EN_TOKENIZER, -}; +} as const; /** * @category Models - Speech To Text */ export const WHISPER_TINY = { + modelName: 'whisper-tiny', isMultilingual: true, encoderSource: WHISPER_TINY_ENCODER_MODEL, decoderSource: WHISPER_TINY_DECODER_MODEL, tokenizerSource: WHISPER_TINY_TOKENIZER, -}; +} as const; /** * @category Models - Speech To Text */ export const WHISPER_BASE = { + modelName: 'whisper-base', isMultilingual: true, encoderSource: WHISPER_BASE_ENCODER_MODEL, decoderSource: WHISPER_BASE_DECODER_MODEL, tokenizerSource: WHISPER_BASE_TOKENIZER, -}; +} as const; /** * @category Models - Speech To Text */ export const WHISPER_SMALL = { + modelName: 'whisper-small', isMultilingual: true, encoderSource: WHISPER_SMALL_ENCODER_MODEL, decoderSource: WHISPER_SMALL_DECODER_MODEL, tokenizerSource: WHISPER_SMALL_TOKENIZER, -}; +} as const; // Semantic Segmentation const DEEPLAB_V3_RESNET50_MODEL = `${URL_PREFIX}-deeplab-v3/${NEXT_VERSION_TAG}/deeplab-v3-resnet50/xnnpack/deeplabv3_resnet50_xnnpack_fp32.pte`; @@ -659,6 +705,7 @@ export const FCN_RESNET101_QUANTIZED = { } as const; const SELFIE_SEGMENTATION_MODEL = `${URL_PREFIX}-selfie-segmentation/${NEXT_VERSION_TAG}/xnnpack/selfie-segmentation.pte`; + /** * @category Models - Semantic Segmentation */ @@ -674,8 +721,9 @@ const CLIP_VIT_BASE_PATCH32_IMAGE_MODEL = `${URL_PREFIX}-clip-vit-base-patch32/$ * @category Models - Image Embeddings */ export const CLIP_VIT_BASE_PATCH32_IMAGE = { + modelName: 'clip-vit-base-patch32-image', modelSource: CLIP_VIT_BASE_PATCH32_IMAGE_MODEL, -}; +} as const; // Text Embeddings const ALL_MINILM_L6_V2_MODEL = `${URL_PREFIX}-all-MiniLM-L6-v2/${VERSION_TAG}/all-MiniLM-L6-v2_xnnpack.pte`; @@ -693,41 +741,46 @@ const CLIP_VIT_BASE_PATCH32_TEXT_TOKENIZER = `${URL_PREFIX}-clip-vit-base-patch3 * @category Models - Text Embeddings */ export const ALL_MINILM_L6_V2 = { + modelName: 'all-minilm-l6-v2', modelSource: ALL_MINILM_L6_V2_MODEL, tokenizerSource: ALL_MINILM_L6_V2_TOKENIZER, -}; +} as const; /** * @category Models - Text Embeddings */ export const ALL_MPNET_BASE_V2 = { + modelName: 'all-mpnet-base-v2', modelSource: ALL_MPNET_BASE_V2_MODEL, tokenizerSource: ALL_MPNET_BASE_V2_TOKENIZER, -}; +} as const; /** * @category Models - Text Embeddings */ export const MULTI_QA_MINILM_L6_COS_V1 = { + modelName: 'multi-qa-minilm-l6-cos-v1', modelSource: MULTI_QA_MINILM_L6_COS_V1_MODEL, tokenizerSource: MULTI_QA_MINILM_L6_COS_V1_TOKENIZER, -}; +} as const; /** * @category Models - Text Embeddings */ export const MULTI_QA_MPNET_BASE_DOT_V1 = { + modelName: 'multi-qa-mpnet-base-dot-v1', modelSource: MULTI_QA_MPNET_BASE_DOT_V1_MODEL, tokenizerSource: MULTI_QA_MPNET_BASE_DOT_V1_TOKENIZER, -}; +} as const; /** * @category Models - Text Embeddings */ export const CLIP_VIT_BASE_PATCH32_TEXT = { + modelName: 'clip-vit-base-patch32-text', modelSource: CLIP_VIT_BASE_PATCH32_TEXT_MODEL, tokenizerSource: CLIP_VIT_BASE_PATCH32_TEXT_TOKENIZER, -}; +} as const; // Image generation @@ -735,23 +788,25 @@ export const CLIP_VIT_BASE_PATCH32_TEXT = { * @category Models - Image Generation */ export const BK_SDM_TINY_VPRED_512 = { + modelName: 'bk-sdm-tiny-vpred-512', schedulerSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/scheduler/scheduler_config.json`, tokenizerSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/tokenizer/tokenizer.json`, encoderSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/text_encoder/model.pte`, unetSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/unet/model.pte`, decoderSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/vae/model.pte`, -}; +} as const; /** * @category Models - Image Generation */ export const BK_SDM_TINY_VPRED_256 = { + modelName: 'bk-sdm-tiny-vpred-256', schedulerSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/scheduler/scheduler_config.json`, tokenizerSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/tokenizer/tokenizer.json`, encoderSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/text_encoder/model.pte`, unetSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/unet/model.256.pte`, decoderSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/vae/model.256.pte`, -}; +} as const; // Voice Activity Detection const FSMN_VAD_MODEL = `${URL_PREFIX}-fsmn-vad/${VERSION_TAG}/xnnpack/fsmn-vad_xnnpack.pte`; @@ -760,5 +815,6 @@ const FSMN_VAD_MODEL = `${URL_PREFIX}-fsmn-vad/${VERSION_TAG}/xnnpack/fsmn-vad_x * @category Models - Voice Activity Detection */ export const FSMN_VAD = { + modelName: 'fsmn-vad', modelSource: FSMN_VAD_MODEL, -}; +} as const; diff --git a/packages/react-native-executorch/src/constants/ocr/models.ts b/packages/react-native-executorch/src/constants/ocr/models.ts index 864a49a85..2a9e325c3 100644 --- a/packages/react-native-executorch/src/constants/ocr/models.ts +++ b/packages/react-native-executorch/src/constants/ocr/models.ts @@ -21,6 +21,7 @@ const createOCRObject = ( language: keyof typeof symbols ) => { return { + modelName: `ocr-${language}` as const, detectorSource: DETECTOR_CRAFT_MODEL, recognizerSource, language, diff --git a/packages/react-native-executorch/src/constants/tts/models.ts b/packages/react-native-executorch/src/constants/tts/models.ts index 96bca3842..d63f0ef16 100644 --- a/packages/react-native-executorch/src/constants/tts/models.ts +++ b/packages/react-native-executorch/src/constants/tts/models.ts @@ -13,6 +13,7 @@ const KOKORO_EN_MEDIUM_MODELS_ROOT = `${KOKORO_EN_MODELS_ROOT}/medium`; * @category Models - Text to Speech */ export const KOKORO_SMALL = { + modelName: 'kokoro-small' as const, type: 'kokoro' as const, durationPredictorSource: `${KOKORO_EN_SMALL_MODELS_ROOT}/duration_predictor.pte`, synthesizerSource: `${KOKORO_EN_SMALL_MODELS_ROOT}/synthesizer.pte`, @@ -24,6 +25,7 @@ export const KOKORO_SMALL = { * @category Models - Text to Speech */ export const KOKORO_MEDIUM = { + modelName: 'kokoro-medium' as const, type: 'kokoro' as const, durationPredictorSource: `${KOKORO_EN_MEDIUM_MODELS_ROOT}/duration_predictor.pte`, synthesizerSource: `${KOKORO_EN_MEDIUM_MODELS_ROOT}/synthesizer.pte`, diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts b/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts index 844d57b7d..c014d6b0e 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts @@ -21,7 +21,7 @@ export const useClassification = ({ factory: (config, onProgress) => ClassificationModule.fromModelName(config, onProgress), config: model, - deps: [model.modelSource], + deps: [model.modelName, model.modelSource], preventLoad, }); diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts b/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts index fa2e644fc..b4e79c926 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts @@ -21,7 +21,7 @@ export const useImageEmbeddings = ({ factory: (config, onProgress) => ImageEmbeddingsModule.fromModelName(config, onProgress), config: model, - deps: [model.modelSource], + deps: [model.modelName, model.modelSource], preventLoad, }); diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts b/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts index 402f54457..bfa42eee7 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts @@ -21,7 +21,7 @@ export const useStyleTransfer = ({ factory: (config, onProgress) => StyleTransferModule.fromModelName(config, onProgress), config: model, - deps: [model.modelSource], + deps: [model.modelName, model.modelSource], preventLoad, }); diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts index 4ffa11900..664f12caf 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts @@ -1,5 +1,5 @@ import { TextEmbeddingsModule } from '../../modules/natural_language_processing/TextEmbeddingsModule'; -import { useModule } from '../useModule'; +import { useModuleFactory } from '../useModuleFactory'; import { TextEmbeddingsType, TextEmbeddingsProps, @@ -15,9 +15,17 @@ import { export const useTextEmbeddings = ({ model, preventLoad = false, -}: TextEmbeddingsProps): TextEmbeddingsType => - useModule({ - module: TextEmbeddingsModule, - model, - preventLoad, - }); +}: TextEmbeddingsProps): TextEmbeddingsType => { + const { error, isReady, isGenerating, downloadProgress, runForward } = + useModuleFactory({ + factory: (config, onProgress) => + TextEmbeddingsModule.fromModelName(config, onProgress), + config: model, + deps: [model.modelName, model.modelSource, model.tokenizerSource], + preventLoad, + }); + + const forward = (input: string) => runForward((inst) => inst.forward(input)); + + return { error, isReady, isGenerating, downloadProgress, forward }; +}; diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts index bfe3b5a8a..3e5be0214 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts @@ -15,7 +15,7 @@ export const useVAD = ({ model, preventLoad = false }: VADProps): VADType => { factory: (config, onProgress) => VADModule.fromModelName(config, onProgress), config: model, - deps: [model.modelSource], + deps: [model.modelName, model.modelSource], preventLoad, }); diff --git a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts index fa730d4cd..e2a67dd83 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts @@ -24,7 +24,7 @@ export class ClassificationModule extends BaseModule { * @returns A Promise resolving to a ready-to-use `ClassificationModule` instance. */ static async fromModelName( - model: { modelSource: ResourceSource }, + model: { modelName: string; modelSource: ResourceSource }, onDownloadProgress: (progress: number) => void = () => {} ): Promise { try { diff --git a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts index 9f5dbe8a5..583ae09b3 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts @@ -24,7 +24,7 @@ export class ImageEmbeddingsModule extends BaseModule { * @returns A Promise resolving to a ready-to-use `ImageEmbeddingsModule` instance. */ static async fromModelName( - model: { modelSource: ResourceSource }, + model: { modelName: string; modelSource: ResourceSource }, onDownloadProgress: (progress: number) => void = () => {} ): Promise { try { diff --git a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts b/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts index 860095be8..a43b5ebd4 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts @@ -24,7 +24,7 @@ export class StyleTransferModule extends BaseModule { * @returns A Promise resolving to a ready-to-use `StyleTransferModule` instance. */ static async fromModelName( - model: { modelSource: ResourceSource }, + model: { modelName: string; modelSource: ResourceSource }, onDownloadProgress: (progress: number) => void = () => {} ): Promise { try { diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts index 855c01eef..89b721b06 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts @@ -11,30 +11,30 @@ import { Logger } from '../../common/Logger'; * @category Typescript API */ export class TextEmbeddingsModule extends BaseModule { + private constructor(nativeModule: unknown) { + super(); + this.nativeModule = nativeModule; + } + /** - * Loads the model and tokenizer specified by the config object. + * Creates a `TextEmbeddingsModule` instance and loads the model and tokenizer. * - * @param model - Object containing model and tokenizer sources. - * @param model.modelSource - `ResourceSource` that specifies the location of the text embeddings model binary. - * @param model.tokenizerSource - `ResourceSource` that specifies the location of the tokenizer JSON file. - * @param onDownloadProgressCallback - Optional callback to track download progress (value between 0 and 1). + * @param model - Object containing `modelSource` and `tokenizerSource`. + * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). + * @returns A Promise resolving to a ready-to-use `TextEmbeddingsModule` instance. */ - async load( - model: { modelSource: ResourceSource; tokenizerSource: ResourceSource }, - onDownloadProgressCallback: (progress: number) => void = () => {} - ): Promise { + static async fromModelName( + model: { + modelName: string; + modelSource: ResourceSource; + tokenizerSource: ResourceSource; + }, + onDownloadProgress: (progress: number) => void = () => {} + ): Promise { try { - const modelPromise = ResourceFetcher.fetch( - onDownloadProgressCallback, - model.modelSource - ); - const tokenizerPromise = ResourceFetcher.fetch( - undefined, - model.tokenizerSource - ); const [modelResult, tokenizerResult] = await Promise.all([ - modelPromise, - tokenizerPromise, + ResourceFetcher.fetch(onDownloadProgress, model.modelSource), + ResourceFetcher.fetch(undefined, model.tokenizerSource), ]); const modelPath = modelResult?.[0]; const tokenizerPath = tokenizerResult?.[0]; @@ -44,7 +44,9 @@ export class TextEmbeddingsModule extends BaseModule { 'The download has been interrupted. As a result, not every file was downloaded. Please retry the download.' ); } - this.nativeModule = global.loadTextEmbeddings(modelPath, tokenizerPath); + return new TextEmbeddingsModule( + global.loadTextEmbeddings(modelPath, tokenizerPath) + ); } catch (error) { Logger.error('Load failed:', error); throw parseUnknownError(error); @@ -58,6 +60,11 @@ export class TextEmbeddingsModule extends BaseModule { * @returns A Float32Array containing the vector embeddings. */ async forward(input: string): Promise { + if (this.nativeModule == null) + throw new RnExecutorchError( + RnExecutorchErrorCode.ModuleNotLoaded, + 'The model is currently not loaded. Please load the model before calling forward().' + ); return new Float32Array(await this.nativeModule.generate(input)); } } diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts index 686a3e692..c5f114d5c 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts @@ -25,7 +25,7 @@ export class VADModule extends BaseModule { * @returns A Promise resolving to a ready-to-use `VADModule` instance. */ static async fromModelName( - model: { modelSource: ResourceSource }, + model: { modelName: string; modelSource: ResourceSource }, onDownloadProgress: (progress: number) => void = () => {} ): Promise { try { diff --git a/packages/react-native-executorch/src/types/classification.ts b/packages/react-native-executorch/src/types/classification.ts index 51152ec08..9310b0a5e 100644 --- a/packages/react-native-executorch/src/types/classification.ts +++ b/packages/react-native-executorch/src/types/classification.ts @@ -10,7 +10,7 @@ import { ResourceSource } from './common'; * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. */ export interface ClassificationProps { - model: { modelSource: ResourceSource }; + model: { modelName: string; modelSource: ResourceSource }; preventLoad?: boolean; } diff --git a/packages/react-native-executorch/src/types/imageEmbeddings.ts b/packages/react-native-executorch/src/types/imageEmbeddings.ts index 5dc23d66f..ac2873333 100644 --- a/packages/react-native-executorch/src/types/imageEmbeddings.ts +++ b/packages/react-native-executorch/src/types/imageEmbeddings.ts @@ -10,7 +10,7 @@ import { ResourceSource } from './common'; * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. */ export interface ImageEmbeddingsProps { - model: { modelSource: ResourceSource }; + model: { modelName: string; modelSource: ResourceSource }; preventLoad?: boolean; } diff --git a/packages/react-native-executorch/src/types/styleTransfer.ts b/packages/react-native-executorch/src/types/styleTransfer.ts index 162086722..686913e11 100644 --- a/packages/react-native-executorch/src/types/styleTransfer.ts +++ b/packages/react-native-executorch/src/types/styleTransfer.ts @@ -10,7 +10,7 @@ import { ResourceSource } from './common'; * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. */ export interface StyleTransferProps { - model: { modelSource: ResourceSource }; + model: { modelName: string; modelSource: ResourceSource }; preventLoad?: boolean; } diff --git a/packages/react-native-executorch/src/types/textEmbeddings.ts b/packages/react-native-executorch/src/types/textEmbeddings.ts index 43bf6606d..3404aa3af 100644 --- a/packages/react-native-executorch/src/types/textEmbeddings.ts +++ b/packages/react-native-executorch/src/types/textEmbeddings.ts @@ -10,6 +10,10 @@ import { ResourceSource } from '../types/common'; */ export interface TextEmbeddingsProps { model: { + /** + * The unique name of the text embeddings model. + */ + modelName: string; /** * The source of the text embeddings model binary. */ diff --git a/packages/react-native-executorch/src/types/vad.ts b/packages/react-native-executorch/src/types/vad.ts index cf379124d..3ec52727c 100644 --- a/packages/react-native-executorch/src/types/vad.ts +++ b/packages/react-native-executorch/src/types/vad.ts @@ -10,7 +10,7 @@ import { RnExecutorchError } from '../errors/errorUtils'; * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. */ export interface VADProps { - model: { modelSource: ResourceSource }; + model: { modelName: string; modelSource: ResourceSource }; preventLoad?: boolean; } From 8dc6d8ac18d24a38c9c622ae116bfc988f555b11 Mon Sep 17 00:00:00 2001 From: chmjkb Date: Thu, 5 Mar 2026 14:06:36 +0100 Subject: [PATCH 6/8] docs: update JSDoc to document modelName field Co-Authored-By: Claude Sonnet 4.6 --- .../src/modules/computer_vision/ClassificationModule.ts | 2 +- .../src/modules/computer_vision/ImageEmbeddingsModule.ts | 2 +- .../src/modules/computer_vision/StyleTransferModule.ts | 2 +- .../natural_language_processing/TextEmbeddingsModule.ts | 2 +- .../src/modules/natural_language_processing/VADModule.ts | 2 +- packages/react-native-executorch/src/types/classification.ts | 3 ++- .../react-native-executorch/src/types/imageEmbeddings.ts | 3 ++- packages/react-native-executorch/src/types/styleTransfer.ts | 3 ++- packages/react-native-executorch/src/types/textEmbeddings.ts | 5 ++++- packages/react-native-executorch/src/types/vad.ts | 3 ++- 10 files changed, 17 insertions(+), 10 deletions(-) diff --git a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts index e2a67dd83..71e1b82de 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts @@ -19,7 +19,7 @@ export class ClassificationModule extends BaseModule { /** * Creates a `ClassificationModule` instance and loads the model. * - * @param model - Object containing `modelSource`. + * @param model - Object containing `modelName` and `modelSource`. * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). * @returns A Promise resolving to a ready-to-use `ClassificationModule` instance. */ diff --git a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts index 583ae09b3..5885de85f 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts @@ -19,7 +19,7 @@ export class ImageEmbeddingsModule extends BaseModule { /** * Creates an `ImageEmbeddingsModule` instance and loads the model. * - * @param model - Object containing `modelSource`. + * @param model - Object containing `modelName` and `modelSource`. * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). * @returns A Promise resolving to a ready-to-use `ImageEmbeddingsModule` instance. */ diff --git a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts b/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts index a43b5ebd4..532e9c15e 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts @@ -19,7 +19,7 @@ export class StyleTransferModule extends BaseModule { /** * Creates a `StyleTransferModule` instance and loads the model. * - * @param model - Object containing `modelSource`. + * @param model - Object containing `modelName` and `modelSource`. * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). * @returns A Promise resolving to a ready-to-use `StyleTransferModule` instance. */ diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts index 89b721b06..dc5b80b98 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts @@ -19,7 +19,7 @@ export class TextEmbeddingsModule extends BaseModule { /** * Creates a `TextEmbeddingsModule` instance and loads the model and tokenizer. * - * @param model - Object containing `modelSource` and `tokenizerSource`. + * @param model - Object containing `modelName`, `modelSource`, and `tokenizerSource`. * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). * @returns A Promise resolving to a ready-to-use `TextEmbeddingsModule` instance. */ diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts index c5f114d5c..693563778 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts @@ -20,7 +20,7 @@ export class VADModule extends BaseModule { /** * Creates a `VADModule` instance and loads the model. * - * @param model - Object containing `modelSource`. + * @param model - Object containing `modelName` and `modelSource`. * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). * @returns A Promise resolving to a ready-to-use `VADModule` instance. */ diff --git a/packages/react-native-executorch/src/types/classification.ts b/packages/react-native-executorch/src/types/classification.ts index 9310b0a5e..5d749c504 100644 --- a/packages/react-native-executorch/src/types/classification.ts +++ b/packages/react-native-executorch/src/types/classification.ts @@ -5,7 +5,8 @@ import { ResourceSource } from './common'; * Props for the `useClassification` hook. * * @category Types - * @property {Object} model - An object containing the model source. + * @property {Object} model - An object containing the model configuration. + * @property {string} model.modelName - Unique name identifying the model. * @property {ResourceSource} model.modelSource - The source of the classification model binary. * @property {boolean} [preventLoad] - 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/packages/react-native-executorch/src/types/imageEmbeddings.ts b/packages/react-native-executorch/src/types/imageEmbeddings.ts index ac2873333..b8b3af1d7 100644 --- a/packages/react-native-executorch/src/types/imageEmbeddings.ts +++ b/packages/react-native-executorch/src/types/imageEmbeddings.ts @@ -5,7 +5,8 @@ import { ResourceSource } from './common'; * Props for the `useImageEmbeddings` hook. * * @category Types - * @property {Object} model - An object containing the model source. + * @property {Object} model - An object containing the model configuration. + * @property {string} model.modelName - Unique name identifying the model. * @property {ResourceSource} model.modelSource - The source of the image embeddings model binary. * @property {boolean} [preventLoad] - 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/packages/react-native-executorch/src/types/styleTransfer.ts b/packages/react-native-executorch/src/types/styleTransfer.ts index 686913e11..fdf1b8c6f 100644 --- a/packages/react-native-executorch/src/types/styleTransfer.ts +++ b/packages/react-native-executorch/src/types/styleTransfer.ts @@ -5,7 +5,8 @@ import { ResourceSource } from './common'; * Configuration properties for the `useStyleTransfer` hook. * * @category Types - * @property {Object} model - Object containing the `modelSource` for the style transfer model. + * @property {Object} model - Object containing the model configuration. + * @property {string} model.modelName - Unique name identifying the model. * @property {ResourceSource} model.modelSource - `ResourceSource` that specifies the location of the style transfer model binary. * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. */ diff --git a/packages/react-native-executorch/src/types/textEmbeddings.ts b/packages/react-native-executorch/src/types/textEmbeddings.ts index 3404aa3af..c96d3fc8a 100644 --- a/packages/react-native-executorch/src/types/textEmbeddings.ts +++ b/packages/react-native-executorch/src/types/textEmbeddings.ts @@ -5,7 +5,10 @@ import { ResourceSource } from '../types/common'; * Props for the useTextEmbeddings hook. * * @category Types - * @property {Object} model - An object containing the model and tokenizer sources. + * @property {Object} model - An object containing the model configuration. + * @property {string} model.modelName - Unique name identifying the model. + * @property {ResourceSource} model.modelSource - The source of the text embeddings model binary. + * @property {ResourceSource} model.tokenizerSource - The source of the tokenizer JSON file. * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. */ export interface TextEmbeddingsProps { diff --git a/packages/react-native-executorch/src/types/vad.ts b/packages/react-native-executorch/src/types/vad.ts index 3ec52727c..dbaf56e07 100644 --- a/packages/react-native-executorch/src/types/vad.ts +++ b/packages/react-native-executorch/src/types/vad.ts @@ -5,7 +5,8 @@ import { RnExecutorchError } from '../errors/errorUtils'; * Props for the useVAD hook. * * @category Types - * @property {Object} model - An object containing the model source. + * @property {Object} model - An object containing the model configuration. + * @property {string} model.modelName - Unique name identifying the model. * @property {ResourceSource} model.modelSource - The source of the VAD model binary. * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. */ From fda71761672155e82efb5ab5a9ac2372a3c94de6 Mon Sep 17 00:00:00 2001 From: chmjkb Date: Fri, 6 Mar 2026 08:35:58 +0100 Subject: [PATCH 7/8] type fixes --- .../computer_vision/ClassificationModule.ts | 17 +++++++++-------- .../computer_vision/ImageEmbeddingsModule.ts | 17 +++++++++-------- .../computer_vision/StyleTransferModule.ts | 17 +++++++++-------- .../TextEmbeddingsModule.ts | 15 ++++++++------- .../natural_language_processing/VADModule.ts | 18 +++++++++--------- .../src/types/classification.ts | 11 +++++++++-- .../src/types/imageEmbeddings.ts | 11 +++++++++-- .../src/types/styleTransfer.ts | 15 +++++++++++++-- .../src/types/textEmbeddings.ts | 16 ++++++++++++++-- .../react-native-executorch/src/types/vad.ts | 11 +++++++++-- 10 files changed, 98 insertions(+), 50 deletions(-) diff --git a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts index 71e1b82de..da15724cf 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts @@ -1,5 +1,6 @@ import { ResourceFetcher } from '../../utils/ResourceFetcher'; import { ResourceSource } from '../../types/common'; +import { ClassificationModelName } from '../../types/classification'; import { BaseModule } from '../BaseModule'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { parseUnknownError, RnExecutorchError } from '../../errors/errorUtils'; @@ -17,14 +18,14 @@ export class ClassificationModule extends BaseModule { } /** - * Creates a `ClassificationModule` instance and loads the model. + * Creates a classification instance for a built-in model. * - * @param model - Object containing `modelName` and `modelSource`. - * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). - * @returns A Promise resolving to a ready-to-use `ClassificationModule` instance. + * @param model - An object specifying which built-in model to load and where to fetch it from. + * @param onDownloadProgress - Optional callback to monitor download progress, receiving a value between 0 and 1. + * @returns A Promise resolving to a `ClassificationModule` instance. */ static async fromModelName( - model: { modelName: string; modelSource: ResourceSource }, + model: { modelName: ClassificationModelName; modelSource: ResourceSource }, onDownloadProgress: (progress: number) => void = () => {} ): Promise { try { @@ -48,10 +49,10 @@ export class ClassificationModule extends BaseModule { } /** - * Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. + * Executes the model's forward pass to classify the provided image. * - * @param imageSource - The image source to be classified. - * @returns The classification result. + * @param imageSource - A string image source (file path, URI, or Base64). + * @returns A Promise resolving to an object mapping category labels to confidence scores. */ async forward(imageSource: string): Promise<{ [category: string]: number }> { if (this.nativeModule == null) diff --git a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts index 5885de85f..286f8da31 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts @@ -1,5 +1,6 @@ import { ResourceFetcher } from '../../utils/ResourceFetcher'; import { ResourceSource } from '../../types/common'; +import { ImageEmbeddingsModelName } from '../../types/imageEmbeddings'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { parseUnknownError, RnExecutorchError } from '../../errors/errorUtils'; import { BaseModule } from '../BaseModule'; @@ -17,14 +18,14 @@ export class ImageEmbeddingsModule extends BaseModule { } /** - * Creates an `ImageEmbeddingsModule` instance and loads the model. + * Creates an image embeddings instance for a built-in model. * - * @param model - Object containing `modelName` and `modelSource`. - * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). - * @returns A Promise resolving to a ready-to-use `ImageEmbeddingsModule` instance. + * @param model - An object specifying which built-in model to load and where to fetch it from. + * @param onDownloadProgress - Optional callback to monitor download progress, receiving a value between 0 and 1. + * @returns A Promise resolving to an `ImageEmbeddingsModule` instance. */ static async fromModelName( - model: { modelName: string; modelSource: ResourceSource }, + model: { modelName: ImageEmbeddingsModelName; modelSource: ResourceSource }, onDownloadProgress: (progress: number) => void = () => {} ): Promise { try { @@ -48,10 +49,10 @@ export class ImageEmbeddingsModule extends BaseModule { } /** - * Executes the model's forward pass. Returns an embedding array for a given sentence. + * Executes the model's forward pass to generate an embedding for the provided image. * - * @param imageSource - The image source (URI/URL) to image that will be embedded. - * @returns A Float32Array containing the image embeddings. + * @param imageSource - A string image source (file path, URI, or Base64). + * @returns A Promise resolving to a `Float32Array` containing the image embedding vector. */ async forward(imageSource: string): Promise { if (this.nativeModule == null) diff --git a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts b/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts index 532e9c15e..70dbaa074 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts @@ -1,5 +1,6 @@ import { ResourceFetcher } from '../../utils/ResourceFetcher'; import { ResourceSource } from '../../types/common'; +import { StyleTransferModelName } from '../../types/styleTransfer'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { parseUnknownError, RnExecutorchError } from '../../errors/errorUtils'; import { BaseModule } from '../BaseModule'; @@ -17,14 +18,14 @@ export class StyleTransferModule extends BaseModule { } /** - * Creates a `StyleTransferModule` instance and loads the model. + * Creates a style transfer instance for a built-in model. * - * @param model - Object containing `modelName` and `modelSource`. - * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). - * @returns A Promise resolving to a ready-to-use `StyleTransferModule` instance. + * @param model - An object specifying which built-in model to load and where to fetch it from. + * @param onDownloadProgress - Optional callback to monitor download progress, receiving a value between 0 and 1. + * @returns A Promise resolving to a `StyleTransferModule` instance. */ static async fromModelName( - model: { modelName: string; modelSource: ResourceSource }, + model: { modelName: StyleTransferModelName; modelSource: ResourceSource }, onDownloadProgress: (progress: number) => void = () => {} ): Promise { try { @@ -48,10 +49,10 @@ export class StyleTransferModule extends BaseModule { } /** - * Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. + * Executes the model's forward pass to apply the selected style to the provided image. * - * @param imageSource - The image source to be processed. - * @returns The stylized image as a Base64-encoded string. + * @param imageSource - A string image source (file path, URI, or Base64). + * @returns A Promise resolving to the stylized image as a Base64-encoded string. */ async forward(imageSource: string): Promise { if (this.nativeModule == null) diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts index dc5b80b98..1b1697627 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts @@ -1,4 +1,5 @@ import { ResourceSource } from '../../types/common'; +import { TextEmbeddingsModelName } from '../../types/textEmbeddings'; import { ResourceFetcher } from '../../utils/ResourceFetcher'; import { BaseModule } from '../BaseModule'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; @@ -17,15 +18,15 @@ export class TextEmbeddingsModule extends BaseModule { } /** - * Creates a `TextEmbeddingsModule` instance and loads the model and tokenizer. + * Creates a text embeddings instance for a built-in model. * - * @param model - Object containing `modelName`, `modelSource`, and `tokenizerSource`. - * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). - * @returns A Promise resolving to a ready-to-use `TextEmbeddingsModule` instance. + * @param model - An object specifying which built-in model to load and where to fetch it from. + * @param onDownloadProgress - Optional callback to monitor download progress, receiving a value between 0 and 1. + * @returns A Promise resolving to a `TextEmbeddingsModule` instance. */ static async fromModelName( model: { - modelName: string; + modelName: TextEmbeddingsModelName; modelSource: ResourceSource; tokenizerSource: ResourceSource; }, @@ -54,10 +55,10 @@ export class TextEmbeddingsModule extends BaseModule { } /** - * Executes the model's forward pass, where `input` is a text that will be embedded. + * Executes the model's forward pass to generate an embedding for the provided text. * * @param input - The text string to embed. - * @returns A Float32Array containing the vector embeddings. + * @returns A Promise resolving to a `Float32Array` containing the embedding vector. */ async forward(input: string): Promise { if (this.nativeModule == null) diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts index 693563778..81307e6e6 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts @@ -1,6 +1,6 @@ import { ResourceFetcher } from '../../utils/ResourceFetcher'; import { ResourceSource } from '../../types/common'; -import { Segment } from '../../types/vad'; +import { Segment, VADModelName } from '../../types/vad'; import { BaseModule } from '../BaseModule'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { parseUnknownError, RnExecutorchError } from '../../errors/errorUtils'; @@ -18,14 +18,14 @@ export class VADModule extends BaseModule { } /** - * Creates a `VADModule` instance and loads the model. + * Creates a VAD instance for a built-in model. * - * @param model - Object containing `modelName` and `modelSource`. - * @param onDownloadProgress - Optional callback to monitor download progress (value between 0 and 1). - * @returns A Promise resolving to a ready-to-use `VADModule` instance. + * @param model - An object specifying which built-in model to load and where to fetch it from. + * @param onDownloadProgress - Optional callback to monitor download progress, receiving a value between 0 and 1. + * @returns A Promise resolving to a `VADModule` instance. */ static async fromModelName( - model: { modelName: string; modelSource: ResourceSource }, + model: { modelName: VADModelName; modelSource: ResourceSource }, onDownloadProgress: (progress: number) => void = () => {} ): Promise { try { @@ -47,10 +47,10 @@ export class VADModule extends BaseModule { } /** - * Executes the model's forward pass, where `waveform` is a Float32Array representing the audio signal (16kHz). + * Executes the model's forward pass to detect speech segments within the provided audio. * - * @param waveform - The input audio waveform as a Float32Array. It must represent a mono audio signal sampled at 16kHz. - * @returns A promise resolving to an array of detected speech segments. + * @param waveform - A `Float32Array` representing a mono audio signal sampled at 16kHz. + * @returns A Promise resolving to an array of {@link Segment} objects. */ async forward(waveform: Float32Array): Promise { if (this.nativeModule == null) diff --git a/packages/react-native-executorch/src/types/classification.ts b/packages/react-native-executorch/src/types/classification.ts index 5d749c504..780be3613 100644 --- a/packages/react-native-executorch/src/types/classification.ts +++ b/packages/react-native-executorch/src/types/classification.ts @@ -1,17 +1,24 @@ import { RnExecutorchError } from '../errors/errorUtils'; import { ResourceSource } from './common'; +/** + * Union of all built-in classification model names. + * + * @category Types + */ +export type ClassificationModelName = 'efficientnet-v2-s'; + /** * Props for the `useClassification` hook. * * @category Types * @property {Object} model - An object containing the model configuration. - * @property {string} model.modelName - Unique name identifying the model. + * @property {ClassificationModelName} model.modelName - Unique name identifying the model. * @property {ResourceSource} model.modelSource - The source of the classification model binary. * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. */ export interface ClassificationProps { - model: { modelName: string; modelSource: ResourceSource }; + model: { modelName: ClassificationModelName; modelSource: ResourceSource }; preventLoad?: boolean; } diff --git a/packages/react-native-executorch/src/types/imageEmbeddings.ts b/packages/react-native-executorch/src/types/imageEmbeddings.ts index b8b3af1d7..041970e0a 100644 --- a/packages/react-native-executorch/src/types/imageEmbeddings.ts +++ b/packages/react-native-executorch/src/types/imageEmbeddings.ts @@ -1,17 +1,24 @@ import { RnExecutorchError } from '../errors/errorUtils'; import { ResourceSource } from './common'; +/** + * Union of all built-in image embeddings model names. + * + * @category Types + */ +export type ImageEmbeddingsModelName = 'clip-vit-base-patch32-image'; + /** * Props for the `useImageEmbeddings` hook. * * @category Types * @property {Object} model - An object containing the model configuration. - * @property {string} model.modelName - Unique name identifying the model. + * @property {ImageEmbeddingsModelName} model.modelName - Unique name identifying the model. * @property {ResourceSource} model.modelSource - The source of the image embeddings model binary. * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. */ export interface ImageEmbeddingsProps { - model: { modelName: string; modelSource: ResourceSource }; + model: { modelName: ImageEmbeddingsModelName; modelSource: ResourceSource }; preventLoad?: boolean; } diff --git a/packages/react-native-executorch/src/types/styleTransfer.ts b/packages/react-native-executorch/src/types/styleTransfer.ts index fdf1b8c6f..e553d9b4b 100644 --- a/packages/react-native-executorch/src/types/styleTransfer.ts +++ b/packages/react-native-executorch/src/types/styleTransfer.ts @@ -1,17 +1,28 @@ import { RnExecutorchError } from '../errors/errorUtils'; import { ResourceSource } from './common'; +/** + * Union of all built-in style transfer model names. + * + * @category Types + */ +export type StyleTransferModelName = + | 'style-transfer-candy' + | 'style-transfer-mosaic' + | 'style-transfer-rain-princess' + | 'style-transfer-udnie'; + /** * Configuration properties for the `useStyleTransfer` hook. * * @category Types * @property {Object} model - Object containing the model configuration. - * @property {string} model.modelName - Unique name identifying the model. + * @property {StyleTransferModelName} model.modelName - Unique name identifying the model. * @property {ResourceSource} model.modelSource - `ResourceSource` that specifies the location of the style transfer model binary. * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. */ export interface StyleTransferProps { - model: { modelName: string; modelSource: ResourceSource }; + model: { modelName: StyleTransferModelName; modelSource: ResourceSource }; preventLoad?: boolean; } diff --git a/packages/react-native-executorch/src/types/textEmbeddings.ts b/packages/react-native-executorch/src/types/textEmbeddings.ts index c96d3fc8a..2614bbbc4 100644 --- a/packages/react-native-executorch/src/types/textEmbeddings.ts +++ b/packages/react-native-executorch/src/types/textEmbeddings.ts @@ -1,12 +1,24 @@ import { RnExecutorchError } from '../errors/errorUtils'; import { ResourceSource } from '../types/common'; +/** + * Union of all built-in text embeddings model names. + * + * @category Types + */ +export type TextEmbeddingsModelName = + | 'all-minilm-l6-v2' + | 'all-mpnet-base-v2' + | 'multi-qa-minilm-l6-cos-v1' + | 'multi-qa-mpnet-base-dot-v1' + | 'clip-vit-base-patch32-text'; + /** * Props for the useTextEmbeddings hook. * * @category Types * @property {Object} model - An object containing the model configuration. - * @property {string} model.modelName - Unique name identifying the model. + * @property {TextEmbeddingsModelName} model.modelName - Unique name identifying the model. * @property {ResourceSource} model.modelSource - The source of the text embeddings model binary. * @property {ResourceSource} model.tokenizerSource - The source of the tokenizer JSON file. * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. @@ -16,7 +28,7 @@ export interface TextEmbeddingsProps { /** * The unique name of the text embeddings model. */ - modelName: string; + modelName: TextEmbeddingsModelName; /** * The source of the text embeddings model binary. */ diff --git a/packages/react-native-executorch/src/types/vad.ts b/packages/react-native-executorch/src/types/vad.ts index dbaf56e07..57bd11262 100644 --- a/packages/react-native-executorch/src/types/vad.ts +++ b/packages/react-native-executorch/src/types/vad.ts @@ -1,17 +1,24 @@ import { ResourceSource } from '../types/common'; import { RnExecutorchError } from '../errors/errorUtils'; +/** + * Union of all built-in VAD model names. + * + * @category Types + */ +export type VADModelName = 'fsmn-vad'; + /** * Props for the useVAD hook. * * @category Types * @property {Object} model - An object containing the model configuration. - * @property {string} model.modelName - Unique name identifying the model. + * @property {VADModelName} model.modelName - Unique name identifying the model. * @property {ResourceSource} model.modelSource - The source of the VAD model binary. * @property {boolean} [preventLoad] - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. */ export interface VADProps { - model: { modelName: string; modelSource: ResourceSource }; + model: { modelName: VADModelName; modelSource: ResourceSource }; preventLoad?: boolean; } From 3697c8bf9dba5832d578a06c768f0fc6fdd05878 Mon Sep 17 00:00:00 2001 From: chmjkb Date: Fri, 6 Mar 2026 09:09:43 +0100 Subject: [PATCH 8/8] docs: update API reference --- .../classes/ClassificationModule.md | 55 +++++++----------- .../classes/ExecutorchModule.md | 10 +--- .../classes/ImageEmbeddingsModule.md | 54 +++++++----------- .../classes/ObjectDetectionModule.md | 24 +------- .../classes/SemanticSegmentationModule.md | 24 +------- .../classes/StyleTransferModule.md | 55 +++++++----------- .../classes/TextEmbeddingsModule.md | 56 +++++++------------ .../classes/TextToImageModule.md | 10 +--- .../06-api-reference/classes/VADModule.md | 53 +++++++----------- docs/docs/06-api-reference/index.md | 5 ++ .../interfaces/ClassificationProps.md | 12 ++-- .../interfaces/ClassificationType.md | 12 ++-- .../interfaces/ImageEmbeddingsProps.md | 12 ++-- .../interfaces/ImageEmbeddingsType.md | 12 ++-- .../06-api-reference/interfaces/Segment.md | 6 +- .../interfaces/StyleTransferProps.md | 12 ++-- .../interfaces/StyleTransferType.md | 12 ++-- .../interfaces/TextEmbeddingsProps.md | 14 +++-- .../interfaces/TextEmbeddingsType.md | 12 ++-- .../06-api-reference/interfaces/VADProps.md | 12 ++-- .../06-api-reference/interfaces/VADType.md | 12 ++-- .../type-aliases/ClassificationModelName.md | 7 +++ .../type-aliases/ImageEmbeddingsModelName.md | 7 +++ .../type-aliases/StyleTransferModelName.md | 7 +++ .../type-aliases/TextEmbeddingsModelName.md | 7 +++ .../type-aliases/VADModelName.md | 7 +++ .../docs/06-api-reference/typedoc-sidebar.cjs | 2 +- .../variables/ALL_MINILM_L6_V2.md | 10 +++- .../variables/ALL_MPNET_BASE_V2.md | 10 +++- .../variables/BK_SDM_TINY_VPRED_256.md | 16 ++++-- .../variables/BK_SDM_TINY_VPRED_512.md | 16 ++++-- .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 8 ++- .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 10 +++- .../DEEPLAB_V3_MOBILENET_V3_LARGE.md | 2 +- ...DEEPLAB_V3_MOBILENET_V3_LARGE_QUANTIZED.md | 2 +- .../variables/DEEPLAB_V3_RESNET101.md | 2 +- .../DEEPLAB_V3_RESNET101_QUANTIZED.md | 2 +- .../variables/DEEPLAB_V3_RESNET50.md | 2 +- .../DEEPLAB_V3_RESNET50_QUANTIZED.md | 2 +- .../variables/EFFICIENTNET_V2_S.md | 8 ++- .../variables/FCN_RESNET101.md | 2 +- .../variables/FCN_RESNET101_QUANTIZED.md | 2 +- .../variables/FCN_RESNET50.md | 2 +- .../variables/FCN_RESNET50_QUANTIZED.md | 2 +- .../06-api-reference/variables/FSMN_VAD.md | 8 ++- .../variables/HAMMER2_1_0_5B.md | 12 ++-- .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 12 ++-- .../variables/HAMMER2_1_1_5B.md | 12 ++-- .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 12 ++-- .../variables/HAMMER2_1_3B.md | 12 ++-- .../variables/HAMMER2_1_3B_QUANTIZED.md | 12 ++-- .../variables/KOKORO_MEDIUM.md | 6 +- .../variables/KOKORO_SMALL.md | 4 ++ .../variables/LFM2_5_1_2B_INSTRUCT.md | 12 ++-- .../LFM2_5_1_2B_INSTRUCT_QUANTIZED.md | 12 ++-- .../06-api-reference/variables/LLAMA3_2_1B.md | 12 ++-- .../variables/LLAMA3_2_1B_QLORA.md | 12 ++-- .../variables/LLAMA3_2_1B_SPINQUANT.md | 12 ++-- .../06-api-reference/variables/LLAMA3_2_3B.md | 10 +++- .../variables/LLAMA3_2_3B_QLORA.md | 12 ++-- .../variables/LLAMA3_2_3B_SPINQUANT.md | 12 ++-- .../variables/LRASPP_MOBILENET_V3_LARGE.md | 2 +- .../LRASPP_MOBILENET_V3_LARGE_QUANTIZED.md | 2 +- .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 10 +++- .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 10 +++- .../06-api-reference/variables/OCR_ABAZA.md | 6 +- .../06-api-reference/variables/OCR_ADYGHE.md | 6 +- .../variables/OCR_AFRIKAANS.md | 6 +- .../variables/OCR_ALBANIAN.md | 6 +- .../06-api-reference/variables/OCR_AVAR.md | 6 +- .../variables/OCR_AZERBAIJANI.md | 6 +- .../variables/OCR_BELARUSIAN.md | 6 +- .../06-api-reference/variables/OCR_BOSNIAN.md | 6 +- .../variables/OCR_BULGARIAN.md | 6 +- .../06-api-reference/variables/OCR_CHECHEN.md | 6 +- .../variables/OCR_CROATIAN.md | 6 +- .../06-api-reference/variables/OCR_CZECH.md | 6 +- .../06-api-reference/variables/OCR_DANISH.md | 6 +- .../06-api-reference/variables/OCR_DARGWA.md | 6 +- .../06-api-reference/variables/OCR_DUTCH.md | 6 +- .../06-api-reference/variables/OCR_ENGLISH.md | 6 +- .../variables/OCR_ESTONIAN.md | 6 +- .../06-api-reference/variables/OCR_FRENCH.md | 6 +- .../06-api-reference/variables/OCR_GERMAN.md | 6 +- .../variables/OCR_HUNGARIAN.md | 6 +- .../variables/OCR_ICELANDIC.md | 6 +- .../variables/OCR_INDONESIAN.md | 6 +- .../06-api-reference/variables/OCR_INGUSH.md | 6 +- .../06-api-reference/variables/OCR_IRISH.md | 6 +- .../06-api-reference/variables/OCR_ITALIAN.md | 6 +- .../variables/OCR_JAPANESE.md | 6 +- .../06-api-reference/variables/OCR_KANNADA.md | 6 +- .../variables/OCR_KARBADIAN.md | 6 +- .../06-api-reference/variables/OCR_KOREAN.md | 6 +- .../06-api-reference/variables/OCR_KURDISH.md | 6 +- .../06-api-reference/variables/OCR_LAK.md | 6 +- .../06-api-reference/variables/OCR_LATIN.md | 6 +- .../06-api-reference/variables/OCR_LATVIAN.md | 6 +- .../variables/OCR_LEZGHIAN.md | 6 +- .../variables/OCR_LITHUANIAN.md | 6 +- .../06-api-reference/variables/OCR_MALAY.md | 6 +- .../06-api-reference/variables/OCR_MALTESE.md | 6 +- .../06-api-reference/variables/OCR_MAORI.md | 6 +- .../variables/OCR_MONGOLIAN.md | 6 +- .../variables/OCR_NORWEGIAN.md | 6 +- .../06-api-reference/variables/OCR_OCCITAN.md | 6 +- .../06-api-reference/variables/OCR_PALI.md | 6 +- .../06-api-reference/variables/OCR_POLISH.md | 6 +- .../variables/OCR_PORTUGUESE.md | 6 +- .../variables/OCR_ROMANIAN.md | 6 +- .../06-api-reference/variables/OCR_RUSSIAN.md | 6 +- .../variables/OCR_SERBIAN_CYRILLIC.md | 6 +- .../variables/OCR_SERBIAN_LATIN.md | 6 +- .../variables/OCR_SIMPLIFIED_CHINESE.md | 6 +- .../06-api-reference/variables/OCR_SLOVAK.md | 6 +- .../variables/OCR_SLOVENIAN.md | 6 +- .../06-api-reference/variables/OCR_SPANISH.md | 6 +- .../06-api-reference/variables/OCR_SWAHILI.md | 6 +- .../06-api-reference/variables/OCR_SWEDISH.md | 6 +- .../variables/OCR_TABASSARAN.md | 6 +- .../06-api-reference/variables/OCR_TAGALOG.md | 6 +- .../06-api-reference/variables/OCR_TAJIK.md | 6 +- .../06-api-reference/variables/OCR_TELUGU.md | 6 +- .../06-api-reference/variables/OCR_TURKISH.md | 6 +- .../variables/OCR_UKRAINIAN.md | 6 +- .../06-api-reference/variables/OCR_UZBEK.md | 6 +- .../variables/OCR_VIETNAMESE.md | 6 +- .../06-api-reference/variables/OCR_WELSH.md | 6 +- .../variables/PHI_4_MINI_4B.md | 12 ++-- .../variables/PHI_4_MINI_4B_QUANTIZED.md | 12 ++-- .../variables/QWEN2_5_0_5B.md | 12 ++-- .../variables/QWEN2_5_0_5B_QUANTIZED.md | 12 ++-- .../variables/QWEN2_5_1_5B.md | 12 ++-- .../variables/QWEN2_5_1_5B_QUANTIZED.md | 12 ++-- .../06-api-reference/variables/QWEN2_5_3B.md | 12 ++-- .../variables/QWEN2_5_3B_QUANTIZED.md | 12 ++-- .../06-api-reference/variables/QWEN3_0_6B.md | 12 ++-- .../variables/QWEN3_0_6B_QUANTIZED.md | 12 ++-- .../06-api-reference/variables/QWEN3_1_7B.md | 12 ++-- .../variables/QWEN3_1_7B_QUANTIZED.md | 12 ++-- .../06-api-reference/variables/QWEN3_4B.md | 12 ++-- .../variables/QWEN3_4B_QUANTIZED.md | 12 ++-- .../variables/RF_DETR_NANO.md | 2 +- .../variables/SELFIE_SEGMENTATION.md | 2 +- .../variables/SMOLLM2_1_135M.md | 12 ++-- .../variables/SMOLLM2_1_135M_QUANTIZED.md | 12 ++-- .../variables/SMOLLM2_1_1_7B.md | 12 ++-- .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 12 ++-- .../variables/SMOLLM2_1_360M.md | 12 ++-- .../variables/SMOLLM2_1_360M_QUANTIZED.md | 12 ++-- .../SSDLITE_320_MOBILENET_V3_LARGE.md | 2 +- .../variables/STYLE_TRANSFER_CANDY.md | 8 ++- .../variables/STYLE_TRANSFER_MOSAIC.md | 8 ++- .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 8 ++- .../variables/STYLE_TRANSFER_UDNIE.md | 8 ++- .../variables/WHISPER_BASE.md | 14 +++-- .../variables/WHISPER_BASE_EN.md | 14 +++-- .../variables/WHISPER_SMALL.md | 14 +++-- .../variables/WHISPER_SMALL_EN.md | 14 +++-- .../variables/WHISPER_TINY.md | 14 +++-- .../variables/WHISPER_TINY_EN.md | 14 +++-- .../variables/WHISPER_TINY_EN_QUANTIZED.md | 14 +++-- 162 files changed, 1001 insertions(+), 570 deletions(-) create mode 100644 docs/docs/06-api-reference/type-aliases/ClassificationModelName.md create mode 100644 docs/docs/06-api-reference/type-aliases/ImageEmbeddingsModelName.md create mode 100644 docs/docs/06-api-reference/type-aliases/StyleTransferModelName.md create mode 100644 docs/docs/06-api-reference/type-aliases/TextEmbeddingsModelName.md create mode 100644 docs/docs/06-api-reference/type-aliases/VADModelName.md diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index f3cb19464..b03569dcf 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,6 @@ # Class: ClassificationModule -Defined in: [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) +Defined in: [modules/computer_vision/ClassificationModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L14) Module for image classification tasks. @@ -8,20 +8,6 @@ Module for image classification tasks. - `BaseModule` -## Constructors - -### Constructor - -> **new ClassificationModule**(): `ClassificationModule` - -#### Returns - -`ClassificationModule` - -#### Inherited from - -`BaseModule.constructor` - ## Properties ### generateFromFrame() @@ -116,7 +102,7 @@ Native module instance (JSI Host Object) > **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) +Defined in: [modules/BaseModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L86) Unloads the model from memory and releases native resources. @@ -136,9 +122,9 @@ Always call this method when you're done with a model to prevent memory leaks. > **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) +Defined in: [modules/computer_vision/ClassificationModule.ts:57](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L57) -Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. +Executes the model's forward pass to classify the provided image. #### Parameters @@ -146,13 +132,13 @@ Executes the model's forward pass, where `imageSource` can be a fetchable resour `string` -The image source to be classified. +A string image source (file path, URI, or Base64). #### Returns `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -The classification result. +A Promise resolving to an object mapping category labels to confidence scores. --- @@ -160,7 +146,7 @@ The classification result. > `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) +Defined in: [modules/BaseModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L66) **`Internal`** @@ -191,7 +177,7 @@ Array of output tensors. > **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) +Defined in: [modules/BaseModule.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L77) Gets the input shape for a given method and index. @@ -221,35 +207,36 @@ The input shape as an array of numbers. --- -### load() +### fromModelName() -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> +> `static` **fromModelName**(`model`, `onDownloadProgress?`): `Promise`\<`ClassificationModule`\> -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) +Defined in: [modules/computer_vision/ClassificationModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L27) -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`. +Creates a classification instance for a built-in model. #### Parameters ##### model -Object containing `modelSource`. +An object specifying which built-in model to load and where to fetch it from. + +###### modelName + +`"efficientnet-v2-s"` ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) -##### onDownloadProgressCallback? +##### onDownloadProgress? (`progress`) => `void` -Optional callback to monitor download progress. +Optional callback to monitor download progress, receiving a value between 0 and 1. #### Returns -`Promise`\<`void`\> - -#### Overrides +`Promise`\<`ClassificationModule`\> -`BaseModule.load` +A Promise resolving to a `ClassificationModule` instance. diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index 8592a13ff..3c7473f7e 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -116,7 +116,7 @@ Native module instance (JSI Host Object) > **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) +Defined in: [modules/BaseModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L86) Unloads the model from memory and releases native resources. @@ -161,7 +161,7 @@ An array of output tensor pointers. > `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) +Defined in: [modules/BaseModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L66) **`Internal`** @@ -192,7 +192,7 @@ Array of output tensors. > **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) +Defined in: [modules/BaseModule.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L77) Gets the input shape for a given method and index. @@ -248,7 +248,3 @@ 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 index 9ae05fc40..0c73be205 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: ImageEmbeddingsModule -Defined in: [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) +Defined in: [modules/computer_vision/ImageEmbeddingsModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L14) Module for generating image embeddings from input images. @@ -8,20 +8,6 @@ Module for generating image embeddings from input images. - `BaseModule` -## Constructors - -### Constructor - -> **new ImageEmbeddingsModule**(): `ImageEmbeddingsModule` - -#### Returns - -`ImageEmbeddingsModule` - -#### Inherited from - -`BaseModule.constructor` - ## Properties ### generateFromFrame() @@ -116,7 +102,7 @@ Native module instance (JSI Host Object) > **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) +Defined in: [modules/BaseModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L86) Unloads the model from memory and releases native resources. @@ -136,9 +122,9 @@ Always call this method when you're done with a model to prevent memory leaks. > **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) +Defined in: [modules/computer_vision/ImageEmbeddingsModule.ts:57](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L57) -Executes the model's forward pass. Returns an embedding array for a given sentence. +Executes the model's forward pass to generate an embedding for the provided image. #### Parameters @@ -146,13 +132,13 @@ Executes the model's forward pass. Returns an embedding array for a given senten `string` -The image source (URI/URL) to image that will be embedded. +A string image source (file path, URI, or Base64). #### Returns `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -A Float32Array containing the image embeddings. +A Promise resolving to a `Float32Array` containing the image embedding vector. --- @@ -160,7 +146,7 @@ A Float32Array containing the image embeddings. > `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) +Defined in: [modules/BaseModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L66) **`Internal`** @@ -191,7 +177,7 @@ Array of output tensors. > **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) +Defined in: [modules/BaseModule.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L77) Gets the input shape for a given method and index. @@ -221,34 +207,36 @@ The input shape as an array of numbers. --- -### load() +### fromModelName() -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> +> `static` **fromModelName**(`model`, `onDownloadProgress?`): `Promise`\<`ImageEmbeddingsModule`\> -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) +Defined in: [modules/computer_vision/ImageEmbeddingsModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L27) -Loads the model, where `modelSource` is a string that specifies the location of the model binary. +Creates an image embeddings instance for a built-in model. #### Parameters ##### model -Object containing `modelSource`. +An object specifying which built-in model to load and where to fetch it from. + +###### modelName + +`"clip-vit-base-patch32-image"` ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) -##### onDownloadProgressCallback? +##### onDownloadProgress? (`progress`) => `void` -Optional callback to monitor download progress. +Optional callback to monitor download progress, receiving a value between 0 and 1. #### Returns -`Promise`\<`void`\> - -#### Overrides +`Promise`\<`ImageEmbeddingsModule`\> -`BaseModule.load` +A Promise resolving to an `ImageEmbeddingsModule` instance. diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index e36777857..1ce5595b5 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -169,7 +169,7 @@ const frameOutput = useFrameOutput({ > **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) +Defined in: [modules/BaseModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L86) Unloads the model from memory and releases native resources. @@ -223,7 +223,7 @@ A Promise resolving to an array of [Detection](../interfaces/Detection.md) objec > `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) +Defined in: [modules/BaseModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L66) **`Internal`** @@ -254,7 +254,7 @@ Array of output tensors. > **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) +Defined in: [modules/BaseModule.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L77) Gets the input shape for a given method and index. @@ -284,24 +284,6 @@ The input shape as an array of numbers. --- -### 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`\>\> diff --git a/docs/docs/06-api-reference/classes/SemanticSegmentationModule.md b/docs/docs/06-api-reference/classes/SemanticSegmentationModule.md index 97f33ea24..5b8532099 100644 --- a/docs/docs/06-api-reference/classes/SemanticSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/SemanticSegmentationModule.md @@ -130,7 +130,7 @@ Native module instance (JSI Host Object) > **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) +Defined in: [modules/BaseModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L86) Unloads the model from memory and releases native resources. @@ -196,7 +196,7 @@ If the model is not loaded. > `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) +Defined in: [modules/BaseModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L66) **`Internal`** @@ -227,7 +227,7 @@ Array of output tensors. > **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) +Defined in: [modules/BaseModule.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L77) Gets the input shape for a given method and index. @@ -257,24 +257,6 @@ The input shape as an array of numbers. --- -### 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`\>\> diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index fde173d7c..f584241c1 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,6 @@ # Class: StyleTransferModule -Defined in: [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) +Defined in: [modules/computer_vision/StyleTransferModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L14) Module for style transfer tasks. @@ -8,20 +8,6 @@ Module for style transfer tasks. - `BaseModule` -## Constructors - -### Constructor - -> **new StyleTransferModule**(): `StyleTransferModule` - -#### Returns - -`StyleTransferModule` - -#### Inherited from - -`BaseModule.constructor` - ## Properties ### generateFromFrame() @@ -116,7 +102,7 @@ Native module instance (JSI Host Object) > **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) +Defined in: [modules/BaseModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L86) Unloads the model from memory and releases native resources. @@ -136,9 +122,9 @@ Always call this method when you're done with a model to prevent memory leaks. > **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) +Defined in: [modules/computer_vision/StyleTransferModule.ts:57](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L57) -Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. +Executes the model's forward pass to apply the selected style to the provided image. #### Parameters @@ -146,13 +132,13 @@ Executes the model's forward pass, where `imageSource` can be a fetchable resour `string` -The image source to be processed. +A string image source (file path, URI, or Base64). #### Returns `Promise`\<`string`\> -The stylized image as a Base64-encoded string. +A Promise resolving to the stylized image as a Base64-encoded string. --- @@ -160,7 +146,7 @@ The stylized image as a Base64-encoded string. > `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) +Defined in: [modules/BaseModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L66) **`Internal`** @@ -191,7 +177,7 @@ Array of output tensors. > **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) +Defined in: [modules/BaseModule.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L77) Gets the input shape for a given method and index. @@ -221,35 +207,36 @@ The input shape as an array of numbers. --- -### load() +### fromModelName() -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> +> `static` **fromModelName**(`model`, `onDownloadProgress?`): `Promise`\<`StyleTransferModule`\> -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) +Defined in: [modules/computer_vision/StyleTransferModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L27) -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`. +Creates a style transfer instance for a built-in model. #### Parameters ##### model -Object containing `modelSource`. +An object specifying which built-in model to load and where to fetch it from. + +###### modelName + +[`StyleTransferModelName`](../type-aliases/StyleTransferModelName.md) ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) -##### onDownloadProgressCallback? +##### onDownloadProgress? (`progress`) => `void` -Optional callback to monitor download progress. +Optional callback to monitor download progress, receiving a value between 0 and 1. #### Returns -`Promise`\<`void`\> - -#### Overrides +`Promise`\<`StyleTransferModule`\> -`BaseModule.load` +A Promise resolving to a `StyleTransferModule` instance. diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index 28a10045f..3674a9fb9 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: TextEmbeddingsModule -Defined in: [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) +Defined in: [modules/natural_language_processing/TextEmbeddingsModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L14) Module for generating text embeddings from input text. @@ -8,20 +8,6 @@ Module for generating text embeddings from input text. - `BaseModule` -## Constructors - -### Constructor - -> **new TextEmbeddingsModule**(): `TextEmbeddingsModule` - -#### Returns - -`TextEmbeddingsModule` - -#### Inherited from - -`BaseModule.constructor` - ## Properties ### generateFromFrame() @@ -116,7 +102,7 @@ Native module instance (JSI Host Object) > **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) +Defined in: [modules/BaseModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L86) Unloads the model from memory and releases native resources. @@ -136,9 +122,9 @@ Always call this method when you're done with a model to prevent memory leaks. > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [modules/natural_language_processing/TextEmbeddingsModule.ts:60](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L60) +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. +Executes the model's forward pass to generate an embedding for the provided text. #### Parameters @@ -152,7 +138,7 @@ The text string to embed. `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -A Float32Array containing the vector embeddings. +A Promise resolving to a `Float32Array` containing the embedding vector. --- @@ -160,7 +146,7 @@ A Float32Array containing the vector embeddings. > `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) +Defined in: [modules/BaseModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L66) **`Internal`** @@ -191,7 +177,7 @@ Array of output tensors. > **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) +Defined in: [modules/BaseModule.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L77) Gets the input shape for a given method and index. @@ -221,42 +207,40 @@ The input shape as an array of numbers. --- -### load() +### fromModelName() -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> +> `static` **fromModelName**(`model`, `onDownloadProgress?`): `Promise`\<`TextEmbeddingsModule`\> -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) +Defined in: [modules/natural_language_processing/TextEmbeddingsModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L27) -Loads the model and tokenizer specified by the config object. +Creates a text embeddings instance for a built-in model. #### Parameters ##### model -Object containing model and tokenizer sources. +An object specifying which built-in model to load and where to fetch it from. + +###### modelName + +[`TextEmbeddingsModelName`](../type-aliases/TextEmbeddingsModelName.md) ###### 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? +##### onDownloadProgress? (`progress`) => `void` -Optional callback to track download progress (value between 0 and 1). +Optional callback to monitor download progress, receiving a value between 0 and 1. #### Returns -`Promise`\<`void`\> - -#### Overrides +`Promise`\<`TextEmbeddingsModule`\> -`BaseModule.load` +A Promise resolving to a `TextEmbeddingsModule` instance. diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index 8f74a7a0e..f8318b27c 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -128,7 +128,7 @@ Native module instance (JSI Host Object) > **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) +Defined in: [modules/BaseModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L86) Unloads the model from memory and releases native resources. @@ -191,7 +191,7 @@ A Base64-encoded string representing the generated PNG image. > `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) +Defined in: [modules/BaseModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L66) **`Internal`** @@ -222,7 +222,7 @@ Array of output tensors. > **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) +Defined in: [modules/BaseModule.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L77) Gets the input shape for a given method and index. @@ -309,7 +309,3 @@ Optional callback to monitor download progress. #### Returns `Promise`\<`void`\> - -#### Overrides - -`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index 6b9ff4120..fcb38a5ac 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -8,20 +8,6 @@ Module for Voice Activity Detection (VAD) functionalities. - `BaseModule` -## Constructors - -### Constructor - -> **new VADModule**(): `VADModule` - -#### Returns - -`VADModule` - -#### Inherited from - -`BaseModule.constructor` - ## Properties ### generateFromFrame() @@ -116,7 +102,7 @@ Native module instance (JSI Host Object) > **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) +Defined in: [modules/BaseModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L86) Unloads the model from memory and releases native resources. @@ -136,9 +122,9 @@ Always call this method when you're done with a model to prevent memory leaks. > **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) +Defined in: [modules/natural_language_processing/VADModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L55) -Executes the model's forward pass, where `waveform` is a Float32Array representing the audio signal (16kHz). +Executes the model's forward pass to detect speech segments within the provided audio. #### Parameters @@ -146,13 +132,13 @@ Executes the model's forward pass, where `waveform` is a Float32Array representi `Float32Array` -The input audio waveform as a Float32Array. It must represent a mono audio signal sampled at 16kHz. +A `Float32Array` representing a mono audio signal sampled at 16kHz. #### Returns `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -A promise resolving to an array of detected speech segments. +A Promise resolving to an array of [Segment](../interfaces/Segment.md) objects. --- @@ -160,7 +146,7 @@ A promise resolving to an array of detected speech segments. > `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) +Defined in: [modules/BaseModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L66) **`Internal`** @@ -191,7 +177,7 @@ Array of output tensors. > **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) +Defined in: [modules/BaseModule.ts:77](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/BaseModule.ts#L77) Gets the input shape for a given method and index. @@ -221,35 +207,36 @@ The input shape as an array of numbers. --- -### load() +### fromModelName() -> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\> +> `static` **fromModelName**(`model`, `onDownloadProgress?`): `Promise`\<`VADModule`\> -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) +Defined in: [modules/natural_language_processing/VADModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L27) -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`. +Creates a VAD instance for a built-in model. #### Parameters ##### model -Object containing `modelSource`. +An object specifying which built-in model to load and where to fetch it from. + +###### modelName + +`"fsmn-vad"` ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) -##### onDownloadProgressCallback? +##### onDownloadProgress? (`progress`) => `void` -Optional callback to monitor download progress. +Optional callback to monitor download progress, receiving a value between 0 and 1. #### Returns -`Promise`\<`void`\> - -#### Overrides +`Promise`\<`VADModule`\> -`BaseModule.load` +A Promise resolving to a `VADModule` instance. diff --git a/docs/docs/06-api-reference/index.md b/docs/docs/06-api-reference/index.md index c059a9cc8..e7ca9a0ad 100644 --- a/docs/docs/06-api-reference/index.md +++ b/docs/docs/06-api-reference/index.md @@ -276,6 +276,8 @@ - [VerticalOCRProps](interfaces/VerticalOCRProps.md) - [VoiceConfig](interfaces/VoiceConfig.md) - [Word](interfaces/Word.md) +- [ClassificationModelName](type-aliases/ClassificationModelName.md) +- [ImageEmbeddingsModelName](type-aliases/ImageEmbeddingsModelName.md) - [LabelEnum](type-aliases/LabelEnum.md) - [LLMTool](type-aliases/LLMTool.md) - [MessageRole](type-aliases/MessageRole.md) @@ -291,9 +293,12 @@ - [SemanticSegmentationModelName](type-aliases/SemanticSegmentationModelName.md) - [SemanticSegmentationModelSources](type-aliases/SemanticSegmentationModelSources.md) - [SpeechToTextLanguage](type-aliases/SpeechToTextLanguage.md) +- [StyleTransferModelName](type-aliases/StyleTransferModelName.md) - [TensorBuffer](type-aliases/TensorBuffer.md) +- [TextEmbeddingsModelName](type-aliases/TextEmbeddingsModelName.md) - [TextToSpeechLanguage](type-aliases/TextToSpeechLanguage.md) - [Triple](type-aliases/Triple.md) +- [VADModelName](type-aliases/VADModelName.md) - [SPECIAL_TOKENS](variables/SPECIAL_TOKENS.md) ## Typescript API diff --git a/docs/docs/06-api-reference/interfaces/ClassificationProps.md b/docs/docs/06-api-reference/interfaces/ClassificationProps.md index 899c70f06..be4ab7f6f 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationProps.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationProps.md @@ -1,6 +1,6 @@ # Interface: ClassificationProps -Defined in: [types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L12) +Defined in: [types/classification.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L20) Props for the `useClassification` hook. @@ -10,9 +10,13 @@ Props for the `useClassification` hook. > **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) +Defined in: [types/classification.ts:21](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L21) -An object containing the model source. +An object containing the model configuration. + +#### modelName + +> **modelName**: `"efficientnet-v2-s"` #### modelSource @@ -24,6 +28,6 @@ An object containing the model source. > `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) +Defined in: [types/classification.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.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/ClassificationType.md b/docs/docs/06-api-reference/interfaces/ClassificationType.md index 01fc48dd1..535e2c955 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationType.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationType.md @@ -1,6 +1,6 @@ # Interface: ClassificationType -Defined in: [types/classification.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L23) +Defined in: [types/classification.ts:31](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L31) Return type for the `useClassification` hook. Manages the state and operations for Computer Vision image classification. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image classification. > **downloadProgress**: `number` -Defined in: [types/classification.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L42) +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) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [types/classification.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L27) +Defined in: [types/classification.ts:35](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L35) Contains the error object if the model failed to load, download, or encountered a runtime error during classification. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: [types/classification.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L50) +Defined in: [types/classification.ts:58](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L58) Executes the model's forward pass to classify the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [types/classification.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L37) +Defined in: [types/classification.ts:45](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L45) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [types/classification.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L32) +Defined in: [types/classification.ts:40](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L40) Indicates whether the classification model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md index ddb620e36..42e453aa5 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsProps -Defined in: [types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) +Defined in: [types/imageEmbeddings.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L20) Props for the `useImageEmbeddings` hook. @@ -10,9 +10,13 @@ Props for the `useImageEmbeddings` hook. > **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) +Defined in: [types/imageEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L21) -An object containing the model source. +An object containing the model configuration. + +#### modelName + +> **modelName**: `"clip-vit-base-patch32-image"` #### modelSource @@ -24,6 +28,6 @@ An object containing the model source. > `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) +Defined in: [types/imageEmbeddings.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.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/ImageEmbeddingsType.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md index e52068d91..349008b13 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsType -Defined in: [types/imageEmbeddings.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L23) +Defined in: [types/imageEmbeddings.ts:31](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L31) Return type for the `useImageEmbeddings` hook. Manages the state and operations for generating image embeddings (feature vectors) used in Computer Vision tasks. @@ -11,7 +11,7 @@ Manages the state and operations for generating image embeddings (feature vector > **downloadProgress**: `number` -Defined in: [types/imageEmbeddings.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L42) +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) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [types/imageEmbeddings.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L27) +Defined in: [types/imageEmbeddings.ts:35](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L35) Contains the error object if the model failed to load, download, or encountered a runtime error during embedding generation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [types/imageEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L50) +Defined in: [types/imageEmbeddings.ts:58](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L58) Executes the model's forward pass to generate embeddings (a feature vector) for the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [types/imageEmbeddings.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L37) +Defined in: [types/imageEmbeddings.ts:45](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L45) Indicates whether the model is currently generating embeddings for an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently generating embeddings for an image. > **isReady**: `boolean` -Defined in: [types/imageEmbeddings.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L32) +Defined in: [types/imageEmbeddings.ts:40](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L40) Indicates whether the image embeddings model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index 19916521d..9f6e26c15 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,6 @@ # Interface: Segment -Defined in: [types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L24) +Defined in: [types/vad.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L32) Represents a detected audio segment with start and end timestamps. @@ -10,7 +10,7 @@ Represents a detected audio segment with start and end timestamps. > **end**: `number` -Defined in: [types/vad.ts:26](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L26) +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) End time of the segment in seconds. @@ -20,6 +20,6 @@ End time of the segment in seconds. > **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) +Defined in: [types/vad.ts:33](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L33) Start time of the segment in seconds. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md index 97655a44b..5f379d052 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md @@ -1,6 +1,6 @@ # Interface: StyleTransferProps -Defined in: [types/styleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L12) +Defined in: [types/styleTransfer.ts:24](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L24) Configuration properties for the `useStyleTransfer` hook. @@ -10,9 +10,13 @@ Configuration properties for the `useStyleTransfer` hook. > **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) +Defined in: [types/styleTransfer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L25) -Object containing the `modelSource` for the style transfer model. +Object containing the model configuration. + +#### modelName + +> **modelName**: [`StyleTransferModelName`](../type-aliases/StyleTransferModelName.md) #### modelSource @@ -24,6 +28,6 @@ Object containing the `modelSource` for the style transfer model. > `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) +Defined in: [types/styleTransfer.ts:26](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L26) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferType.md b/docs/docs/06-api-reference/interfaces/StyleTransferType.md index 4b50a43f7..d40bd8dd9 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferType.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferType.md @@ -1,6 +1,6 @@ # Interface: StyleTransferType -Defined in: [types/styleTransfer.ts:23](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L23) +Defined in: [types/styleTransfer.ts:35](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L35) Return type for the `useStyleTransfer` hook. Manages the state and operations for applying artistic style transfer to images. @@ -11,7 +11,7 @@ Manages the state and operations for applying artistic style transfer to images. > **downloadProgress**: `number` -Defined in: [types/styleTransfer.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L42) +Defined in: [types/styleTransfer.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L54) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [types/styleTransfer.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L27) +Defined in: [types/styleTransfer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L39) Contains the error object if the model failed to load, download, or encountered a runtime error during style transfer. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`string`\> -Defined in: [types/styleTransfer.ts:50](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L50) +Defined in: [types/styleTransfer.ts:62](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L62) Executes the model's forward pass to apply the specific artistic style to the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [types/styleTransfer.ts:37](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L37) +Defined in: [types/styleTransfer.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L49) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [types/styleTransfer.ts:32](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L32) +Defined in: [types/styleTransfer.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L44) Indicates whether the style transfer model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md index 539d421e7..19436abe4 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsProps -Defined in: [types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) +Defined in: [types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) Props for the useTextEmbeddings hook. @@ -10,9 +10,15 @@ Props for the useTextEmbeddings hook. > **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) +Defined in: [types/textEmbeddings.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L27) -An object containing the model and tokenizer sources. +An object containing the model configuration. + +#### modelName + +> **modelName**: [`TextEmbeddingsModelName`](../type-aliases/TextEmbeddingsModelName.md) + +The unique name of the text embeddings model. #### modelSource @@ -32,6 +38,6 @@ The source of the tokenizer JSON file. > `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) +Defined in: [types/textEmbeddings.ts:41](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L41) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md index 541d8bc09..4bfdd98df 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsType -Defined in: [types/textEmbeddings.ts:30](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L30) +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) React hook state and methods for managing a Text Embeddings model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Text Embeddings model instance. > **downloadProgress**: `number` -Defined in: [types/textEmbeddings.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L49) +Defined in: [types/textEmbeddings.ts:68](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L68) Tracks the progress of the model download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the model download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) +Defined in: [types/textEmbeddings.ts:53](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L53) Contains the error message if the model failed to load or during inference. @@ -30,7 +30,7 @@ Contains the error message if the model failed to load or during inference. > **isGenerating**: `boolean` -Defined in: [types/textEmbeddings.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L44) +Defined in: [types/textEmbeddings.ts:63](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L63) Indicates whether the model is currently generating embeddings. @@ -40,7 +40,7 @@ Indicates whether the model is currently generating embeddings. > **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) +Defined in: [types/textEmbeddings.ts:58](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L58) Indicates whether the embeddings model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the embeddings model has successfully loaded and is ready for > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [types/textEmbeddings.ts:57](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L57) +Defined in: [types/textEmbeddings.ts:76](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L76) Runs the text embeddings model on the provided input string. diff --git a/docs/docs/06-api-reference/interfaces/VADProps.md b/docs/docs/06-api-reference/interfaces/VADProps.md index 3c4e7748d..bd040a5ac 100644 --- a/docs/docs/06-api-reference/interfaces/VADProps.md +++ b/docs/docs/06-api-reference/interfaces/VADProps.md @@ -1,6 +1,6 @@ # Interface: VADProps -Defined in: [types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L12) +Defined in: [types/vad.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L20) Props for the useVAD hook. @@ -10,9 +10,13 @@ Props for the useVAD hook. > **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) +Defined in: [types/vad.ts:21](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L21) -An object containing the model source. +An object containing the model configuration. + +#### modelName + +> **modelName**: `"fsmn-vad"` #### modelSource @@ -24,6 +28,6 @@ An object containing the model source. > `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) +Defined in: [types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.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/VADType.md b/docs/docs/06-api-reference/interfaces/VADType.md index 38d8092e6..43f9b511e 100644 --- a/docs/docs/06-api-reference/interfaces/VADType.md +++ b/docs/docs/06-api-reference/interfaces/VADType.md @@ -1,6 +1,6 @@ # Interface: VADType -Defined in: [types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L34) +Defined in: [types/vad.ts:42](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L42) React hook state and methods for managing a Voice Activity Detection (VAD) model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Voice Activity Detection (VAD) model > **downloadProgress**: `number` -Defined in: [types/vad.ts:53](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L53) +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) Represents the download progress as a value between 0 and 1. @@ -20,7 +20,7 @@ Represents the download progress as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [types/vad.ts:38](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L38) +Defined in: [types/vad.ts:46](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L46) Contains the error message if the VAD model failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the VAD model failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [types/vad.ts:48](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L48) +Defined in: [types/vad.ts:56](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L56) Indicates whether the model is currently processing an inference. @@ -40,7 +40,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [types/vad.ts:43](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L43) +Defined in: [types/vad.ts:51](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L51) Indicates whether the VAD model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the VAD model has successfully loaded and is ready for inferen > **forward**(`waveform`): `Promise`\<[`Segment`](Segment.md)[]\> -Defined in: [types/vad.ts:61](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L61) +Defined in: [types/vad.ts:69](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L69) Runs the Voice Activity Detection model on the provided audio waveform. diff --git a/docs/docs/06-api-reference/type-aliases/ClassificationModelName.md b/docs/docs/06-api-reference/type-aliases/ClassificationModelName.md new file mode 100644 index 000000000..8828421b2 --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/ClassificationModelName.md @@ -0,0 +1,7 @@ +# Type Alias: ClassificationModelName + +> **ClassificationModelName** = `"efficientnet-v2-s"` + +Defined in: [types/classification.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/classification.ts#L9) + +Union of all built-in classification model names. diff --git a/docs/docs/06-api-reference/type-aliases/ImageEmbeddingsModelName.md b/docs/docs/06-api-reference/type-aliases/ImageEmbeddingsModelName.md new file mode 100644 index 000000000..e74bafac1 --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/ImageEmbeddingsModelName.md @@ -0,0 +1,7 @@ +# Type Alias: ImageEmbeddingsModelName + +> **ImageEmbeddingsModelName** = `"clip-vit-base-patch32-image"` + +Defined in: [types/imageEmbeddings.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/imageEmbeddings.ts#L9) + +Union of all built-in image embeddings model names. diff --git a/docs/docs/06-api-reference/type-aliases/StyleTransferModelName.md b/docs/docs/06-api-reference/type-aliases/StyleTransferModelName.md new file mode 100644 index 000000000..ccd5d5d2a --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/StyleTransferModelName.md @@ -0,0 +1,7 @@ +# Type Alias: StyleTransferModelName + +> **StyleTransferModelName** = `"style-transfer-candy"` \| `"style-transfer-mosaic"` \| `"style-transfer-rain-princess"` \| `"style-transfer-udnie"` + +Defined in: [types/styleTransfer.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/styleTransfer.ts#L9) + +Union of all built-in style transfer model names. diff --git a/docs/docs/06-api-reference/type-aliases/TextEmbeddingsModelName.md b/docs/docs/06-api-reference/type-aliases/TextEmbeddingsModelName.md new file mode 100644 index 000000000..7fb85e04a --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/TextEmbeddingsModelName.md @@ -0,0 +1,7 @@ +# Type Alias: TextEmbeddingsModelName + +> **TextEmbeddingsModelName** = `"all-minilm-l6-v2"` \| `"all-mpnet-base-v2"` \| `"multi-qa-minilm-l6-cos-v1"` \| `"multi-qa-mpnet-base-dot-v1"` \| `"clip-vit-base-patch32-text"` + +Defined in: [types/textEmbeddings.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/textEmbeddings.ts#L9) + +Union of all built-in text embeddings model names. diff --git a/docs/docs/06-api-reference/type-aliases/VADModelName.md b/docs/docs/06-api-reference/type-aliases/VADModelName.md new file mode 100644 index 000000000..58a446ef9 --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/VADModelName.md @@ -0,0 +1,7 @@ +# Type Alias: VADModelName + +> **VADModelName** = `"fsmn-vad"` + +Defined in: [types/vad.ts:9](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/types/vad.ts#L9) + +Union of all built-in VAD model names. diff --git a/docs/docs/06-api-reference/typedoc-sidebar.cjs b/docs/docs/06-api-reference/typedoc-sidebar.cjs index faccf365c..7a1acb7a5 100644 --- a/docs/docs/06-api-reference/typedoc-sidebar.cjs +++ b/docs/docs/06-api-reference/typedoc-sidebar.cjs @@ -1,4 +1,4 @@ // @ts-check /** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ -const typedocSidebar = {items:[{type:"category",label:"Hooks",items:[{type:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/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/TextToSpeechProps",label:"TextToSpeechProps"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechStreamingInput",label:"TextToSpeechStreamingInput"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechType",label:"TextToSpeechType"},{type:"doc",id:"06-api-reference/interfaces/TokenizerProps",label:"TokenizerProps"},{type:"doc",id:"06-api-reference/interfaces/TokenizerType",label:"TokenizerType"},{type:"doc",id:"06-api-reference/interfaces/ToolCall",label:"ToolCall"},{type:"doc",id:"06-api-reference/interfaces/ToolsConfig",label:"ToolsConfig"},{type:"doc",id:"06-api-reference/interfaces/TranscriptionResult",label:"TranscriptionResult"},{type:"doc",id:"06-api-reference/interfaces/TranscriptionSegment",label:"TranscriptionSegment"},{type:"doc",id:"06-api-reference/interfaces/VADProps",label:"VADProps"},{type:"doc",id:"06-api-reference/interfaces/VADType",label:"VADType"},{type:"doc",id:"06-api-reference/interfaces/VerticalOCRProps",label:"VerticalOCRProps"},{type:"doc",id:"06-api-reference/interfaces/VoiceConfig",label:"VoiceConfig"},{type:"doc",id:"06-api-reference/interfaces/Word",label:"Word"},{type:"doc",id:"06-api-reference/type-aliases/LabelEnum",label:"LabelEnum"},{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/ModelNameOf",label:"ModelNameOf"},{type:"doc",id:"06-api-reference/type-aliases/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"}]}]}; +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/TextToSpeechProps",label:"TextToSpeechProps"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechStreamingInput",label:"TextToSpeechStreamingInput"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechType",label:"TextToSpeechType"},{type:"doc",id:"06-api-reference/interfaces/TokenizerProps",label:"TokenizerProps"},{type:"doc",id:"06-api-reference/interfaces/TokenizerType",label:"TokenizerType"},{type:"doc",id:"06-api-reference/interfaces/ToolCall",label:"ToolCall"},{type:"doc",id:"06-api-reference/interfaces/ToolsConfig",label:"ToolsConfig"},{type:"doc",id:"06-api-reference/interfaces/TranscriptionResult",label:"TranscriptionResult"},{type:"doc",id:"06-api-reference/interfaces/TranscriptionSegment",label:"TranscriptionSegment"},{type:"doc",id:"06-api-reference/interfaces/VADProps",label:"VADProps"},{type:"doc",id:"06-api-reference/interfaces/VADType",label:"VADType"},{type:"doc",id:"06-api-reference/interfaces/VerticalOCRProps",label:"VerticalOCRProps"},{type:"doc",id:"06-api-reference/interfaces/VoiceConfig",label:"VoiceConfig"},{type:"doc",id:"06-api-reference/interfaces/Word",label:"Word"},{type:"doc",id:"06-api-reference/type-aliases/ClassificationModelName",label:"ClassificationModelName"},{type:"doc",id:"06-api-reference/type-aliases/ImageEmbeddingsModelName",label:"ImageEmbeddingsModelName"},{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/StyleTransferModelName",label:"StyleTransferModelName"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextEmbeddingsModelName",label:"TextEmbeddingsModelName"},{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/type-aliases/VADModelName",label:"VADModelName"},{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 index dfd9f2891..8c634e932 100644 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -2,14 +2,18 @@ > `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) +Defined in: [constants/modelUrls.ts:743](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L743) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"all-minilm-l6-v2"` = `'all-minilm-l6-v2'` + ### modelSource -> **modelSource**: `string` = `ALL_MINILM_L6_V2_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-all-MiniLM-L6-v2/resolve/v0.7.0/all-MiniLM-L6-v2_xnnpack.pte"` = `ALL_MINILM_L6_V2_MODEL` ### tokenizerSource -> **tokenizerSource**: `string` = `ALL_MINILM_L6_V2_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-all-MiniLM-L6-v2/resolve/v0.7.0/tokenizer.json"` = `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 index cb51bee2d..6e7cf6b61 100644 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -2,14 +2,18 @@ > `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) +Defined in: [constants/modelUrls.ts:752](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L752) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"all-mpnet-base-v2"` = `'all-mpnet-base-v2'` + ### modelSource -> **modelSource**: `string` = `ALL_MPNET_BASE_V2_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-all-mpnet-base-v2/resolve/v0.7.0/all-mpnet-base-v2_xnnpack.pte"` = `ALL_MPNET_BASE_V2_MODEL` ### tokenizerSource -> **tokenizerSource**: `string` = `ALL_MPNET_BASE_V2_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-all-mpnet-base-v2/resolve/v0.7.0/tokenizer.json"` = `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 index bd2a89eba..84441a057 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -2,26 +2,30 @@ > `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) +Defined in: [constants/modelUrls.ts:802](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L802) ## Type Declaration ### decoderSource -> **decoderSource**: `string` +> `readonly` **decoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-bk-sdm-tiny/resolve/v0.7.0/vae/model.256.pte"` ### encoderSource -> **encoderSource**: `string` +> `readonly` **encoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-bk-sdm-tiny/resolve/v0.7.0/text_encoder/model.pte"` + +### modelName + +> `readonly` **modelName**: `"bk-sdm-tiny-vpred-256"` = `'bk-sdm-tiny-vpred-256'` ### schedulerSource -> **schedulerSource**: `string` +> `readonly` **schedulerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-bk-sdm-tiny/resolve/v0.7.0/scheduler/scheduler_config.json"` ### tokenizerSource -> **tokenizerSource**: `string` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-bk-sdm-tiny/resolve/v0.7.0/tokenizer/tokenizer.json"` ### unetSource -> **unetSource**: `string` +> `readonly` **unetSource**: `"https://huggingface.co/software-mansion/react-native-executorch-bk-sdm-tiny/resolve/v0.7.0/unet/model.256.pte"` diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index ec21972f1..cd77de366 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -2,26 +2,30 @@ > `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) +Defined in: [constants/modelUrls.ts:790](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L790) ## Type Declaration ### decoderSource -> **decoderSource**: `string` +> `readonly` **decoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-bk-sdm-tiny/resolve/v0.7.0/vae/model.pte"` ### encoderSource -> **encoderSource**: `string` +> `readonly` **encoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-bk-sdm-tiny/resolve/v0.7.0/text_encoder/model.pte"` + +### modelName + +> `readonly` **modelName**: `"bk-sdm-tiny-vpred-512"` = `'bk-sdm-tiny-vpred-512'` ### schedulerSource -> **schedulerSource**: `string` +> `readonly` **schedulerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-bk-sdm-tiny/resolve/v0.7.0/scheduler/scheduler_config.json"` ### tokenizerSource -> **tokenizerSource**: `string` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-bk-sdm-tiny/resolve/v0.7.0/tokenizer/tokenizer.json"` ### unetSource -> **unetSource**: `string` +> `readonly` **unetSource**: `"https://huggingface.co/software-mansion/react-native-executorch-bk-sdm-tiny/resolve/v0.7.0/unet/model.pte"` diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index 0dc8afce7..35b4e9243 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -2,10 +2,14 @@ > `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) +Defined in: [constants/modelUrls.ts:723](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L723) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"clip-vit-base-patch32-image"` = `'clip-vit-base-patch32-image'` + ### modelSource -> **modelSource**: `string` = `CLIP_VIT_BASE_PATCH32_IMAGE_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-clip-vit-base-patch32/resolve/v0.7.0/clip-vit-base-patch32-vision_xnnpack.pte"` = `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 index 94fc574b3..bb1387eba 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -2,14 +2,18 @@ > `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) +Defined in: [constants/modelUrls.ts:779](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L779) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"clip-vit-base-patch32-text"` = `'clip-vit-base-patch32-text'` + ### modelSource -> **modelSource**: `string` = `CLIP_VIT_BASE_PATCH32_TEXT_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-clip-vit-base-patch32/resolve/v0.7.0/clip-vit-base-patch32-text_xnnpack.pte"` = `CLIP_VIT_BASE_PATCH32_TEXT_MODEL` ### tokenizerSource -> **tokenizerSource**: `string` = `CLIP_VIT_BASE_PATCH32_TEXT_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-clip-vit-base-patch32/resolve/v0.7.0/tokenizer.json"` = `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 index e2154c4ac..2a0ede889 100644 --- 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 @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:630](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L630) ## Type Declaration 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 index 341d3f629..a1392db1f 100644 --- 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 @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:678](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L678) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101.md b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101.md index e40e1170b..5cc9a2b4e 100644 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101.md +++ b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101.md @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:622](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L622) ## Type Declaration 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 index 4d7cf7498..28552e341 100644 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET101_QUANTIZED.md @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:670](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L670) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md index b71326026..ad884c244 100644 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md +++ b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:614](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L614) ## Type Declaration 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 index c82d5bf26..f3ea9753a 100644 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50_QUANTIZED.md @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:662](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L662) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md index d1fc00ae0..b516b3c9f 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -2,10 +2,14 @@ > `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) +Defined in: [constants/modelUrls.ts:417](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L417) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"efficientnet-v2-s"` = `'efficientnet-v2-s'` + ### modelSource -> **modelSource**: `string` = `EFFICIENTNET_V2_S_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-efficientnet-v2-s/resolve/v0.7.0/coreml/efficientnet_v2_s_coreml_all.pte"` \| `"https://huggingface.co/software-mansion/react-native-executorch-efficientnet-v2-s/resolve/v0.7.0/xnnpack/efficientnet_v2_s_xnnpack.pte"` = `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 index 07f4783d3..aa4c0b7d5 100644 --- a/docs/docs/06-api-reference/variables/FCN_RESNET101.md +++ b/docs/docs/06-api-reference/variables/FCN_RESNET101.md @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:654](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L654) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/FCN_RESNET101_QUANTIZED.md b/docs/docs/06-api-reference/variables/FCN_RESNET101_QUANTIZED.md index 377dc667a..f70229fc5 100644 --- a/docs/docs/06-api-reference/variables/FCN_RESNET101_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/FCN_RESNET101_QUANTIZED.md @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:702](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L702) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/FCN_RESNET50.md b/docs/docs/06-api-reference/variables/FCN_RESNET50.md index 2546001f3..afc982320 100644 --- a/docs/docs/06-api-reference/variables/FCN_RESNET50.md +++ b/docs/docs/06-api-reference/variables/FCN_RESNET50.md @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:646](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L646) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/FCN_RESNET50_QUANTIZED.md b/docs/docs/06-api-reference/variables/FCN_RESNET50_QUANTIZED.md index b24a1757e..3851be180 100644 --- a/docs/docs/06-api-reference/variables/FCN_RESNET50_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/FCN_RESNET50_QUANTIZED.md @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:694](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L694) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/FSMN_VAD.md b/docs/docs/06-api-reference/variables/FSMN_VAD.md index 646e2dbae..5586b8f46 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -2,10 +2,14 @@ > `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) +Defined in: [constants/modelUrls.ts:817](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L817) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"fsmn-vad"` = `'fsmn-vad'` + ### modelSource -> **modelSource**: `string` = `FSMN_VAD_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-fsmn-vad/resolve/v0.7.0/xnnpack/fsmn-vad_xnnpack.pte"` = `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 index c87e3a7ab..338e10606 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:159](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L159) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"hammer2.1-0.5b"` = `'hammer2.1-0.5b'` + ### modelSource -> **modelSource**: `string` = `HAMMER2_1_0_5B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/hammer-2.1-0.5B/original/hammer2_1_0_5B_bf16.pte"` = `HAMMER2_1_0_5B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer_config.json"` = `HAMMER2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer.json"` = `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 index f96fd1ddc..854ef09e6 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:169](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L169) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"hammer2.1-0.5b-quantized"` = `'hammer2.1-0.5b-quantized'` + ### modelSource -> **modelSource**: `string` = `HAMMER2_1_0_5B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/hammer-2.1-0.5B/quantized/hammer2_1_0_5B_8da4w.pte"` = `HAMMER2_1_0_5B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer_config.json"` = `HAMMER2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer.json"` = `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 index 7f48f15e9..b4d3d42da 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:179](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L179) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"hammer2.1-1.5b"` = `'hammer2.1-1.5b'` + ### modelSource -> **modelSource**: `string` = `HAMMER2_1_1_5B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/hammer-2.1-1.5B/original/hammer2_1_1_5B_bf16.pte"` = `HAMMER2_1_1_5B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer_config.json"` = `HAMMER2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer.json"` = `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 index c478c15b1..9306d6426 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:189](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L189) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"hammer2.1-1.5b-quantized"` = `'hammer2.1-1.5b-quantized'` + ### modelSource -> **modelSource**: `string` = `HAMMER2_1_1_5B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/hammer-2.1-1.5B/quantized/hammer2_1_1_5B_8da4w.pte"` = `HAMMER2_1_1_5B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer_config.json"` = `HAMMER2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer.json"` = `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 index a5adf6276..a664cf31c 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:199](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L199) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"hammer2.1-3b"` = `'hammer2.1-3b'` + ### modelSource -> **modelSource**: `string` = `HAMMER2_1_3B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/hammer-2.1-3B/original/hammer2_1_3B_bf16.pte"` = `HAMMER2_1_3B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer_config.json"` = `HAMMER2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer.json"` = `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 index 8e5815fff..b71b95771 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:209](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L209) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"hammer2.1-3b-quantized"` = `'hammer2.1-3b-quantized'` + ### modelSource -> **modelSource**: `string` = `HAMMER2_1_3B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/hammer-2.1-3B/quantized/hammer2_1_3B_8da4w.pte"` = `HAMMER2_1_3B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer_config.json"` = `HAMMER2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-hammer-2.1/resolve/v0.7.0/tokenizer.json"` = `HAMMER2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md index cb5913cbe..9175efe00 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md @@ -2,7 +2,7 @@ > `const` **KOKORO_MEDIUM**: `object` -Defined in: [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) +Defined in: [constants/tts/models.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/tts/models.ts#L27) A standard Kokoro instance which processes the text in batches of maximum 128 tokens. @@ -12,6 +12,10 @@ A standard Kokoro instance which processes the text in batches of maximum 128 to > **durationPredictorSource**: `string` +### modelName + +> **modelName**: `"kokoro-medium"` + ### synthesizerSource > **synthesizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md index 098f4f631..74968832c 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md @@ -14,6 +14,10 @@ a lower quality speech due to forced, aggressive text splitting. > **durationPredictorSource**: `string` +### modelName + +> **modelName**: `"kokoro-small"` + ### synthesizerSource > **synthesizerSource**: `string` 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 index 934046234..e37b262c2 100644 --- 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 @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:391](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L391) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"lfm2.5-1.2b-instruct"` = `'lfm2.5-1.2b-instruct'` + ### modelSource -> **modelSource**: `string` = `LFM2_5_1_2B_INSTRUCT_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-lfm2.5-1.2B-instruct/resolve/v0.8.0/original/lfm2_5_1_2b_fp16.pte"` = `LFM2_5_1_2B_INSTRUCT_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `LFM2_5_1_2B_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-lfm2.5-1.2B-instruct/resolve/v0.8.0/tokenizer_config.json"` = `LFM2_5_1_2B_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `LFM2_5_1_2B_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-lfm2.5-1.2B-instruct/resolve/v0.8.0/tokenizer.json"` = `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 index 2854374cd..a51d4c5e7 100644 --- 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 @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:401](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L401) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"lfm2.5-1.2b-instruct-quantized"` = `'lfm2.5-1.2b-instruct-quantized'` + ### modelSource -> **modelSource**: `string` = `LFM2_5_1_2B_INSTRUCT_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-lfm2.5-1.2B-instruct/resolve/v0.8.0/quantized/lfm2_5_1_2b_8da4w.pte"` = `LFM2_5_1_2B_INSTRUCT_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `LFM2_5_1_2B_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-lfm2.5-1.2B-instruct/resolve/v0.8.0/tokenizer_config.json"` = `LFM2_5_1_2B_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `LFM2_5_1_2B_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-lfm2.5-1.2B-instruct/resolve/v0.8.0/tokenizer.json"` = `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 index ba19386ee..d27dd2424 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L49) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"llama-3.2-1b"` = `'llama-3.2-1b'` + ### modelSource -> **modelSource**: `string` = `LLAMA3_2_1B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/llama-3.2-1B/original/llama3_2_bf16.pte"` = `LLAMA3_2_1B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer_config.json"` = `LLAMA3_2_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer.json"` = `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 index 509a28ab0..d8d2739ca 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:59](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L59) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"llama-3.2-1b-qlora"` = `'llama-3.2-1b-qlora'` + ### modelSource -> **modelSource**: `string` = `LLAMA3_2_1B_QLORA_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/llama-3.2-1B/QLoRA/llama3_2_qat_lora.pte"` = `LLAMA3_2_1B_QLORA_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer_config.json"` = `LLAMA3_2_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer.json"` = `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 index 26bd6ae6d..6af9c8994 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:69](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L69) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"llama-3.2-1b-spinquant"` = `'llama-3.2-1b-spinquant'` + ### modelSource -> **modelSource**: `string` = `LLAMA3_2_1B_SPINQUANT_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/llama-3.2-1B/spinquant/llama3_2_spinquant.pte"` = `LLAMA3_2_1B_SPINQUANT_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer_config.json"` = `LLAMA3_2_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer.json"` = `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 index 792f3c5c9..dd427497e 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -6,14 +6,18 @@ Defined in: [constants/modelUrls.ts:19](https://github.com/software-mansion/reac ## Type Declaration +### modelName + +> `readonly` **modelName**: `"llama-3.2-3b"` = `'llama-3.2-3b'` + ### modelSource -> **modelSource**: `string` = `LLAMA3_2_3B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/llama-3.2-3B/original/llama3_2_3B_bf16.pte"` = `LLAMA3_2_3B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer_config.json"` = `LLAMA3_2_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer.json"` = `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 index eb0adfbba..706b46f36 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:29](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L29) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"llama-3.2-3b-qlora"` = `'llama-3.2-3b-qlora'` + ### modelSource -> **modelSource**: `string` = `LLAMA3_2_3B_QLORA_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/llama-3.2-3B/QLoRA/llama3_2-3B_qat_lora.pte"` = `LLAMA3_2_3B_QLORA_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer_config.json"` = `LLAMA3_2_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer.json"` = `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 index fb9d2c05c..21826586c 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:39](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L39) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"llama-3.2-3b-spinquant"` = `'llama-3.2-3b-spinquant'` + ### modelSource -> **modelSource**: `string` = `LLAMA3_2_3B_SPINQUANT_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/llama-3.2-3B/spinquant/llama3_2_3B_spinquant.pte"` = `LLAMA3_2_3B_SPINQUANT_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer_config.json"` = `LLAMA3_2_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-llama-3.2/resolve/v0.7.0/tokenizer.json"` = `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 index 1ad79ff02..1db00c18d 100644 --- a/docs/docs/06-api-reference/variables/LRASPP_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/LRASPP_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:638](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L638) ## Type Declaration 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 index 0f5e16f41..9b942641c 100644 --- 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 @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:686](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L686) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md index a7378ea8a..fafd3b17e 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -2,14 +2,18 @@ > `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) +Defined in: [constants/modelUrls.ts:761](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L761) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"multi-qa-minilm-l6-cos-v1"` = `'multi-qa-minilm-l6-cos-v1'` + ### modelSource -> **modelSource**: `string` = `MULTI_QA_MINILM_L6_COS_V1_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-multi-qa-MiniLM-L6-cos-v1/resolve/v0.7.0/multi-qa-MiniLM-L6-cos-v1_xnnpack.pte"` = `MULTI_QA_MINILM_L6_COS_V1_MODEL` ### tokenizerSource -> **tokenizerSource**: `string` = `MULTI_QA_MINILM_L6_COS_V1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-multi-qa-MiniLM-L6-cos-v1/resolve/v0.7.0/tokenizer.json"` = `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 index 0c22cb2b9..216d38c0c 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -2,14 +2,18 @@ > `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) +Defined in: [constants/modelUrls.ts:770](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L770) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"multi-qa-mpnet-base-dot-v1"` = `'multi-qa-mpnet-base-dot-v1'` + ### modelSource -> **modelSource**: `string` = `MULTI_QA_MPNET_BASE_DOT_V1_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-multi-qa-mpnet-base-dot-v1/resolve/v0.7.0/multi-qa-mpnet-base-dot-v1_xnnpack.pte"` = `MULTI_QA_MPNET_BASE_DOT_V1_MODEL` ### tokenizerSource -> **tokenizerSource**: `string` = `MULTI_QA_MPNET_BASE_DOT_V1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-multi-qa-mpnet-base-dot-v1/resolve/v0.7.0/tokenizer.json"` = `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 index fef48f021..0ab0887dc 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **OCR_ABAZA**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:34](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L34) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:33](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 7648f0e5f..47467ab33 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **OCR_ADYGHE**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:39](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L39) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:38](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index a7fe470b8..16da5d8c8 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **OCR_AFRIKAANS**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:44](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L44) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:43](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 8812c4d9c..4146d371c 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ALBANIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L303) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:302](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 3f0636de5..cb4a13fc5 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **OCR_AVAR**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L49) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:48](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index a0661a6ff..20aa5c349 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **OCR_AZERBAIJANI**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L54) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:53](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index f6c87ab1c..dc2ac554f 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_BELARUSIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L59) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:58](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 1ebdd507c..4b3f0a294 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_BOSNIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:69](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L69) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:68](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 56e2d0cec..0d06d33a7 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_BULGARIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:64](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L64) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:63](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 93d71ef8a..b9619b0a1 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **OCR_CHECHEN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:82](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L82) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:81](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 44ab528a4..f6dc0de4e 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_CROATIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:137](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L137) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:136](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index fc3b62d4d..020e68c06 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **OCR_CZECH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:87](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L87) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:86](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index a15475881..61a783786 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **OCR_DANISH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:97](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L97) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:96](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index c8836b4ae..e36bc9e14 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **OCR_DARGWA**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:102](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L102) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:101](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 2f33d3ba7..62e01b8f5 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **OCR_DUTCH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L237) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:236](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 594ffe951..27623dd7f 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **OCR_ENGLISH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:112](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L112) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:111](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 916aca837..e7345001d 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ESTONIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L122) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:121](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 9698e383c..2decdc2ab 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **OCR_FRENCH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:127](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L127) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:126](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index a664bd263..1a2e23dc8 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **OCR_GERMAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:107](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L107) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:106](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 536756310..4ffcbc129 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_HUNGARIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:142](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L142) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:141](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 5a219bda5..97f87fba3 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **OCR_ICELANDIC**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:157](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L157) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:156](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index e9adad3d5..000c2d517 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_INDONESIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L147) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:146](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 0a86e9f8d..e606d8bb0 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **OCR_INGUSH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L152) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:151](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 2a323f404..8a9dd73b6 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **OCR_IRISH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:132](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L132) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:131](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index fa2617145..9d6b996e1 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ITALIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:162](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L162) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:161](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 97dcab018..08f30646b 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **OCR_JAPANESE**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:167](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L167) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:166](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index fc3b792d1..5d2aeb63e 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **OCR_KANNADA**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L177) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:176](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 6418b5171..0a8c7d468 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_KARBADIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:172](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L172) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:171](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 50b82b93a..26e7e5336 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **OCR_KOREAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L182) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:181](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 8ecc9099b..bd960ea25 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **OCR_KURDISH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:187](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L187) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:186](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index b285759cd..5166ec0d7 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **OCR_LAK**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:197](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L197) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:196](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index e2d54f19d..5de2d6317 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR_LATIN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:192](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L192) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:191](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index ebd483252..08e5a17b2 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_LATVIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L212) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:211](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 23c7f2561..4ef8b4fe8 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_LEZGHIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:202](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L202) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:201](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 52e87ca78..bed1b68f0 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_LITHUANIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L207) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:206](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index f7b507731..5cc2c4435 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **OCR_MALAY**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:227](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L227) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:226](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 7fbb990ca..216f3e5cd 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **OCR_MALTESE**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:232](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L232) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:231](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 448736ae1..4640eeec9 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **OCR_MAORI**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:217](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L217) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:216](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index ab60aef78..48ece7ab7 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_MONGOLIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:222](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L222) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:221](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 251dde90a..8412d9182 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_NORWEGIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L242) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:241](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 8140561b0..f4bb0474a 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **OCR_OCCITAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:247](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L247) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:246](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 906364c00..2a69f5815 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **OCR_PALI**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:252](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L252) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:251](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index ccd12ff6b..ea2530e03 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **OCR_POLISH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:257](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L257) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:256](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index cd8987230..5b857ee26 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **OCR_PORTUGUESE**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:262](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L262) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:261](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 58052f945..e56502ad6 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ROMANIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L267) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:266](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 3e76f334b..f30da640e 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_RUSSIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L272) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:271](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 4ff34c72f..cf6e2b91d 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **OCR_SERBIAN_CYRILLIC**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:277](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L277) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:276](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 4c9d21a7c..f1b7fe803 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR_SERBIAN_LATIN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L285) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:284](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 631e7f80b..23b5fc17e 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **OCR_SIMPLIFIED_CHINESE**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:74](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L74) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:73](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index c27a61484..1c83f091d 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **OCR_SLOVAK**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:293](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L293) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:292](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 2d76050f4..e26f35ce2 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_SLOVENIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:298](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L298) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:297](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index d9c3ecd04..e46f15bc8 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **OCR_SPANISH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L117) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:116](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 45aa67e60..a41740498 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **OCR_SWAHILI**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:313](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L313) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:312](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 564ffa0ed..6eeba8735 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **OCR_SWEDISH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L308) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:307](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 15b94d72d..eb86149b0 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **OCR_TABASSARAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:318](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L318) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:317](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 91496254d..89f58b9d8 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **OCR_TAGALOG**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:333](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L333) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:332](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index a448882ad..002e0473b 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **OCR_TAJIK**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:328](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L328) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:327](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 0d767de82..1a4e894cf 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **OCR_TELUGU**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:323](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L323) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:322](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index f48ea3cd8..562d609fb 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **OCR_TURKISH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:338](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L338) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:337](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 55ec63925..c0caf86e2 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_UKRAINIAN**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:343](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L343) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:342](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 77b0185ca..5c4f8c83d 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **OCR_UZBEK**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:348](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L348) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:347](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index c47d7e8df..558e4511a 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **OCR_VIETNAMESE**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:353](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L353) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:352](https://github.com/software-mansion/re > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index 3086be6ce..90c1eff6d 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **OCR_WELSH**: `object` -Defined in: [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) +Defined in: [constants/ocr/models.ts:92](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/ocr/models.ts#L92) ## Type Declaration @@ -14,6 +14,10 @@ Defined in: [constants/ocr/models.ts:91](https://github.com/software-mansion/rea > **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"` +### modelName + +> **modelName**: `"ocr-abq"` \| `"ocr-ady"` \| `"ocr-af"` \| `"ocr-ava"` \| `"ocr-az"` \| `"ocr-be"` \| `"ocr-bg"` \| `"ocr-bs"` \| `"ocr-chSim"` \| `"ocr-che"` \| `"ocr-cs"` \| `"ocr-cy"` \| `"ocr-da"` \| `"ocr-dar"` \| `"ocr-de"` \| `"ocr-en"` \| `"ocr-es"` \| `"ocr-et"` \| `"ocr-fr"` \| `"ocr-ga"` \| `"ocr-hr"` \| `"ocr-hu"` \| `"ocr-id"` \| `"ocr-inh"` \| `"ocr-ic"` \| `"ocr-it"` \| `"ocr-ja"` \| `"ocr-kbd"` \| `"ocr-kn"` \| `"ocr-ko"` \| `"ocr-ku"` \| `"ocr-la"` \| `"ocr-lbe"` \| `"ocr-lez"` \| `"ocr-lt"` \| `"ocr-lv"` \| `"ocr-mi"` \| `"ocr-mn"` \| `"ocr-ms"` \| `"ocr-mt"` \| `"ocr-nl"` \| `"ocr-no"` \| `"ocr-oc"` \| `"ocr-pi"` \| `"ocr-pl"` \| `"ocr-pt"` \| `"ocr-ro"` \| `"ocr-ru"` \| `"ocr-rsCyrillic"` \| `"ocr-rsLatin"` \| `"ocr-sk"` \| `"ocr-sl"` \| `"ocr-sq"` \| `"ocr-sv"` \| `"ocr-sw"` \| `"ocr-tab"` \| `"ocr-te"` \| `"ocr-tjk"` \| `"ocr-tl"` \| `"ocr-tr"` \| `"ocr-uk"` \| `"ocr-uz"` \| `"ocr-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 index ad438ab3d..5024ef968 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:365](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L365) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"phi-4-mini-4b"` = `'phi-4-mini-4b'` + ### modelSource -> **modelSource**: `string` = `PHI_4_MINI_4B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-phi-4-mini/resolve/v0.7.0/original/phi-4-mini_bf16.pte"` = `PHI_4_MINI_4B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `PHI_4_MINI_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-phi-4-mini/resolve/v0.7.0/tokenizer_config.json"` = `PHI_4_MINI_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `PHI_4_MINI_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-phi-4-mini/resolve/v0.7.0/tokenizer.json"` = `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 index f85068fd3..860a59028 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L375) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"phi-4-mini-4b-quantized"` = `'phi-4-mini-4b-quantized'` + ### modelSource -> **modelSource**: `string` = `PHI_4_MINI_4B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-phi-4-mini/resolve/v0.7.0/quantized/phi-4-mini_8da4w.pte"` = `PHI_4_MINI_4B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `PHI_4_MINI_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-phi-4-mini/resolve/v0.7.0/tokenizer_config.json"` = `PHI_4_MINI_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `PHI_4_MINI_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-phi-4-mini/resolve/v0.7.0/tokenizer.json"` = `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 index 156f5dac0..453fd52da 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:299](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L299) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen2.5-0.5b"` = `'qwen2.5-0.5b'` + ### modelSource -> **modelSource**: `string` = `QWEN2_5_0_5B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/qwen-2.5-0.5B/original/qwen2_5_0_5b_bf16.pte"` = `QWEN2_5_0_5B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer_config.json"` = `QWEN2_5_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer.json"` = `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 index aebad7bc8..bf3fe5cf9 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:309](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L309) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen2.5-0.5b-quantized"` = `'qwen2.5-0.5b-quantized'` + ### modelSource -> **modelSource**: `string` = `QWEN2_5_0_5B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/qwen-2.5-0.5B/quantized/qwen2_5_0_5b_8da4w.pte"` = `QWEN2_5_0_5B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer_config.json"` = `QWEN2_5_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer.json"` = `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 index 8b76b6a51..d5f40cc76 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:319](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L319) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen2.5-1.5b"` = `'qwen2.5-1.5b'` + ### modelSource -> **modelSource**: `string` = `QWEN2_5_1_5B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/qwen-2.5-1.5B/original/qwen2_5_1_5b_bf16.pte"` = `QWEN2_5_1_5B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer_config.json"` = `QWEN2_5_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer.json"` = `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 index c8be4d14c..e5f63501e 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:329](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L329) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen2.5-1.5b-quantized"` = `'qwen2.5-1.5b-quantized'` + ### modelSource -> **modelSource**: `string` = `QWEN2_5_1_5B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/qwen-2.5-1.5B/quantized/qwen2_5_1_5b_8da4w.pte"` = `QWEN2_5_1_5B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer_config.json"` = `QWEN2_5_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer.json"` = `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 index 82d6c3a78..64d00140f 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:339](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L339) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen2.5-3b"` = `'qwen2.5-3b'` + ### modelSource -> **modelSource**: `string` = `QWEN2_5_3B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/qwen-2.5-3B/original/qwen2_5_3b_bf16.pte"` = `QWEN2_5_3B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer_config.json"` = `QWEN2_5_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer.json"` = `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 index 846919571..909d9bf37 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:349](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L349) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen2.5-3b-quantized"` = `'qwen2.5-3b-quantized'` + ### modelSource -> **modelSource**: `string` = `QWEN2_5_3B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/qwen-2.5-3B/quantized/qwen2_5_3b_8da4w.pte"` = `QWEN2_5_3B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer_config.json"` = `QWEN2_5_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-2.5/resolve/v0.7.0/tokenizer.json"` = `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 index 80b34b466..1b84b1ba3 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:89](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L89) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen3-0.6b"` = `'qwen3-0.6b'` + ### modelSource -> **modelSource**: `string` = `QWEN3_0_6B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/qwen-3-0.6B/original/qwen3_0_6b_bf16.pte"` = `QWEN3_0_6B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer_config.json"` = `QWEN3_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer.json"` = `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 index e5a946d5a..69afec5c4 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:99](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L99) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen3-0.6b-quantized"` = `'qwen3-0.6b-quantized'` + ### modelSource -> **modelSource**: `string` = `QWEN3_0_6B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/qwen-3-0.6B/quantized/qwen3_0_6b_8da4w.pte"` = `QWEN3_0_6B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer_config.json"` = `QWEN3_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer.json"` = `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 index fb941f7c6..91285aa5c 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:109](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L109) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen3-1.7b"` = `'qwen3-1.7b'` + ### modelSource -> **modelSource**: `string` = `QWEN3_1_7B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/qwen-3-1.7B/original/qwen3_1_7b_bf16.pte"` = `QWEN3_1_7B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer_config.json"` = `QWEN3_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer.json"` = `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 index fc7dd7ae7..90d109506 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +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 +### modelName + +> `readonly` **modelName**: `"qwen3-1.7b-quantized"` = `'qwen3-1.7b-quantized'` + ### modelSource -> **modelSource**: `string` = `QWEN3_1_7B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/qwen-3-1.7B/quantized/qwen3_1_7b_8da4w.pte"` = `QWEN3_1_7B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer_config.json"` = `QWEN3_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer.json"` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index f11eab343..6cf966b9c 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:129](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L129) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen3-4b"` = `'qwen3-4b'` + ### modelSource -> **modelSource**: `string` = `QWEN3_4B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/qwen-3-4B/original/qwen3_4b_bf16.pte"` = `QWEN3_4B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer_config.json"` = `QWEN3_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer.json"` = `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 index 4345b2eb8..8d166bc6c 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:139](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L139) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"qwen3-4b-quantized"` = `'qwen3-4b-quantized'` + ### modelSource -> **modelSource**: `string` = `QWEN3_4B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/qwen-3-4B/quantized/qwen3_4b_8da4w.pte"` = `QWEN3_4B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer_config.json"` = `QWEN3_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-qwen-3/resolve/v0.7.0/tokenizer.json"` = `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 index 7a27c149d..a7426cbc0 100644 --- a/docs/docs/06-api-reference/variables/RF_DETR_NANO.md +++ b/docs/docs/06-api-reference/variables/RF_DETR_NANO.md @@ -2,7 +2,7 @@ > `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) +Defined in: [constants/modelUrls.ts:437](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L437) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md b/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md index bc6f0eeef..efd4671a2 100644 --- a/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md +++ b/docs/docs/06-api-reference/variables/SELFIE_SEGMENTATION.md @@ -2,7 +2,7 @@ > `const` **SELFIE_SEGMENTATION**: `object` -Defined in: [constants/modelUrls.ts:665](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L665) +Defined in: [constants/modelUrls.ts:712](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L712) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md index d827c0583..3e0fd179d 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -2,18 +2,22 @@ > `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) +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 +### modelName + +> `readonly` **modelName**: `"smollm2.1-135m"` = `'smollm2.1-135m'` + ### modelSource -> **modelSource**: `string` = `SMOLLM2_1_135M_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/smolLm-2-135M/original/smolLm2_135M_bf16.pte"` = `SMOLLM2_1_135M_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer_config.json"` = `SMOLLM2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer.json"` = `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 index db395e6e4..bc2597477 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:239](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L239) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"smollm2.1-135m-quantized"` = `'smollm2.1-135m-quantized'` + ### modelSource -> **modelSource**: `string` = `SMOLLM2_1_135M_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/smolLm-2-135M/quantized/smolLm2_135M_8da4w.pte"` = `SMOLLM2_1_135M_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer_config.json"` = `SMOLLM2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer.json"` = `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 index b44e61632..727299d27 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:269](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L269) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"smollm2.1-1.7b"` = `'smollm2.1-1.7b'` + ### modelSource -> **modelSource**: `string` = `SMOLLM2_1_1_7B_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/smolLm-2-1.7B/original/smolLm2_1_7B_bf16.pte"` = `SMOLLM2_1_1_7B_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer_config.json"` = `SMOLLM2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer.json"` = `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 index af5bfd9a5..f6c3bfed9 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:279](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L279) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"smollm2.1-1.7b-quantized"` = `'smollm2.1-1.7b-quantized'` + ### modelSource -> **modelSource**: `string` = `SMOLLM2_1_1_7B_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/smolLm-2-1.7B/quantized/smolLm2_1_7B_8da4w.pte"` = `SMOLLM2_1_1_7B_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer_config.json"` = `SMOLLM2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer.json"` = `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 index 0f8ecc7d3..fbcec010e 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:249](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L249) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"smollm2.1-360m"` = `'smollm2.1-360m'` + ### modelSource -> **modelSource**: `string` = `SMOLLM2_1_360M_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/smolLm-2-360M/original/smolLm2_360M_bf16.pte"` = `SMOLLM2_1_360M_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer_config.json"` = `SMOLLM2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer.json"` = `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 index ead0bc996..5c6e44c23 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -2,18 +2,22 @@ > `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) +Defined in: [constants/modelUrls.ts:259](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L259) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"smollm2.1-360m-quantized"` = `'smollm2.1-360m-quantized'` + ### modelSource -> **modelSource**: `string` = `SMOLLM2_1_360M_QUANTIZED_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/smolLm-2-360M/quantized/smolLm2_360M_8da4w.pte"` = `SMOLLM2_1_360M_QUANTIZED_MODEL` ### tokenizerConfigSource -> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` +> `readonly` **tokenizerConfigSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer_config.json"` = `SMOLLM2_1_TOKENIZER_CONFIG` ### tokenizerSource -> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-smolLm-2/resolve/v0.7.0/tokenizer.json"` = `SMOLLM2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md index 4c28e4ff4..1511411b6 100644 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `const` **SSDLITE_320_MOBILENET_V3_LARGE**: `object` -Defined in: [constants/modelUrls.ts:394](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L394) +Defined in: [constants/modelUrls.ts:429](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L429) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md index c82979642..3058f7a04 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -2,10 +2,14 @@ > `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) +Defined in: [constants/modelUrls.ts:463](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L463) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"style-transfer-candy"` = `'style-transfer-candy'` + ### modelSource -> **modelSource**: `string` = `STYLE_TRANSFER_CANDY_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-style-transfer-candy/resolve/v0.7.0/coreml/style_transfer_candy_coreml.pte"` \| `"https://huggingface.co/software-mansion/react-native-executorch-style-transfer-candy/resolve/v0.7.0/xnnpack/style_transfer_candy_xnnpack.pte"` = `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 index f57bb8859..8ee48a8a3 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -2,10 +2,14 @@ > `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) +Defined in: [constants/modelUrls.ts:471](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L471) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"style-transfer-mosaic"` = `'style-transfer-mosaic'` + ### modelSource -> **modelSource**: `string` = `STYLE_TRANSFER_MOSAIC_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-style-transfer-mosaic/resolve/v0.7.0/coreml/style_transfer_mosaic_coreml.pte"` \| `"https://huggingface.co/software-mansion/react-native-executorch-style-transfer-mosaic/resolve/v0.7.0/xnnpack/style_transfer_mosaic_xnnpack.pte"` = `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 index 8cf07fd19..3543f628c 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -2,10 +2,14 @@ > `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) +Defined in: [constants/modelUrls.ts:479](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L479) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"style-transfer-rain-princess"` = `'style-transfer-rain-princess'` + ### modelSource -> **modelSource**: `string` = `STYLE_TRANSFER_RAIN_PRINCESS_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-style-transfer-rain-princess/resolve/v0.7.0/coreml/style_transfer_rain_princess_coreml.pte"` \| `"https://huggingface.co/software-mansion/react-native-executorch-style-transfer-rain-princess/resolve/v0.7.0/xnnpack/style_transfer_rain_princess_xnnpack.pte"` = `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 index 20cd7cb3b..4d1536f1f 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -2,10 +2,14 @@ > `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) +Defined in: [constants/modelUrls.ts:487](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L487) ## Type Declaration +### modelName + +> `readonly` **modelName**: `"style-transfer-udnie"` = `'style-transfer-udnie'` + ### modelSource -> **modelSource**: `string` = `STYLE_TRANSFER_UDNIE_MODEL` +> `readonly` **modelSource**: `"https://huggingface.co/software-mansion/react-native-executorch-style-transfer-udnie/resolve/v0.7.0/coreml/style_transfer_udnie_coreml.pte"` \| `"https://huggingface.co/software-mansion/react-native-executorch-style-transfer-udnie/resolve/v0.7.0/xnnpack/style_transfer_udnie_xnnpack.pte"` = `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 index c48856a93..eaa56f6f8 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -2,22 +2,26 @@ > `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) +Defined in: [constants/modelUrls.ts:578](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L578) ## Type Declaration ### decoderSource -> **decoderSource**: `string` = `WHISPER_BASE_DECODER_MODEL` +> `readonly` **decoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-base/resolve/v0.7.0/xnnpack/whisper_base_decoder_xnnpack.pte"` = `WHISPER_BASE_DECODER_MODEL` ### encoderSource -> **encoderSource**: `string` = `WHISPER_BASE_ENCODER_MODEL` +> `readonly` **encoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-base/resolve/v0.7.0/xnnpack/whisper_base_encoder_xnnpack.pte"` = `WHISPER_BASE_ENCODER_MODEL` ### isMultilingual -> **isMultilingual**: `boolean` = `true` +> `readonly` **isMultilingual**: `true` = `true` + +### modelName + +> `readonly` **modelName**: `"whisper-base"` = `'whisper-base'` ### tokenizerSource -> **tokenizerSource**: `string` = `WHISPER_BASE_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-base/resolve/v0.7.0/tokenizer.json"` = `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 index ab44fad16..7048a86a4 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -2,22 +2,26 @@ > `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) +Defined in: [constants/modelUrls.ts:545](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L545) ## Type Declaration ### decoderSource -> **decoderSource**: `string` = `WHISPER_BASE_EN_DECODER` +> `readonly` **decoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-base.en/resolve/v0.7.0/xnnpack/whisper_base_en_decoder_xnnpack.pte"` = `WHISPER_BASE_EN_DECODER` ### encoderSource -> **encoderSource**: `string` = `WHISPER_BASE_EN_ENCODER` +> `readonly` **encoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-base.en/resolve/v0.7.0/xnnpack/whisper_base_en_encoder_xnnpack.pte"` = `WHISPER_BASE_EN_ENCODER` ### isMultilingual -> **isMultilingual**: `boolean` = `false` +> `readonly` **isMultilingual**: `false` = `false` + +### modelName + +> `readonly` **modelName**: `"whisper-base-en"` = `'whisper-base-en'` ### tokenizerSource -> **tokenizerSource**: `string` = `WHISPER_BASE_EN_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-base.en/resolve/v0.7.0/tokenizer.json"` = `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 index dde353ccc..62f6d83d6 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -2,22 +2,26 @@ > `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) +Defined in: [constants/modelUrls.ts:589](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L589) ## Type Declaration ### decoderSource -> **decoderSource**: `string` = `WHISPER_SMALL_DECODER_MODEL` +> `readonly` **decoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-small/resolve/v0.7.0/xnnpack/whisper_small_decoder_xnnpack.pte"` = `WHISPER_SMALL_DECODER_MODEL` ### encoderSource -> **encoderSource**: `string` = `WHISPER_SMALL_ENCODER_MODEL` +> `readonly` **encoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-small/resolve/v0.7.0/xnnpack/whisper_small_encoder_xnnpack.pte"` = `WHISPER_SMALL_ENCODER_MODEL` ### isMultilingual -> **isMultilingual**: `boolean` = `true` +> `readonly` **isMultilingual**: `true` = `true` + +### modelName + +> `readonly` **modelName**: `"whisper-small"` = `'whisper-small'` ### tokenizerSource -> **tokenizerSource**: `string` = `WHISPER_SMALL_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-small/resolve/v0.7.0/tokenizer.json"` = `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 index b832832c3..a9da6487a 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -2,22 +2,26 @@ > `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) +Defined in: [constants/modelUrls.ts:556](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L556) ## Type Declaration ### decoderSource -> **decoderSource**: `string` = `WHISPER_SMALL_EN_DECODER` +> `readonly` **decoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-small.en/resolve/v0.7.0/xnnpack/whisper_small_en_decoder_xnnpack.pte"` = `WHISPER_SMALL_EN_DECODER` ### encoderSource -> **encoderSource**: `string` = `WHISPER_SMALL_EN_ENCODER` +> `readonly` **encoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-small.en/resolve/v0.7.0/xnnpack/whisper_small_en_encoder_xnnpack.pte"` = `WHISPER_SMALL_EN_ENCODER` ### isMultilingual -> **isMultilingual**: `boolean` = `false` +> `readonly` **isMultilingual**: `false` = `false` + +### modelName + +> `readonly` **modelName**: `"whisper-small-en"` = `'whisper-small-en'` ### tokenizerSource -> **tokenizerSource**: `string` = `WHISPER_SMALL_EN_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-small.en/resolve/v0.7.0/tokenizer.json"` = `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 index 27f0abd75..07ec63ac0 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -2,22 +2,26 @@ > `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) +Defined in: [constants/modelUrls.ts:567](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L567) ## Type Declaration ### decoderSource -> **decoderSource**: `string` = `WHISPER_TINY_DECODER_MODEL` +> `readonly` **decoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-tiny/resolve/v0.7.0/xnnpack/whisper_tiny_decoder_xnnpack.pte"` = `WHISPER_TINY_DECODER_MODEL` ### encoderSource -> **encoderSource**: `string` = `WHISPER_TINY_ENCODER_MODEL` +> `readonly` **encoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-tiny/resolve/v0.7.0/xnnpack/whisper_tiny_encoder_xnnpack.pte"` = `WHISPER_TINY_ENCODER_MODEL` ### isMultilingual -> **isMultilingual**: `boolean` = `true` +> `readonly` **isMultilingual**: `true` = `true` + +### modelName + +> `readonly` **modelName**: `"whisper-tiny"` = `'whisper-tiny'` ### tokenizerSource -> **tokenizerSource**: `string` = `WHISPER_TINY_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-tiny/resolve/v0.7.0/tokenizer.json"` = `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 index b54b13ba8..21eaddfb2 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -2,22 +2,26 @@ > `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) +Defined in: [constants/modelUrls.ts:523](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/constants/modelUrls.ts#L523) ## Type Declaration ### decoderSource -> **decoderSource**: `string` = `WHISPER_TINY_EN_DECODER` +> `readonly` **decoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-tiny.en/resolve/v0.7.0/xnnpack/whisper_tiny_en_decoder_xnnpack.pte"` = `WHISPER_TINY_EN_DECODER` ### encoderSource -> **encoderSource**: `string` = `WHISPER_TINY_EN_ENCODER` +> `readonly` **encoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-tiny.en/resolve/v0.7.0/xnnpack/whisper_tiny_en_encoder_xnnpack.pte"` = `WHISPER_TINY_EN_ENCODER` ### isMultilingual -> **isMultilingual**: `boolean` = `false` +> `readonly` **isMultilingual**: `false` = `false` + +### modelName + +> `readonly` **modelName**: `"whisper-tiny-en"` = `'whisper-tiny-en'` ### tokenizerSource -> **tokenizerSource**: `string` = `WHISPER_TINY_EN_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-tiny.en/resolve/v0.7.0/tokenizer.json"` = `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 index 29266d1b7..961eb87d2 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -2,22 +2,26 @@ > `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) +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_TINY_EN_DECODER_QUANTIZED` +> `readonly` **decoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-tiny-quantized.en/resolve/v0.7.0/xnnpack/whisper_tiny_quantized_en_decoder_xnnpack.pte"` = `WHISPER_TINY_EN_DECODER_QUANTIZED` ### encoderSource -> **encoderSource**: `string` = `WHISPER_TINY_EN_ENCODER_QUANTIZED` +> `readonly` **encoderSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-tiny-quantized.en/resolve/v0.7.0/xnnpack/whisper_tiny_quantized_en_encoder_xnnpack.pte"` = `WHISPER_TINY_EN_ENCODER_QUANTIZED` ### isMultilingual -> **isMultilingual**: `boolean` = `false` +> `readonly` **isMultilingual**: `false` = `false` + +### modelName + +> `readonly` **modelName**: `"whisper-tiny-en-quantized"` = `'whisper-tiny-en-quantized'` ### tokenizerSource -> **tokenizerSource**: `string` = `WHISPER_TINY_EN_TOKENIZER` +> `readonly` **tokenizerSource**: `"https://huggingface.co/software-mansion/react-native-executorch-whisper-tiny.en/resolve/v0.7.0/tokenizer.json"` = `WHISPER_TINY_EN_TOKENIZER`