From 52f159a4a2e7ec31eb83d2ecb70223cbc5abd73c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Thu, 22 Jan 2026 16:16:32 +0100 Subject: [PATCH 01/15] Add first working autogenerated API --- docs/docusaurus.config.js | 18 +++++++++ docs/package.json | 5 ++- docs/sidebars.js | 79 ++++++++++++++++++++++++++++++++++++++- 3 files changed, 100 insertions(+), 2 deletions(-) diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 25a064103..d4c15ddf2 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -50,6 +50,24 @@ const config = { ], ], + plugins: [ + [ + 'docusaurus-plugin-typedoc', + { + // 1. Point to the specific entry point inside the package + entryPoints: ['../packages/react-native-executorch/src/index.ts'], + + // 2. Point to the specific tsconfig inside that package + tsconfig: '../packages/react-native-executorch/tsconfig.doc.json', + + out: './docs/api', + + // Remove invalid 'sidebar' option (v4+) + // sidebar: { ... } + }, + ], + ], + themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ diff --git a/docs/package.json b/docs/package.json index fb3a791bd..27ed8d87b 100644 --- a/docs/package.json +++ b/docs/package.json @@ -37,7 +37,10 @@ }, "devDependencies": { "@docusaurus/module-type-aliases": "^3.9.2", - "@docusaurus/tsconfig": "^3.9.2" + "@docusaurus/tsconfig": "^3.9.2", + "docusaurus-plugin-typedoc": "^1.4.2", + "typedoc": "^0.28.16", + "typedoc-plugin-markdown": "^4.9.0" }, "browserslist": { "production": [ diff --git a/docs/sidebars.js b/docs/sidebars.js index ef1bd11a1..190c0a67f 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -14,7 +14,84 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], + tutorialSidebar: [ + { + type: 'category', + label: 'Fundamentals', + items: [{ type: 'autogenerated', dirName: '01-fundamentals' }], + }, + { + type: 'category', + label: 'Benchmarks', + items: [{ type: 'autogenerated', dirName: '02-benchmarks' }], + }, + { + type: 'category', + label: 'Hooks', + items: [{ type: 'autogenerated', dirName: '03-hooks' }], + }, + { + type: 'category', + label: 'Typescript API', + items: [{ type: 'autogenerated', dirName: '04-typescript-api' }], + }, + { + type: 'category', + label: 'Utilities', + items: [{ type: 'autogenerated', dirName: '05-utilities' }], + }, + + // --------------------------------------------------------- + // 2. The New Clean API Section + // --------------------------------------------------------- + { + type: 'category', + label: 'API Reference', + collapsible: false, + collapsed: false, + link: { + type: 'doc', + id: 'api/index', // This links to the page containing Classes/Enums list + }, + // LEAVE THIS EMPTY. + // Instead of listing 100 files in the sidebar, we let the user + // click "API Reference" and use the Table of Contents (Right Sidebar) + // to jump to Classes, Enums, etc. + items: [], + }, + // { type: 'autogenerated', dirName: '.' }, + // { + // type: 'category', + // label: 'API Reference', + // collapsible: false, // Make it look like a top-level header + // collapsed: false, + // link: { + // type: 'doc', + // id: 'api/index', // This handles versioning automatically (/docs/next/api vs /docs/1.0/api) + // }, + // items: [], // Leave empty: cleaner sidebar, no broken links + // }, + // // 2. API Reference (Manually Added) + // // "label" works perfectly fine here! + // { + // type: 'category', + // label: 'API Reference', + // // CHANGE THIS: Use 'generated-index' instead of 'doc' + // // This tells Docusaurus: "Just generate a list of children here." + // link: { + // type: 'generated-index', + // title: 'API Reference', + // description: 'React Native ExecuTorch API', + // slug: '/api', + // }, + // items: [ + // { + // type: 'autogenerated', + // dirName: 'api', + // }, + // ], + // }, + ], // But you can create a sidebar manually /* From 71a9d058093861a2b0b4298ba71618419fed3181 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Thu, 22 Jan 2026 18:58:18 +0100 Subject: [PATCH 02/15] Add subsection for generated API --- .../04-error-handling.md | 0 .../classes/ClassificationModule.md | 143 +++++++ .../classes/ExecutorchModule.md | 141 +++++++ .../classes/ImageEmbeddingsModule.md | 143 +++++++ .../classes/ImageSegmentationModule.md | 151 +++++++ .../06-api-reference/classes/LLMModule.md | 223 ++++++++++ .../06-api-reference/classes/OCRModule.md | 77 ++++ .../classes/ObjectDetectionModule.md | 147 +++++++ .../classes/ResourceFetcher.md | 157 +++++++ .../classes/RnExecutorchError.md | 239 +++++++++++ .../classes/SpeechToTextModule.md | 163 ++++++++ .../classes/StyleTransferModule.md | 143 +++++++ .../classes/TextEmbeddingsModule.md | 147 +++++++ .../classes/TextToImageModule.md | 191 +++++++++ .../classes/TokenizerModule.md | 133 ++++++ .../06-api-reference/classes/VADModule.md | 143 +++++++ .../classes/VerticalOCRModule.md | 81 ++++ .../enumerations/DeeplabLabel.md | 179 ++++++++ .../enumerations/RnExecutorchErrorCode.md | 387 ++++++++++++++++++ .../enumerations/ScalarType.md | 179 ++++++++ .../DEFAULT_STRUCTURED_OUTPUT_PROMPT.md | 15 + .../fixAndValidateStructuredOutput.md | 25 ++ .../functions/getStructuredOutputPrompt.md | 21 + .../functions/useClassification.md | 45 ++ .../functions/useExecutorchModule.md | 45 ++ .../functions/useImageEmbeddings.md | 45 ++ .../functions/useImageSegmentation.md | 45 ++ .../docs/06-api-reference/functions/useLLM.md | 33 ++ .../docs/06-api-reference/functions/useOCR.md | 33 ++ .../functions/useObjectDetection.md | 45 ++ .../functions/useSpeechToText.md | 129 ++++++ .../functions/useStyleTransfer.md | 45 ++ .../functions/useTextEmbeddings.md | 45 ++ .../functions/useTextToImage.md | 45 ++ .../functions/useTextToSpeech.md | 59 +++ .../functions/useTokenizer.md | 111 +++++ .../docs/06-api-reference/functions/useVAD.md | 45 ++ .../functions/useVerticalOCR.md | 37 ++ docs/docs/06-api-reference/index.md | 272 ++++++++++++ docs/docs/06-api-reference/interfaces/Bbox.md | 35 ++ .../06-api-reference/interfaces/ChatConfig.md | 27 ++ .../interfaces/DecodingOptions.md | 11 + .../06-api-reference/interfaces/Detection.md | 27 ++ .../interfaces/GenerationConfig.md | 35 ++ .../06-api-reference/interfaces/LLMType.md | 169 ++++++++ .../06-api-reference/interfaces/Message.md | 19 + .../06-api-reference/interfaces/OCRBbox.md | 19 + .../interfaces/OCRDetection.md | 27 ++ .../06-api-reference/interfaces/Segment.md | 19 + .../interfaces/SpeechToTextModelConfig.md | 35 ++ .../06-api-reference/interfaces/TensorPtr.md | 27 ++ .../06-api-reference/interfaces/ToolCall.md | 19 + .../interfaces/ToolsConfig.md | 37 ++ .../06-api-reference/type-aliases/LLMTool.md | 5 + .../type-aliases/MessageRole.md | 5 + .../type-aliases/OCRLanguage.md | 5 + .../type-aliases/ResourceSource.md | 5 + .../type-aliases/SpeechToTextLanguage.md | 5 + .../type-aliases/TensorBuffer.md | 5 + .../docs/06-api-reference/typedoc-sidebar.cjs | 4 + .../variables/ALL_MINILM_L6_V2.md | 15 + .../variables/ALL_MPNET_BASE_V2.md | 15 + .../variables/BK_SDM_TINY_VPRED_256.md | 27 ++ .../variables/BK_SDM_TINY_VPRED_512.md | 27 ++ .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 11 + .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 15 + .../variables/DEEPLAB_V3_RESNET50.md | 11 + .../variables/DEFAULT_CHAT_CONFIG.md | 5 + .../DEFAULT_CONTEXT_WINDOW_LENGTH.md | 5 + .../variables/DEFAULT_MESSAGE_HISTORY.md | 5 + .../variables/DEFAULT_SYSTEM_PROMPT.md | 5 + .../variables/EFFICIENTNET_V2_S.md | 11 + .../06-api-reference/variables/FSMN_VAD.md | 11 + .../variables/HAMMER2_1_0_5B.md | 19 + .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 19 + .../variables/HAMMER2_1_1_5B.md | 19 + .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 19 + .../variables/HAMMER2_1_3B.md | 19 + .../variables/HAMMER2_1_3B_QUANTIZED.md | 19 + .../06-api-reference/variables/KOKORO_EN.md | 27 ++ .../variables/KOKORO_VOICE_AF_HEART.md | 5 + .../variables/KOKORO_VOICE_AF_RIVER.md | 5 + .../variables/KOKORO_VOICE_AF_SARAH.md | 5 + .../variables/KOKORO_VOICE_AM_ADAM.md | 5 + .../variables/KOKORO_VOICE_AM_MICHAEL.md | 5 + .../variables/KOKORO_VOICE_AM_SANTA.md | 5 + .../variables/KOKORO_VOICE_BF_EMMA.md | 5 + .../variables/KOKORO_VOICE_BM_DANIEL.md | 5 + .../06-api-reference/variables/LLAMA3_2_1B.md | 19 + .../variables/LLAMA3_2_1B_QLORA.md | 19 + .../variables/LLAMA3_2_1B_SPINQUANT.md | 19 + .../06-api-reference/variables/LLAMA3_2_3B.md | 19 + .../variables/LLAMA3_2_3B_QLORA.md | 19 + .../variables/LLAMA3_2_3B_SPINQUANT.md | 19 + .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 15 + .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 15 + .../06-api-reference/variables/OCR_ABAZA.md | 19 + .../06-api-reference/variables/OCR_ADYGHE.md | 19 + .../variables/OCR_AFRIKAANS.md | 19 + .../variables/OCR_ALBANIAN.md | 19 + .../06-api-reference/variables/OCR_AVAR.md | 19 + .../variables/OCR_AZERBAIJANI.md | 19 + .../variables/OCR_BELARUSIAN.md | 19 + .../06-api-reference/variables/OCR_BOSNIAN.md | 19 + .../variables/OCR_BULGARIAN.md | 19 + .../06-api-reference/variables/OCR_CHECHEN.md | 19 + .../variables/OCR_CROATIAN.md | 19 + .../06-api-reference/variables/OCR_CZECH.md | 19 + .../06-api-reference/variables/OCR_DANISH.md | 19 + .../06-api-reference/variables/OCR_DARGWA.md | 19 + .../06-api-reference/variables/OCR_DUTCH.md | 19 + .../06-api-reference/variables/OCR_ENGLISH.md | 19 + .../variables/OCR_ESTONIAN.md | 19 + .../06-api-reference/variables/OCR_FRENCH.md | 19 + .../06-api-reference/variables/OCR_GERMAN.md | 19 + .../variables/OCR_HUNGARIAN.md | 19 + .../variables/OCR_ICELANDIC.md | 19 + .../variables/OCR_INDONESIAN.md | 19 + .../06-api-reference/variables/OCR_INGUSH.md | 19 + .../06-api-reference/variables/OCR_IRISH.md | 19 + .../06-api-reference/variables/OCR_ITALIAN.md | 19 + .../variables/OCR_JAPANESE.md | 19 + .../06-api-reference/variables/OCR_KANNADA.md | 19 + .../variables/OCR_KARBADIAN.md | 19 + .../06-api-reference/variables/OCR_KOREAN.md | 19 + .../06-api-reference/variables/OCR_KURDISH.md | 19 + .../06-api-reference/variables/OCR_LAK.md | 19 + .../06-api-reference/variables/OCR_LATIN.md | 19 + .../06-api-reference/variables/OCR_LATVIAN.md | 19 + .../variables/OCR_LEZGHIAN.md | 19 + .../variables/OCR_LITHUANIAN.md | 19 + .../06-api-reference/variables/OCR_MALAY.md | 19 + .../06-api-reference/variables/OCR_MALTESE.md | 19 + .../06-api-reference/variables/OCR_MAORI.md | 19 + .../variables/OCR_MONGOLIAN.md | 19 + .../variables/OCR_NORWEGIAN.md | 19 + .../06-api-reference/variables/OCR_OCCITAN.md | 19 + .../06-api-reference/variables/OCR_PALI.md | 19 + .../06-api-reference/variables/OCR_POLISH.md | 19 + .../variables/OCR_PORTUGUESE.md | 19 + .../variables/OCR_ROMANIAN.md | 19 + .../06-api-reference/variables/OCR_RUSSIAN.md | 19 + .../variables/OCR_SERBIAN_CYRILLIC.md | 19 + .../variables/OCR_SERBIAN_LATIN.md | 19 + .../variables/OCR_SIMPLIFIED_CHINESE.md | 19 + .../06-api-reference/variables/OCR_SLOVAK.md | 19 + .../variables/OCR_SLOVENIAN.md | 19 + .../06-api-reference/variables/OCR_SPANISH.md | 19 + .../06-api-reference/variables/OCR_SWAHILI.md | 19 + .../06-api-reference/variables/OCR_SWEDISH.md | 19 + .../variables/OCR_TABASSARAN.md | 19 + .../06-api-reference/variables/OCR_TAGALOG.md | 19 + .../06-api-reference/variables/OCR_TAJIK.md | 19 + .../06-api-reference/variables/OCR_TELUGU.md | 19 + .../06-api-reference/variables/OCR_TURKISH.md | 19 + .../variables/OCR_UKRAINIAN.md | 19 + .../06-api-reference/variables/OCR_UZBEK.md | 19 + .../variables/OCR_VIETNAMESE.md | 19 + .../06-api-reference/variables/OCR_WELSH.md | 19 + .../variables/PHI_4_MINI_4B.md | 19 + .../variables/PHI_4_MINI_4B_QUANTIZED.md | 19 + .../variables/QWEN2_5_0_5B.md | 19 + .../variables/QWEN2_5_0_5B_QUANTIZED.md | 19 + .../variables/QWEN2_5_1_5B.md | 19 + .../variables/QWEN2_5_1_5B_QUANTIZED.md | 19 + .../06-api-reference/variables/QWEN2_5_3B.md | 19 + .../variables/QWEN2_5_3B_QUANTIZED.md | 19 + .../06-api-reference/variables/QWEN3_0_6B.md | 19 + .../variables/QWEN3_0_6B_QUANTIZED.md | 19 + .../06-api-reference/variables/QWEN3_1_7B.md | 19 + .../variables/QWEN3_1_7B_QUANTIZED.md | 19 + .../06-api-reference/variables/QWEN3_4B.md | 19 + .../variables/QWEN3_4B_QUANTIZED.md | 19 + .../variables/SMOLLM2_1_135M.md | 19 + .../variables/SMOLLM2_1_135M_QUANTIZED.md | 19 + .../variables/SMOLLM2_1_1_7B.md | 19 + .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 19 + .../variables/SMOLLM2_1_360M.md | 19 + .../variables/SMOLLM2_1_360M_QUANTIZED.md | 19 + .../variables/SPECIAL_TOKENS.md | 35 ++ .../SSDLITE_320_MOBILENET_V3_LARGE.md | 11 + .../variables/STYLE_TRANSFER_CANDY.md | 11 + .../variables/STYLE_TRANSFER_MOSAIC.md | 11 + .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 11 + .../variables/STYLE_TRANSFER_UDNIE.md | 11 + .../variables/VERTICAL_OCR_ABAZA.md | 19 + .../variables/VERTICAL_OCR_ADYGHE.md | 19 + .../variables/VERTICAL_OCR_AFRIKAANS.md | 19 + .../variables/VERTICAL_OCR_ALBANIAN.md | 19 + .../variables/VERTICAL_OCR_AVAR.md | 19 + .../variables/VERTICAL_OCR_AZERBAIJANI.md | 19 + .../variables/VERTICAL_OCR_BELARUSIAN.md | 19 + .../variables/VERTICAL_OCR_BOSNIAN.md | 19 + .../variables/VERTICAL_OCR_BULGARIAN.md | 19 + .../variables/VERTICAL_OCR_CHECHEN.md | 19 + .../variables/VERTICAL_OCR_CROATIAN.md | 19 + .../variables/VERTICAL_OCR_CZECH.md | 19 + .../variables/VERTICAL_OCR_DANISH.md | 19 + .../variables/VERTICAL_OCR_DARGWA.md | 19 + .../variables/VERTICAL_OCR_DUTCH.md | 19 + .../variables/VERTICAL_OCR_ENGLISH.md | 19 + .../variables/VERTICAL_OCR_ESTONIAN.md | 19 + .../variables/VERTICAL_OCR_FRENCH.md | 19 + .../variables/VERTICAL_OCR_GERMAN.md | 19 + .../variables/VERTICAL_OCR_HUNGARIAN.md | 19 + .../variables/VERTICAL_OCR_ICELANDIC.md | 19 + .../variables/VERTICAL_OCR_INDONESIAN.md | 19 + .../variables/VERTICAL_OCR_INGUSH.md | 19 + .../variables/VERTICAL_OCR_IRISH.md | 19 + .../variables/VERTICAL_OCR_ITALIAN.md | 19 + .../variables/VERTICAL_OCR_JAPANESE.md | 19 + .../variables/VERTICAL_OCR_KANNADA.md | 19 + .../variables/VERTICAL_OCR_KARBADIAN.md | 19 + .../variables/VERTICAL_OCR_KOREAN.md | 19 + .../variables/VERTICAL_OCR_KURDISH.md | 19 + .../variables/VERTICAL_OCR_LAK.md | 19 + .../variables/VERTICAL_OCR_LATIN.md | 19 + .../variables/VERTICAL_OCR_LATVIAN.md | 19 + .../variables/VERTICAL_OCR_LEZGHIAN.md | 19 + .../variables/VERTICAL_OCR_LITHUANIAN.md | 19 + .../variables/VERTICAL_OCR_MALAY.md | 19 + .../variables/VERTICAL_OCR_MALTESE.md | 19 + .../variables/VERTICAL_OCR_MAORI.md | 19 + .../variables/VERTICAL_OCR_MONGOLIAN.md | 19 + .../variables/VERTICAL_OCR_NORWEGIAN.md | 19 + .../variables/VERTICAL_OCR_OCCITAN.md | 19 + .../variables/VERTICAL_OCR_PALI.md | 19 + .../variables/VERTICAL_OCR_POLISH.md | 19 + .../variables/VERTICAL_OCR_PORTUGUESE.md | 19 + .../variables/VERTICAL_OCR_ROMANIAN.md | 19 + .../variables/VERTICAL_OCR_RUSSIAN.md | 19 + .../VERTICAL_OCR_SERBIAN_CYRILLIC.md | 19 + .../variables/VERTICAL_OCR_SERBIAN_LATIN.md | 19 + .../VERTICAL_OCR_SIMPLIFIED_CHINESE.md | 19 + .../variables/VERTICAL_OCR_SLOVAK.md | 19 + .../variables/VERTICAL_OCR_SLOVENIAN.md | 19 + .../variables/VERTICAL_OCR_SPANISH.md | 19 + .../variables/VERTICAL_OCR_SWAHILI.md | 19 + .../variables/VERTICAL_OCR_SWEDISH.md | 19 + .../variables/VERTICAL_OCR_TABASSARAN.md | 19 + .../variables/VERTICAL_OCR_TAGALOG.md | 19 + .../variables/VERTICAL_OCR_TAJIK.md | 19 + .../variables/VERTICAL_OCR_TELUGU.md | 19 + .../variables/VERTICAL_OCR_TURKISH.md | 19 + .../variables/VERTICAL_OCR_UKRAINIAN.md | 19 + .../variables/VERTICAL_OCR_UZBEK.md | 19 + .../variables/VERTICAL_OCR_VIETNAMESE.md | 19 + .../variables/VERTICAL_OCR_WELSH.md | 19 + .../variables/WHISPER_BASE.md | 23 ++ .../variables/WHISPER_BASE_EN.md | 23 ++ .../variables/WHISPER_SMALL.md | 23 ++ .../variables/WHISPER_SMALL_EN.md | 23 ++ .../variables/WHISPER_TINY.md | 23 ++ .../variables/WHISPER_TINY_EN.md | 23 ++ .../variables/WHISPER_TINY_EN_QUANTIZED.md | 23 ++ .../variables/parseToolCall.md | 15 + docs/docusaurus.config.js | 2 +- docs/sidebars.js | 41 +- .../react-native-executorch/tsconfig.doc.json | 9 + 259 files changed, 8415 insertions(+), 12 deletions(-) rename docs/docs/{04-typescript-api => 05-utilities}/04-error-handling.md (100%) create mode 100644 docs/docs/06-api-reference/classes/ClassificationModule.md create mode 100644 docs/docs/06-api-reference/classes/ExecutorchModule.md create mode 100644 docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md create mode 100644 docs/docs/06-api-reference/classes/ImageSegmentationModule.md create mode 100644 docs/docs/06-api-reference/classes/LLMModule.md create mode 100644 docs/docs/06-api-reference/classes/OCRModule.md create mode 100644 docs/docs/06-api-reference/classes/ObjectDetectionModule.md create mode 100644 docs/docs/06-api-reference/classes/ResourceFetcher.md create mode 100644 docs/docs/06-api-reference/classes/RnExecutorchError.md create mode 100644 docs/docs/06-api-reference/classes/SpeechToTextModule.md create mode 100644 docs/docs/06-api-reference/classes/StyleTransferModule.md create mode 100644 docs/docs/06-api-reference/classes/TextEmbeddingsModule.md create mode 100644 docs/docs/06-api-reference/classes/TextToImageModule.md create mode 100644 docs/docs/06-api-reference/classes/TokenizerModule.md create mode 100644 docs/docs/06-api-reference/classes/VADModule.md create mode 100644 docs/docs/06-api-reference/classes/VerticalOCRModule.md create mode 100644 docs/docs/06-api-reference/enumerations/DeeplabLabel.md create mode 100644 docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md create mode 100644 docs/docs/06-api-reference/enumerations/ScalarType.md create mode 100644 docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md create mode 100644 docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md create mode 100644 docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md create mode 100644 docs/docs/06-api-reference/functions/useClassification.md create mode 100644 docs/docs/06-api-reference/functions/useExecutorchModule.md create mode 100644 docs/docs/06-api-reference/functions/useImageEmbeddings.md create mode 100644 docs/docs/06-api-reference/functions/useImageSegmentation.md create mode 100644 docs/docs/06-api-reference/functions/useLLM.md create mode 100644 docs/docs/06-api-reference/functions/useOCR.md create mode 100644 docs/docs/06-api-reference/functions/useObjectDetection.md create mode 100644 docs/docs/06-api-reference/functions/useSpeechToText.md create mode 100644 docs/docs/06-api-reference/functions/useStyleTransfer.md create mode 100644 docs/docs/06-api-reference/functions/useTextEmbeddings.md create mode 100644 docs/docs/06-api-reference/functions/useTextToImage.md create mode 100644 docs/docs/06-api-reference/functions/useTextToSpeech.md create mode 100644 docs/docs/06-api-reference/functions/useTokenizer.md create mode 100644 docs/docs/06-api-reference/functions/useVAD.md create mode 100644 docs/docs/06-api-reference/functions/useVerticalOCR.md create mode 100644 docs/docs/06-api-reference/index.md create mode 100644 docs/docs/06-api-reference/interfaces/Bbox.md create mode 100644 docs/docs/06-api-reference/interfaces/ChatConfig.md create mode 100644 docs/docs/06-api-reference/interfaces/DecodingOptions.md create mode 100644 docs/docs/06-api-reference/interfaces/Detection.md create mode 100644 docs/docs/06-api-reference/interfaces/GenerationConfig.md create mode 100644 docs/docs/06-api-reference/interfaces/LLMType.md create mode 100644 docs/docs/06-api-reference/interfaces/Message.md create mode 100644 docs/docs/06-api-reference/interfaces/OCRBbox.md create mode 100644 docs/docs/06-api-reference/interfaces/OCRDetection.md create mode 100644 docs/docs/06-api-reference/interfaces/Segment.md create mode 100644 docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md create mode 100644 docs/docs/06-api-reference/interfaces/TensorPtr.md create mode 100644 docs/docs/06-api-reference/interfaces/ToolCall.md create mode 100644 docs/docs/06-api-reference/interfaces/ToolsConfig.md create mode 100644 docs/docs/06-api-reference/type-aliases/LLMTool.md create mode 100644 docs/docs/06-api-reference/type-aliases/MessageRole.md create mode 100644 docs/docs/06-api-reference/type-aliases/OCRLanguage.md create mode 100644 docs/docs/06-api-reference/type-aliases/ResourceSource.md create mode 100644 docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md create mode 100644 docs/docs/06-api-reference/type-aliases/TensorBuffer.md create mode 100644 docs/docs/06-api-reference/typedoc-sidebar.cjs create mode 100644 docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md create mode 100644 docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md create mode 100644 docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md create mode 100644 docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md create mode 100644 docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md create mode 100644 docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md create mode 100644 docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md create mode 100644 docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md create mode 100644 docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md create mode 100644 docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md create mode 100644 docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md create mode 100644 docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md create mode 100644 docs/docs/06-api-reference/variables/FSMN_VAD.md create mode 100644 docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md create mode 100644 docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md create mode 100644 docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/HAMMER2_1_3B.md create mode 100644 docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_EN.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md create mode 100644 docs/docs/06-api-reference/variables/LLAMA3_2_1B.md create mode 100644 docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md create mode 100644 docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md create mode 100644 docs/docs/06-api-reference/variables/LLAMA3_2_3B.md create mode 100644 docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md create mode 100644 docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md create mode 100644 docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md create mode 100644 docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md create mode 100644 docs/docs/06-api-reference/variables/OCR_ABAZA.md create mode 100644 docs/docs/06-api-reference/variables/OCR_ADYGHE.md create mode 100644 docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md create mode 100644 docs/docs/06-api-reference/variables/OCR_ALBANIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_AVAR.md create mode 100644 docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md create mode 100644 docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_BOSNIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_BULGARIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_CHECHEN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_CROATIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_CZECH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_DANISH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_DARGWA.md create mode 100644 docs/docs/06-api-reference/variables/OCR_DUTCH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_ENGLISH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_ESTONIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_FRENCH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_GERMAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_ICELANDIC.md create mode 100644 docs/docs/06-api-reference/variables/OCR_INDONESIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_INGUSH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_IRISH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_ITALIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_JAPANESE.md create mode 100644 docs/docs/06-api-reference/variables/OCR_KANNADA.md create mode 100644 docs/docs/06-api-reference/variables/OCR_KARBADIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_KOREAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_KURDISH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_LAK.md create mode 100644 docs/docs/06-api-reference/variables/OCR_LATIN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_LATVIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_MALAY.md create mode 100644 docs/docs/06-api-reference/variables/OCR_MALTESE.md create mode 100644 docs/docs/06-api-reference/variables/OCR_MAORI.md create mode 100644 docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_OCCITAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_PALI.md create mode 100644 docs/docs/06-api-reference/variables/OCR_POLISH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md create mode 100644 docs/docs/06-api-reference/variables/OCR_ROMANIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_RUSSIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md create mode 100644 docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md create mode 100644 docs/docs/06-api-reference/variables/OCR_SLOVAK.md create mode 100644 docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_SPANISH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_SWAHILI.md create mode 100644 docs/docs/06-api-reference/variables/OCR_SWEDISH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_TABASSARAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_TAGALOG.md create mode 100644 docs/docs/06-api-reference/variables/OCR_TAJIK.md create mode 100644 docs/docs/06-api-reference/variables/OCR_TELUGU.md create mode 100644 docs/docs/06-api-reference/variables/OCR_TURKISH.md create mode 100644 docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md create mode 100644 docs/docs/06-api-reference/variables/OCR_UZBEK.md create mode 100644 docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md create mode 100644 docs/docs/06-api-reference/variables/OCR_WELSH.md create mode 100644 docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md create mode 100644 docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md create mode 100644 docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md create mode 100644 docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/QWEN2_5_3B.md create mode 100644 docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/QWEN3_0_6B.md create mode 100644 docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/QWEN3_1_7B.md create mode 100644 docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/QWEN3_4B.md create mode 100644 docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md create mode 100644 docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md create mode 100644 docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md create mode 100644 docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md create mode 100644 docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md create mode 100644 docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md create mode 100644 docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md create mode 100644 docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md create mode 100644 docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md create mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md create mode 100644 docs/docs/06-api-reference/variables/WHISPER_BASE.md create mode 100644 docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md create mode 100644 docs/docs/06-api-reference/variables/WHISPER_SMALL.md create mode 100644 docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md create mode 100644 docs/docs/06-api-reference/variables/WHISPER_TINY.md create mode 100644 docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md create mode 100644 docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md create mode 100644 docs/docs/06-api-reference/variables/parseToolCall.md create mode 100644 packages/react-native-executorch/tsconfig.doc.json diff --git a/docs/docs/04-typescript-api/04-error-handling.md b/docs/docs/05-utilities/04-error-handling.md similarity index 100% rename from docs/docs/04-typescript-api/04-error-handling.md rename to docs/docs/05-utilities/04-error-handling.md diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md new file mode 100644 index 000000000..9685d2676 --- /dev/null +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -0,0 +1,143 @@ +# Class: ClassificationModule + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) + +## Extends + +- `BaseModule` + +## Constructors + +### Constructor + +> **new ClassificationModule**(): `ClassificationModule` + +#### Returns + +`ClassificationModule` + +#### Inherited from + +`BaseModule.constructor` + +## Properties + +### nativeModule + +> **nativeModule**: `any` = `null` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) + +#### Inherited from + +`BaseModule.nativeModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) + +#### Returns + +`void` + +#### Inherited from + +`BaseModule.delete` + +--- + +### forward() + +> **forward**(`imageSource`): `Promise`\<`any`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) + +#### Parameters + +##### imageSource + +`string` + +#### Returns + +`Promise`\<`any`\> + +--- + +### forwardET() + +> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) + +#### Parameters + +##### inputTensor + +[`TensorPtr`](../interfaces/TensorPtr.md)[] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +#### Inherited from + +`BaseModule.forwardET` + +--- + +### getInputShape() + +> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) + +#### Parameters + +##### methodName + +`string` + +##### index + +`number` + +#### Returns + +`Promise`\<`number`[]\> + +#### Inherited from + +`BaseModule.getInputShape` + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) + +#### Parameters + +##### model + +###### modelSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md new file mode 100644 index 000000000..40d068b4d --- /dev/null +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -0,0 +1,141 @@ +# Class: ExecutorchModule + +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) + +## Extends + +- `BaseModule` + +## Constructors + +### Constructor + +> **new ExecutorchModule**(): `ExecutorchModule` + +#### Returns + +`ExecutorchModule` + +#### Inherited from + +`BaseModule.constructor` + +## Properties + +### nativeModule + +> **nativeModule**: `any` = `null` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) + +#### Inherited from + +`BaseModule.nativeModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) + +#### Returns + +`void` + +#### Inherited from + +`BaseModule.delete` + +--- + +### forward() + +> **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L26) + +#### Parameters + +##### inputTensor + +[`TensorPtr`](../interfaces/TensorPtr.md)[] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +--- + +### forwardET() + +> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) + +#### Parameters + +##### inputTensor + +[`TensorPtr`](../interfaces/TensorPtr.md)[] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +#### Inherited from + +`BaseModule.forwardET` + +--- + +### getInputShape() + +> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) + +#### Parameters + +##### methodName + +`string` + +##### index + +`number` + +#### Returns + +`Promise`\<`number`[]\> + +#### Inherited from + +`BaseModule.getInputShape` + +--- + +### load() + +> **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L9) + +#### Parameters + +##### modelSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### 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 new file mode 100644 index 000000000..b25edabfd --- /dev/null +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -0,0 +1,143 @@ +# Class: ImageEmbeddingsModule + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) + +## Extends + +- `BaseModule` + +## Constructors + +### Constructor + +> **new ImageEmbeddingsModule**(): `ImageEmbeddingsModule` + +#### Returns + +`ImageEmbeddingsModule` + +#### Inherited from + +`BaseModule.constructor` + +## Properties + +### nativeModule + +> **nativeModule**: `any` = `null` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) + +#### Inherited from + +`BaseModule.nativeModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) + +#### Returns + +`void` + +#### Inherited from + +`BaseModule.delete` + +--- + +### forward() + +> **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) + +#### Parameters + +##### imageSource + +`string` + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +--- + +### forwardET() + +> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) + +#### Parameters + +##### inputTensor + +[`TensorPtr`](../interfaces/TensorPtr.md)[] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +#### Inherited from + +`BaseModule.forwardET` + +--- + +### getInputShape() + +> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) + +#### Parameters + +##### methodName + +`string` + +##### index + +`number` + +#### Returns + +`Promise`\<`number`[]\> + +#### Inherited from + +`BaseModule.getInputShape` + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) + +#### Parameters + +##### model + +###### modelSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md new file mode 100644 index 000000000..5008a394e --- /dev/null +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -0,0 +1,151 @@ +# Class: ImageSegmentationModule + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) + +## Extends + +- `BaseModule` + +## Constructors + +### Constructor + +> **new ImageSegmentationModule**(): `ImageSegmentationModule` + +#### Returns + +`ImageSegmentationModule` + +#### Inherited from + +`BaseModule.constructor` + +## Properties + +### nativeModule + +> **nativeModule**: `any` = `null` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) + +#### Inherited from + +`BaseModule.nativeModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) + +#### Returns + +`void` + +#### Inherited from + +`BaseModule.delete` + +--- + +### forward() + +> **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) + +#### Parameters + +##### imageSource + +`string` + +##### classesOfInterest? + +[`DeeplabLabel`](../enumerations/DeeplabLabel.md)[] + +##### resize? + +`boolean` + +#### Returns + +`Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> + +--- + +### forwardET() + +> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) + +#### Parameters + +##### inputTensor + +[`TensorPtr`](../interfaces/TensorPtr.md)[] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +#### Inherited from + +`BaseModule.forwardET` + +--- + +### getInputShape() + +> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) + +#### Parameters + +##### methodName + +`string` + +##### index + +`number` + +#### Returns + +`Promise`\<`number`[]\> + +#### Inherited from + +`BaseModule.getInputShape` + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) + +#### Parameters + +##### model + +###### modelSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md new file mode 100644 index 000000000..9faf44cd5 --- /dev/null +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -0,0 +1,223 @@ +# Class: LLMModule + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L11) + +## Constructors + +### Constructor + +> **new LLMModule**(`__namedParameters`): `LLMModule` + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) + +#### Parameters + +##### \_\_namedParameters + +###### messageHistoryCallback? + +(`messageHistory`) => `void` + +###### responseCallback? + +(`response`) => `void` + +###### tokenCallback? + +(`token`) => `void` + +#### Returns + +`LLMModule` + +## Methods + +### configure() + +> **configure**(`__namedParameters`): `void` + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L52) + +#### Parameters + +##### \_\_namedParameters + +###### chatConfig? + +`Partial`\<[`ChatConfig`](../interfaces/ChatConfig.md)\> + +###### generationConfig? + +[`GenerationConfig`](../interfaces/GenerationConfig.md) + +###### toolsConfig? + +[`ToolsConfig`](../interfaces/ToolsConfig.md) + +#### Returns + +`void` + +--- + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:92](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L92) + +#### Returns + +`void` + +--- + +### deleteMessage() + +> **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:79](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L79) + +#### Parameters + +##### index + +`number` + +#### Returns + +[`Message`](../interfaces/Message.md)[] + +--- + +### forward() + +> **forward**(`input`): `Promise`\<`string`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L64) + +#### Parameters + +##### input + +`string` + +#### Returns + +`Promise`\<`string`\> + +--- + +### generate() + +> **generate**(`messages`, `tools?`): `Promise`\<`string`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L69) + +#### Parameters + +##### messages + +[`Message`](../interfaces/Message.md)[] + +##### tools? + +`Object`[] + +#### Returns + +`Promise`\<`string`\> + +--- + +### getGeneratedTokenCount() + +> **getGeneratedTokenCount**(): `number` + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) + +#### Returns + +`number` + +--- + +### interrupt() + +> **interrupt**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:84](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L84) + +#### Returns + +`void` + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L30) + +#### Parameters + +##### model + +###### modelSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +###### tokenizerConfigSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +###### tokenizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +--- + +### sendMessage() + +> **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) + +#### Parameters + +##### message + +`string` + +#### Returns + +`Promise`\<[`Message`](../interfaces/Message.md)[]\> + +--- + +### setTokenCallback() + +> **setTokenCallback**(`__namedParameters`): `void` + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L44) + +#### Parameters + +##### \_\_namedParameters + +###### tokenCallback + +(`token`) => `void` + +#### Returns + +`void` diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md new file mode 100644 index 000000000..ab409ae99 --- /dev/null +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -0,0 +1,77 @@ +# Class: OCRModule + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) + +## Constructors + +### Constructor + +> **new OCRModule**(): `OCRModule` + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) + +#### Returns + +`OCRModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) + +#### Returns + +`void` + +--- + +### forward() + +> **forward**(`imageSource`): `Promise`\<`any`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) + +#### Parameters + +##### imageSource + +`string` + +#### Returns + +`Promise`\<`any`\> + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) + +#### Parameters + +##### model + +###### detectorSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +###### language + +`"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +###### recognizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md new file mode 100644 index 000000000..638298c36 --- /dev/null +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -0,0 +1,147 @@ +# Class: ObjectDetectionModule + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) + +## Extends + +- `BaseModule` + +## Constructors + +### Constructor + +> **new ObjectDetectionModule**(): `ObjectDetectionModule` + +#### Returns + +`ObjectDetectionModule` + +#### Inherited from + +`BaseModule.constructor` + +## Properties + +### nativeModule + +> **nativeModule**: `any` = `null` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) + +#### Inherited from + +`BaseModule.nativeModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) + +#### Returns + +`void` + +#### Inherited from + +`BaseModule.delete` + +--- + +### forward() + +> **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) + +#### Parameters + +##### imageSource + +`string` + +##### detectionThreshold + +`number` = `0.7` + +#### Returns + +`Promise`\<[`Detection`](../interfaces/Detection.md)[]\> + +--- + +### forwardET() + +> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) + +#### Parameters + +##### inputTensor + +[`TensorPtr`](../interfaces/TensorPtr.md)[] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +#### Inherited from + +`BaseModule.forwardET` + +--- + +### getInputShape() + +> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) + +#### Parameters + +##### methodName + +`string` + +##### index + +`number` + +#### Returns + +`Promise`\<`number`[]\> + +#### Inherited from + +`BaseModule.getInputShape` + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) + +#### Parameters + +##### model + +###### modelSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md new file mode 100644 index 000000000..5373127c9 --- /dev/null +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -0,0 +1,157 @@ +# Class: ResourceFetcher + +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) + +## Constructors + +### Constructor + +> **new ResourceFetcher**(): `ResourceFetcher` + +#### Returns + +`ResourceFetcher` + +## Properties + +### downloads + +> `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\> + +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) + +## Methods + +### cancelFetching() + +> `static` **cancelFetching**(...`sources`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) + +#### Parameters + +##### sources + +...[`ResourceSource`](../type-aliases/ResourceSource.md)[] + +#### Returns + +`Promise`\<`void`\> + +--- + +### deleteResources() + +> `static` **deleteResources**(...`sources`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) + +#### Parameters + +##### sources + +...[`ResourceSource`](../type-aliases/ResourceSource.md)[] + +#### Returns + +`Promise`\<`void`\> + +--- + +### fetch() + +> `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> + +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) + +#### Parameters + +##### callback + +(`downloadProgress`) => `void` + +##### sources + +...[`ResourceSource`](../type-aliases/ResourceSource.md)[] + +#### Returns + +`Promise`\<`string`[] \| `null`\> + +--- + +### getFilesTotalSize() + +> `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\> + +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) + +#### Parameters + +##### sources + +...[`ResourceSource`](../type-aliases/ResourceSource.md)[] + +#### Returns + +`Promise`\<`number`\> + +--- + +### listDownloadedFiles() + +> `static` **listDownloadedFiles**(): `Promise`\<`string`[]\> + +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) + +#### Returns + +`Promise`\<`string`[]\> + +--- + +### listDownloadedModels() + +> `static` **listDownloadedModels**(): `Promise`\<`string`[]\> + +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) + +#### Returns + +`Promise`\<`string`[]\> + +--- + +### pauseFetching() + +> `static` **pauseFetching**(...`sources`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) + +#### Parameters + +##### sources + +...[`ResourceSource`](../type-aliases/ResourceSource.md)[] + +#### Returns + +`Promise`\<`void`\> + +--- + +### resumeFetching() + +> `static` **resumeFetching**(...`sources`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) + +#### Parameters + +##### sources + +...[`ResourceSource`](../type-aliases/ResourceSource.md)[] + +#### Returns + +`Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md new file mode 100644 index 000000000..fdfc74a32 --- /dev/null +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -0,0 +1,239 @@ +# Class: RnExecutorchError + +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/errorUtils.ts#L3) + +## Extends + +- `Error` + +## Constructors + +### Constructor + +> **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` + +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/errorUtils.ts#L7) + +#### Parameters + +##### code + +`number` + +##### message + +`string` + +##### cause? + +`unknown` + +#### Returns + +`RnExecutorchError` + +#### Overrides + +`Error.constructor` + +## Properties + +### cause? + +> `optional` **cause**: `unknown` + +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/errorUtils.ts#L5) + +#### Overrides + +`Error.cause` + +--- + +### code + +> **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) + +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/errorUtils.ts#L4) + +--- + +### message + +> **message**: `string` + +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077 + +#### Inherited from + +`Error.message` + +--- + +### name + +> **name**: `string` + +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 + +#### Inherited from + +`Error.name` + +--- + +### stack? + +> `optional` **stack**: `string` + +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078 + +#### Inherited from + +`Error.stack` + +--- + +### stackTraceLimit + +> `static` **stackTraceLimit**: `number` + +Defined in: node_modules/@types/node/globals.d.ts:68 + +The `Error.stackTraceLimit` property specifies the number of stack frames +collected by a stack trace (whether generated by `new Error().stack` or +`Error.captureStackTrace(obj)`). + +The default value is `10` but may be set to any valid JavaScript number. Changes +will affect any stack trace captured _after_ the value has been changed. + +If set to a non-number value, or set to a negative number, stack traces will +not capture any frames. + +#### Inherited from + +`Error.stackTraceLimit` + +## Methods + +### captureStackTrace() + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Defined in: node_modules/@types/node/globals.d.ts:52 + +Creates a `.stack` property on `targetObject`, which when accessed returns +a string representing the location in the code at which +`Error.captureStackTrace()` was called. + +```js +const myObject = {}; +Error.captureStackTrace(myObject); +myObject.stack; // Similar to `new Error().stack` +``` + +The first line of the trace will be prefixed with +`${myObject.name}: ${myObject.message}`. + +The optional `constructorOpt` argument accepts a function. If given, all frames +above `constructorOpt`, including `constructorOpt`, will be omitted from the +generated stack trace. + +The `constructorOpt` argument is useful for hiding implementation +details of error generation from the user. For instance: + +```js +function a() { + b(); +} + +function b() { + c(); +} + +function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; +} + +a(); +``` + +#### Parameters + +##### targetObject + +`object` + +##### constructorOpt? + +`Function` + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +--- + +### isError() + +> `static` **isError**(`error`): `error is Error` + +Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23 + +Indicates whether the argument provided is a built-in Error instance or not. + +#### Parameters + +##### error + +`unknown` + +#### Returns + +`error is Error` + +#### Inherited from + +`Error.isError` + +--- + +### prepareStackTrace() + +> `static` **prepareStackTrace**(`err`, `stackTraces`): `any` + +Defined in: node_modules/@types/node/globals.d.ts:56 + +#### Parameters + +##### err + +`Error` + +##### stackTraces + +`CallSite`[] + +#### Returns + +`any` + +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +`Error.prepareStackTrace` diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md new file mode 100644 index 000000000..db2b5bffc --- /dev/null +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -0,0 +1,163 @@ +# Class: SpeechToTextModule + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L7) + +## Constructors + +### Constructor + +> **new SpeechToTextModule**(): `SpeechToTextModule` + +#### Returns + +`SpeechToTextModule` + +## Methods + +### decode() + +> **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:67](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L67) + +#### Parameters + +##### tokens + +`number`[] | `Int32Array`\<`ArrayBufferLike`\> + +##### encoderOutput + +`number`[] | `Float32Array`\<`ArrayBufferLike`\> + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +--- + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L51) + +#### Returns + +`void` + +--- + +### encode() + +> **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L55) + +#### Parameters + +##### waveform + +`number`[] | `Float32Array`\<`ArrayBufferLike`\> + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L17) + +#### Parameters + +##### model + +[`SpeechToTextModelConfig`](../interfaces/SpeechToTextModelConfig.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +--- + +### stream() + +> **stream**(`options`): `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:113](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L113) + +#### Parameters + +##### options + +[`DecodingOptions`](../interfaces/DecodingOptions.md) = `{}` + +#### Returns + +`AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> + +--- + +### streamInsert() + +> **streamInsert**(`waveform`): `void` + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:168](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L168) + +#### Parameters + +##### waveform + +`number`[] | `Float32Array`\<`ArrayBufferLike`\> + +#### Returns + +`void` + +--- + +### streamStop() + +> **streamStop**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:178](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L178) + +#### Returns + +`void` + +--- + +### transcribe() + +> **transcribe**(`waveform`, `options`): `Promise`\<`string`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:94](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L94) + +Transcribes audio using the Whisper model. + +#### Parameters + +##### waveform + +The Float32Array audio data. + +`number`[] | `Float32Array`\<`ArrayBufferLike`\> + +##### options + +[`DecodingOptions`](../interfaces/DecodingOptions.md) = `{}` + +#### Returns + +`Promise`\<`string`\> + +The transcription string. diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md new file mode 100644 index 000000000..2144dd68b --- /dev/null +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -0,0 +1,143 @@ +# Class: StyleTransferModule + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) + +## Extends + +- `BaseModule` + +## Constructors + +### Constructor + +> **new StyleTransferModule**(): `StyleTransferModule` + +#### Returns + +`StyleTransferModule` + +#### Inherited from + +`BaseModule.constructor` + +## Properties + +### nativeModule + +> **nativeModule**: `any` = `null` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) + +#### Inherited from + +`BaseModule.nativeModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) + +#### Returns + +`void` + +#### Inherited from + +`BaseModule.delete` + +--- + +### forward() + +> **forward**(`imageSource`): `Promise`\<`string`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) + +#### Parameters + +##### imageSource + +`string` + +#### Returns + +`Promise`\<`string`\> + +--- + +### forwardET() + +> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) + +#### Parameters + +##### inputTensor + +[`TensorPtr`](../interfaces/TensorPtr.md)[] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +#### Inherited from + +`BaseModule.forwardET` + +--- + +### getInputShape() + +> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) + +#### Parameters + +##### methodName + +`string` + +##### index + +`number` + +#### Returns + +`Promise`\<`number`[]\> + +#### Inherited from + +`BaseModule.getInputShape` + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) + +#### Parameters + +##### model + +###### modelSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md new file mode 100644 index 000000000..71cbb8f5e --- /dev/null +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -0,0 +1,147 @@ +# Class: TextEmbeddingsModule + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L7) + +## Extends + +- `BaseModule` + +## Constructors + +### Constructor + +> **new TextEmbeddingsModule**(): `TextEmbeddingsModule` + +#### Returns + +`TextEmbeddingsModule` + +#### Inherited from + +`BaseModule.constructor` + +## Properties + +### nativeModule + +> **nativeModule**: `any` = `null` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) + +#### Inherited from + +`BaseModule.nativeModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) + +#### Returns + +`void` + +#### Inherited from + +`BaseModule.delete` + +--- + +### forward() + +> **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L35) + +#### Parameters + +##### input + +`string` + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +--- + +### forwardET() + +> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) + +#### Parameters + +##### inputTensor + +[`TensorPtr`](../interfaces/TensorPtr.md)[] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +#### Inherited from + +`BaseModule.forwardET` + +--- + +### getInputShape() + +> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) + +#### Parameters + +##### methodName + +`string` + +##### index + +`number` + +#### Returns + +`Promise`\<`number`[]\> + +#### Inherited from + +`BaseModule.getInputShape` + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L8) + +#### Parameters + +##### model + +###### modelSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +###### tokenizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md new file mode 100644 index 000000000..046f911d5 --- /dev/null +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -0,0 +1,191 @@ +# Class: TextToImageModule + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) + +## Extends + +- `BaseModule` + +## Constructors + +### Constructor + +> **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) + +#### Parameters + +##### inferenceCallback? + +(`stepIdx`) => `void` + +#### Returns + +`TextToImageModule` + +#### Overrides + +`BaseModule.constructor` + +## Properties + +### nativeModule + +> **nativeModule**: `any` = `null` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) + +#### Inherited from + +`BaseModule.nativeModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) + +#### Returns + +`void` + +#### Inherited from + +`BaseModule.delete` + +--- + +### forward() + +> **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) + +#### Parameters + +##### input + +`string` + +##### imageSize + +`number` = `512` + +##### numSteps + +`number` = `5` + +##### seed? + +`number` + +#### Returns + +`Promise`\<`string`\> + +--- + +### forwardET() + +> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) + +#### Parameters + +##### inputTensor + +[`TensorPtr`](../interfaces/TensorPtr.md)[] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +#### Inherited from + +`BaseModule.forwardET` + +--- + +### getInputShape() + +> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) + +#### Parameters + +##### methodName + +`string` + +##### index + +`number` + +#### Returns + +`Promise`\<`number`[]\> + +#### Inherited from + +`BaseModule.getInputShape` + +--- + +### interrupt() + +> **interrupt**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) + +#### Returns + +`void` + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) + +#### Parameters + +##### model + +###### decoderSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +###### encoderSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +###### schedulerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +###### tokenizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +###### unetSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md new file mode 100644 index 000000000..077747345 --- /dev/null +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -0,0 +1,133 @@ +# Class: TokenizerModule + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) + +## Constructors + +### Constructor + +> **new TokenizerModule**(): `TokenizerModule` + +#### Returns + +`TokenizerModule` + +## Properties + +### nativeModule + +> **nativeModule**: `any` + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L7) + +## Methods + +### decode() + +> **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`any`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L31) + +#### Parameters + +##### tokens + +`number`[] + +##### skipSpecialTokens + +`boolean` = `true` + +#### Returns + +`Promise`\<`any`\> + +--- + +### encode() + +> **encode**(`s`): `Promise`\<`any`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L27) + +#### Parameters + +##### s + +`string` + +#### Returns + +`Promise`\<`any`\> + +--- + +### getVocabSize() + +> **getVocabSize**(): `Promise`\<`number`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L38) + +#### Returns + +`Promise`\<`number`\> + +--- + +### idToToken() + +> **idToToken**(`tokenId`): `Promise`\<`string`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L42) + +#### Parameters + +##### tokenId + +`number` + +#### Returns + +`Promise`\<`string`\> + +--- + +### load() + +> **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L9) + +#### Parameters + +##### tokenizer + +###### tokenizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +--- + +### tokenToId() + +> **tokenToId**(`token`): `Promise`\<`number`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L46) + +#### Parameters + +##### token + +`string` + +#### Returns + +`Promise`\<`number`\> diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md new file mode 100644 index 000000000..7082b0829 --- /dev/null +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -0,0 +1,143 @@ +# Class: VADModule + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) + +## Extends + +- `BaseModule` + +## Constructors + +### Constructor + +> **new VADModule**(): `VADModule` + +#### Returns + +`VADModule` + +#### Inherited from + +`BaseModule.constructor` + +## Properties + +### nativeModule + +> **nativeModule**: `any` = `null` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) + +#### Inherited from + +`BaseModule.nativeModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) + +#### Returns + +`void` + +#### Inherited from + +`BaseModule.delete` + +--- + +### forward() + +> **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L26) + +#### Parameters + +##### waveform + +`Float32Array` + +#### Returns + +`Promise`\<[`Segment`](../interfaces/Segment.md)[]\> + +--- + +### forwardET() + +> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) + +#### Parameters + +##### inputTensor + +[`TensorPtr`](../interfaces/TensorPtr.md)[] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +#### Inherited from + +`BaseModule.forwardET` + +--- + +### getInputShape() + +> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> + +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) + +#### Parameters + +##### methodName + +`string` + +##### index + +`number` + +#### Returns + +`Promise`\<`number`[]\> + +#### Inherited from + +`BaseModule.getInputShape` + +--- + +### load() + +> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L9) + +#### Parameters + +##### model + +###### modelSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`BaseModule.load` diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md new file mode 100644 index 000000000..9672d8410 --- /dev/null +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -0,0 +1,81 @@ +# Class: VerticalOCRModule + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) + +## Constructors + +### Constructor + +> **new VerticalOCRModule**(): `VerticalOCRModule` + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) + +#### Returns + +`VerticalOCRModule` + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) + +#### Returns + +`void` + +--- + +### forward() + +> **forward**(`imageSource`): `Promise`\<`any`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) + +#### Parameters + +##### imageSource + +`string` + +#### Returns + +`Promise`\<`any`\> + +--- + +### load() + +> **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) + +#### Parameters + +##### model + +###### detectorSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +###### language + +`"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +###### recognizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +##### independentCharacters + +`boolean` + +##### onDownloadProgressCallback + +(`progress`) => `void` + +#### Returns + +`Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md new file mode 100644 index 000000000..5db27ec99 --- /dev/null +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -0,0 +1,179 @@ +# Enumeration: DeeplabLabel + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L2) + +## Enumeration Members + +### AEROPLANE + +> **AEROPLANE**: `1` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L4) + +--- + +### ARGMAX + +> **ARGMAX**: `21` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) + +--- + +### BACKGROUND + +> **BACKGROUND**: `0` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L3) + +--- + +### BICYCLE + +> **BICYCLE**: `2` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) + +--- + +### BIRD + +> **BIRD**: `3` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) + +--- + +### BOAT + +> **BOAT**: `4` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) + +--- + +### BOTTLE + +> **BOTTLE**: `5` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) + +--- + +### BUS + +> **BUS**: `6` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) + +--- + +### CAR + +> **CAR**: `7` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) + +--- + +### CAT + +> **CAT**: `8` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) + +--- + +### CHAIR + +> **CHAIR**: `9` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) + +--- + +### COW + +> **COW**: `10` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) + +--- + +### DININGTABLE + +> **DININGTABLE**: `11` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) + +--- + +### DOG + +> **DOG**: `12` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) + +--- + +### HORSE + +> **HORSE**: `13` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) + +--- + +### MOTORBIKE + +> **MOTORBIKE**: `14` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) + +--- + +### PERSON + +> **PERSON**: `15` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) + +--- + +### POTTEDPLANT + +> **POTTEDPLANT**: `16` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) + +--- + +### SHEEP + +> **SHEEP**: `17` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) + +--- + +### SOFA + +> **SOFA**: `18` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) + +--- + +### TRAIN + +> **TRAIN**: `19` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) + +--- + +### TVMONITOR + +> **TVMONITOR**: `20` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md new file mode 100644 index 000000000..99870edbc --- /dev/null +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -0,0 +1,387 @@ +# Enumeration: RnExecutorchErrorCode + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) + +## Enumeration Members + +### AccessFailed + +> **AccessFailed**: `34` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) + +--- + +### DelegateInvalidCompatibility + +> **DelegateInvalidCompatibility**: `48` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) + +--- + +### DelegateInvalidHandle + +> **DelegateInvalidHandle**: `50` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) + +--- + +### DelegateMemoryAllocationFailed + +> **DelegateMemoryAllocationFailed**: `49` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) + +--- + +### DownloadInterrupted + +> **DownloadInterrupted**: `118` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) + +Thrown when the number of downloaded files is unexpected, due to download interruptions. + +--- + +### EndOfMethod + +> **EndOfMethod**: `3` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) + +--- + +### FileReadFailed + +> **FileReadFailed**: `114` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) + +Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. + +--- + +### FileWriteFailed + +> **FileWriteFailed**: `103` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) + +An error ocurred when saving a file. This could be, for instance a result image from an image model. + +--- + +### Internal + +> **Internal**: `1` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) + +--- + +### InvalidArgument + +> **InvalidArgument**: `18` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) + +--- + +### InvalidConfig + +> **InvalidConfig**: `112` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) + +Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. + +--- + +### InvalidExternalData + +> **InvalidExternalData**: `36` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) + +--- + +### InvalidModelOutput + +> **InvalidModelOutput**: `115` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) + +Thrown when the size of model output is unexpected. + +--- + +### InvalidModelSource + +> **InvalidModelSource**: `255` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) + +Thrown when the type of model source passed by the user is invalid. + +--- + +### InvalidProgram + +> **InvalidProgram**: `35` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) + +--- + +### InvalidState + +> **InvalidState**: `2` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) + +--- + +### InvalidType + +> **InvalidType**: `19` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) + +--- + +### InvalidUserInput + +> **InvalidUserInput**: `117` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) + +Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). + +--- + +### LanguageNotSupported + +> **LanguageNotSupported**: `105` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) + +Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. + +--- + +### MemoryAllocationFailed + +> **MemoryAllocationFailed**: `33` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) + +--- + +### MissingDataChunk + +> **MissingDataChunk**: `161` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) + +Thrown when streaming transcription is attempted but audio data chunk is missing. + +--- + +### ModelGenerating + +> **ModelGenerating**: `104` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) + +Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. + +--- + +### ModuleNotLoaded + +> **ModuleNotLoaded**: `102` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) + +Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. + +--- + +### MultilingualConfiguration + +> **MultilingualConfiguration**: `160` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) + +Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. + +--- + +### NotFound + +> **NotFound**: `32` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) + +--- + +### NotImplemented + +> **NotImplemented**: `17` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) + +--- + +### NotSupported + +> **NotSupported**: `16` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) + +--- + +### Ok + +> **Ok**: `0` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) + +--- + +### OperatorMissing + +> **OperatorMissing**: `20` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) + +--- + +### OutOfResources + +> **OutOfResources**: `37` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) + +--- + +### ResourceFetcherAlreadyOngoing + +> **ResourceFetcherAlreadyOngoing**: `183` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) + +Thrown when trying to resume a download that is already ongoing. + +--- + +### ResourceFetcherAlreadyPaused + +> **ResourceFetcherAlreadyPaused**: `182` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) + +Thrown when trying to pause a download that is already paused. + +--- + +### ResourceFetcherDownloadFailed + +> **ResourceFetcherDownloadFailed**: `180` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) + +Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. + +--- + +### ResourceFetcherDownloadInProgress + +> **ResourceFetcherDownloadInProgress**: `181` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) + +Thrown when a user tries to trigger a download that's already in progress. + +--- + +### ResourceFetcherMissingUri + +> **ResourceFetcherMissingUri**: `185` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) + +Thrown when required URI information is missing for a download operation. + +--- + +### ResourceFetcherNotActive + +> **ResourceFetcherNotActive**: `184` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) + +Thrown when trying to pause, resume, or cancel a download that is not active. + +--- + +### StreamingInProgress + +> **StreamingInProgress**: `163` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) + +Thrown when trying to start a new streaming session while another is already in progress. + +--- + +### StreamingNotStarted + +> **StreamingNotStarted**: `162` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) + +Thrown when trying to stop or insert data into a stream that hasn't been started. + +--- + +### ThreadPoolError + +> **ThreadPoolError**: `113` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) + +Thrown when React Native ExecuTorch threadpool problem occurs. + +--- + +### UnexpectedNumInputs + +> **UnexpectedNumInputs**: `97` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) + +Thrown when the number of passed inputs to the model is different than the model metadata specifies. + +--- + +### UnknownError + +> **UnknownError**: `101` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) + +An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. + +--- + +### WrongDimensions + +> **WrongDimensions**: `116` + +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) + +Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md new file mode 100644 index 000000000..e72113aee --- /dev/null +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -0,0 +1,179 @@ +# Enumeration: ScalarType + +Defined in: [packages/react-native-executorch/src/types/common.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L3) + +## Enumeration Members + +### BITS16 + +> **BITS16**: `22` + +Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L18) + +--- + +### BOOL + +> **BOOL**: `11` + +Defined in: [packages/react-native-executorch/src/types/common.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L12) + +--- + +### BYTE + +> **BYTE**: `0` + +Defined in: [packages/react-native-executorch/src/types/common.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L4) + +--- + +### CHAR + +> **CHAR**: `1` + +Defined in: [packages/react-native-executorch/src/types/common.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L5) + +--- + +### DOUBLE + +> **DOUBLE**: `7` + +Defined in: [packages/react-native-executorch/src/types/common.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L11) + +--- + +### FLOAT + +> **FLOAT**: `6` + +Defined in: [packages/react-native-executorch/src/types/common.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L10) + +--- + +### FLOAT8E4M3FN + +> **FLOAT8E4M3FN**: `24` + +Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L20) + +--- + +### FLOAT8E4M3FNUZ + +> **FLOAT8E4M3FNUZ**: `26` + +Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L22) + +--- + +### FLOAT8E5M2 + +> **FLOAT8E5M2**: `23` + +Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L19) + +--- + +### FLOAT8E5M2FNUZ + +> **FLOAT8E5M2FNUZ**: `25` + +Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L21) + +--- + +### HALF + +> **HALF**: `5` + +Defined in: [packages/react-native-executorch/src/types/common.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L9) + +--- + +### INT + +> **INT**: `3` + +Defined in: [packages/react-native-executorch/src/types/common.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L7) + +--- + +### LONG + +> **LONG**: `4` + +Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L8) + +--- + +### QINT32 + +> **QINT32**: `14` + +Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L15) + +--- + +### QINT8 + +> **QINT8**: `12` + +Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L13) + +--- + +### QUINT2X4 + +> **QUINT2X4**: `17` + +Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L17) + +--- + +### QUINT4X2 + +> **QUINT4X2**: `16` + +Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L16) + +--- + +### QUINT8 + +> **QUINT8**: `13` + +Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L14) + +--- + +### SHORT + +> **SHORT**: `2` + +Defined in: [packages/react-native-executorch/src/types/common.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L6) + +--- + +### UINT16 + +> **UINT16**: `27` + +Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L23) + +--- + +### UINT32 + +> **UINT32**: `28` + +Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L24) + +--- + +### UINT64 + +> **UINT64**: `29` + +Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L25) diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md new file mode 100644 index 000000000..e4993a5a6 --- /dev/null +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -0,0 +1,15 @@ +# Function: DEFAULT_STRUCTURED_OUTPUT_PROMPT() + +> **DEFAULT_STRUCTURED_OUTPUT_PROMPT**(`structuredOutputSchema`): `string` + +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) + +## Parameters + +### structuredOutputSchema + +`string` + +## Returns + +`string` diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md new file mode 100644 index 000000000..1b8b22b1e --- /dev/null +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -0,0 +1,25 @@ +# Function: fixAndValidateStructuredOutput() + +> **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> + +Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/llm.ts#L81) + +## Type Parameters + +### T + +`T` _extends_ `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> + +## Parameters + +### output + +`string` + +### responseSchema + +`Schema` | `T` + +## Returns + +`output`\<`T`\> diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md new file mode 100644 index 000000000..eccaede92 --- /dev/null +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -0,0 +1,21 @@ +# Function: getStructuredOutputPrompt() + +> **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` + +Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/llm.ts#L50) + +## Type Parameters + +### T + +`T` _extends_ `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> + +## Parameters + +### responseSchema + +`T` | `Schema` + +## Returns + +`string` diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md new file mode 100644 index 000000000..8a4e9a3a5 --- /dev/null +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -0,0 +1,45 @@ +# Function: useClassification() + +> **useClassification**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L10) + +## Parameters + +### \_\_namedParameters + +`Props` + +## Returns + +`object` + +### downloadProgress + +> **downloadProgress**: `number` + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### forward() + +> **forward**: (...`input`) => `Promise`\<`any`\> + +#### Parameters + +##### input + +...\[`string`\] + +#### Returns + +`Promise`\<`any`\> + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md new file mode 100644 index 000000000..b6b5b94ba --- /dev/null +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -0,0 +1,45 @@ +# Function: useExecutorchModule() + +> **useExecutorchModule**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L10) + +## Parameters + +### \_\_namedParameters + +`Props` + +## Returns + +`object` + +### downloadProgress + +> **downloadProgress**: `number` + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### forward() + +> **forward**: (...`input`) => `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +#### Parameters + +##### input + +...\[[`TensorPtr`](../interfaces/TensorPtr.md)[]\] + +#### Returns + +`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md new file mode 100644 index 000000000..ca31ae3da --- /dev/null +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -0,0 +1,45 @@ +# Function: useImageEmbeddings() + +> **useImageEmbeddings**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L10) + +## Parameters + +### \_\_namedParameters + +`Props` + +## Returns + +`object` + +### downloadProgress + +> **downloadProgress**: `number` + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### forward() + +> **forward**: (...`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +#### Parameters + +##### input + +...\[`string`\] + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md new file mode 100644 index 000000000..3f981986c --- /dev/null +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -0,0 +1,45 @@ +# Function: useImageSegmentation() + +> **useImageSegmentation**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L10) + +## Parameters + +### \_\_namedParameters + +`Props` + +## Returns + +`object` + +### downloadProgress + +> **downloadProgress**: `number` + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### forward() + +> **forward**: (...`input`) => `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> + +#### Parameters + +##### input + +...\[`string`, [`DeeplabLabel`](../enumerations/DeeplabLabel.md)[], `boolean`\] + +#### Returns + +`Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md new file mode 100644 index 000000000..601bcd9e8 --- /dev/null +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -0,0 +1,33 @@ +# Function: useLLM() + +> **useLLM**(`__namedParameters`): [`LLMType`](../interfaces/LLMType.md) + +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L17) + +## Parameters + +### \_\_namedParameters + +#### model + +\{ `modelSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `tokenizerConfigSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `tokenizerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); \} + +#### model.modelSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### model.tokenizerConfigSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### model.tokenizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### preventLoad? + +`boolean` = `false` + +## Returns + +[`LLMType`](../interfaces/LLMType.md) diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md new file mode 100644 index 000000000..3713605fe --- /dev/null +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -0,0 +1,33 @@ +# Function: useOCR() + +> **useOCR**(`__namedParameters`): `OCRModule` + +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L15) + +## Parameters + +### \_\_namedParameters + +#### model + +\{ `detectorSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `language`: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"`; `recognizerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); \} + +#### model.detectorSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### model.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"` + +#### model.recognizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### preventLoad? + +`boolean` = `false` + +## Returns + +`OCRModule` diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md new file mode 100644 index 000000000..ed5813785 --- /dev/null +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -0,0 +1,45 @@ +# Function: useObjectDetection() + +> **useObjectDetection**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L10) + +## Parameters + +### \_\_namedParameters + +`Props` + +## Returns + +`object` + +### downloadProgress + +> **downloadProgress**: `number` + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### forward() + +> **forward**: (...`input`) => `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> + +#### Parameters + +##### input + +...\[`string`, `number`\] + +#### Returns + +`Promise`\<[`Detection`](../interfaces/Detection.md)[]\> + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md new file mode 100644 index 000000000..5406027ae --- /dev/null +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -0,0 +1,129 @@ +# Function: useSpeechToText() + +> **useSpeechToText**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L7) + +## Parameters + +### \_\_namedParameters + +#### model + +[`SpeechToTextModelConfig`](../interfaces/SpeechToTextModelConfig.md) + +#### preventLoad? + +`boolean` = `false` + +## Returns + +`object` + +### committedTranscription + +> **committedTranscription**: `string` + +### decode() + +> **decode**: (...`args`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +#### Parameters + +##### args + +...\[`number`[] \| `Int32Array`\<`ArrayBufferLike`\>, `number`[] \| `Float32Array`\<`ArrayBufferLike`\>\] + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +### downloadProgress + +> **downloadProgress**: `number` + +### encode() + +> **encode**: (...`args`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +#### Parameters + +##### args + +...\[`number`[] \| `Float32Array`\<`ArrayBufferLike`\>\] + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` + +### nonCommittedTranscription + +> **nonCommittedTranscription**: `string` + +### stream() + +> **stream**: (`options?`) => `Promise`\<`string`\> + +#### Parameters + +##### options? + +[`DecodingOptions`](../interfaces/DecodingOptions.md) + +#### Returns + +`Promise`\<`string`\> + +### streamInsert() + +> **streamInsert**: (...`args`) => `void` + +#### Parameters + +##### args + +...\[`number`[] \| `Float32Array`\<`ArrayBufferLike`\>\] + +#### Returns + +`void` + +### streamStop() + +> **streamStop**: (...`args`) => `void` + +#### Parameters + +##### args + +...\[\] + +#### Returns + +`void` + +### transcribe() + +> **transcribe**: (...`args`) => `Promise`\<`string`\> + +#### Parameters + +##### args + +...\[`number`[] \| `Float32Array`\<`ArrayBufferLike`\>, [`DecodingOptions`](../interfaces/DecodingOptions.md)\] + +#### Returns + +`Promise`\<`string`\> diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md new file mode 100644 index 000000000..6de43125c --- /dev/null +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -0,0 +1,45 @@ +# Function: useStyleTransfer() + +> **useStyleTransfer**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L10) + +## Parameters + +### \_\_namedParameters + +`Props` + +## Returns + +`object` + +### downloadProgress + +> **downloadProgress**: `number` + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### forward() + +> **forward**: (...`input`) => `Promise`\<`string`\> + +#### Parameters + +##### input + +...\[`string`\] + +#### Returns + +`Promise`\<`string`\> + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md new file mode 100644 index 000000000..78fe9ca89 --- /dev/null +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -0,0 +1,45 @@ +# Function: useTextEmbeddings() + +> **useTextEmbeddings**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L13) + +## Parameters + +### \_\_namedParameters + +`Props` + +## Returns + +`object` + +### downloadProgress + +> **downloadProgress**: `number` + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### forward() + +> **forward**: (...`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +#### Parameters + +##### input + +...\[`string`\] + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md new file mode 100644 index 000000000..b5a9c4a1d --- /dev/null +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -0,0 +1,45 @@ +# Function: useTextToImage() + +> **useTextToImage**(`__namedParameters`): `TextToImageType` + +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L21) + +## Parameters + +### \_\_namedParameters + +#### inferenceCallback? + +(`stepIdx`) => `void` + +#### model + +\{ `decoderSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `encoderSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `schedulerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `tokenizerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `unetSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); \} + +#### model.decoderSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### model.encoderSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### model.schedulerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### model.tokenizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### model.unetSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### preventLoad? + +`boolean` = `false` + +## Returns + +`TextToImageType` diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md new file mode 100644 index 000000000..4ae95ae27 --- /dev/null +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -0,0 +1,59 @@ +# Function: useTextToSpeech() + +> **useTextToSpeech**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts:15](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L15) + +## Parameters + +### \_\_namedParameters + +`Props` + +## Returns + +`object` + +### downloadProgress + +> **downloadProgress**: `number` + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### forward() + +> **forward**: (`input`) => `Promise`\<`any`\> + +#### Parameters + +##### input + +`TextToSpeechInput` + +#### Returns + +`Promise`\<`any`\> + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` + +### stream() + +> **stream**: (`input`) => `Promise`\<`void`\> + +#### Parameters + +##### input + +`TextToSpeechStreamingInput` + +#### Returns + +`Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md new file mode 100644 index 000000000..2fcb645ef --- /dev/null +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -0,0 +1,111 @@ +# Function: useTokenizer() + +> **useTokenizer**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L7) + +## Parameters + +### \_\_namedParameters + +#### preventLoad? + +`boolean` = `false` + +#### tokenizer + +\{ `tokenizerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); \} + +#### tokenizer.tokenizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +## Returns + +`object` + +### decode() + +> **decode**: (...`args`) => `Promise`\<`Promise`\<`any`\>\> + +#### Parameters + +##### args + +...\[`number`[], `boolean`\] + +#### Returns + +`Promise`\<`Promise`\<`any`\>\> + +### downloadProgress + +> **downloadProgress**: `number` + +### encode() + +> **encode**: (...`args`) => `Promise`\<`Promise`\<`any`\>\> + +#### Parameters + +##### args + +...\[`string`\] + +#### Returns + +`Promise`\<`Promise`\<`any`\>\> + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### getVocabSize() + +> **getVocabSize**: (...`args`) => `Promise`\<`Promise`\<`number`\>\> + +#### Parameters + +##### args + +...\[\] + +#### Returns + +`Promise`\<`Promise`\<`number`\>\> + +### idToToken() + +> **idToToken**: (...`args`) => `Promise`\<`Promise`\<`string`\>\> + +#### Parameters + +##### args + +...\[`number`\] + +#### Returns + +`Promise`\<`Promise`\<`string`\>\> + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` + +### tokenToId() + +> **tokenToId**: (...`args`) => `Promise`\<`Promise`\<`number`\>\> + +#### Parameters + +##### args + +...\[`string`\] + +#### Returns + +`Promise`\<`Promise`\<`number`\>\> diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md new file mode 100644 index 000000000..bf033e10c --- /dev/null +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -0,0 +1,45 @@ +# Function: useVAD() + +> **useVAD**(`__namedParameters`): `object` + +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L10) + +## Parameters + +### \_\_namedParameters + +`Props` + +## Returns + +`object` + +### downloadProgress + +> **downloadProgress**: `number` + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +### forward() + +> **forward**: (...`input`) => `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> + +#### Parameters + +##### input + +...\[`Float32Array`\<`ArrayBufferLike`\>\] + +#### Returns + +`Promise`\<[`Segment`](../interfaces/Segment.md)[]\> + +### isGenerating + +> **isGenerating**: `boolean` + +### isReady + +> **isReady**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md new file mode 100644 index 000000000..89853a7db --- /dev/null +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -0,0 +1,37 @@ +# Function: useVerticalOCR() + +> **useVerticalOCR**(`__namedParameters`): `OCRModule` + +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L15) + +## Parameters + +### \_\_namedParameters + +#### independentCharacters? + +`boolean` = `false` + +#### model + +\{ `detectorSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `language`: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"`; `recognizerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); \} + +#### model.detectorSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### model.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"` + +#### model.recognizerSource + +[`ResourceSource`](../type-aliases/ResourceSource.md) + +#### preventLoad? + +`boolean` = `false` + +## Returns + +`OCRModule` diff --git a/docs/docs/06-api-reference/index.md b/docs/docs/06-api-reference/index.md new file mode 100644 index 000000000..a0387372e --- /dev/null +++ b/docs/docs/06-api-reference/index.md @@ -0,0 +1,272 @@ +# react-native-executorch + +## Enumerations + +- [DeeplabLabel](enumerations/DeeplabLabel.md) +- [RnExecutorchErrorCode](enumerations/RnExecutorchErrorCode.md) +- [ScalarType](enumerations/ScalarType.md) + +## Classes + +- [ClassificationModule](classes/ClassificationModule.md) +- [ExecutorchModule](classes/ExecutorchModule.md) +- [ImageEmbeddingsModule](classes/ImageEmbeddingsModule.md) +- [ImageSegmentationModule](classes/ImageSegmentationModule.md) +- [LLMModule](classes/LLMModule.md) +- [ObjectDetectionModule](classes/ObjectDetectionModule.md) +- [OCRModule](classes/OCRModule.md) +- [ResourceFetcher](classes/ResourceFetcher.md) +- [RnExecutorchError](classes/RnExecutorchError.md) +- [SpeechToTextModule](classes/SpeechToTextModule.md) +- [StyleTransferModule](classes/StyleTransferModule.md) +- [TextEmbeddingsModule](classes/TextEmbeddingsModule.md) +- [TextToImageModule](classes/TextToImageModule.md) +- [TokenizerModule](classes/TokenizerModule.md) +- [VADModule](classes/VADModule.md) +- [VerticalOCRModule](classes/VerticalOCRModule.md) + +## Interfaces + +- [Bbox](interfaces/Bbox.md) +- [ChatConfig](interfaces/ChatConfig.md) +- [DecodingOptions](interfaces/DecodingOptions.md) +- [Detection](interfaces/Detection.md) +- [GenerationConfig](interfaces/GenerationConfig.md) +- [LLMType](interfaces/LLMType.md) +- [Message](interfaces/Message.md) +- [OCRBbox](interfaces/OCRBbox.md) +- [OCRDetection](interfaces/OCRDetection.md) +- [Segment](interfaces/Segment.md) +- [SpeechToTextModelConfig](interfaces/SpeechToTextModelConfig.md) +- [TensorPtr](interfaces/TensorPtr.md) +- [ToolCall](interfaces/ToolCall.md) +- [ToolsConfig](interfaces/ToolsConfig.md) + +## Type Aliases + +- [LLMTool](type-aliases/LLMTool.md) +- [MessageRole](type-aliases/MessageRole.md) +- [OCRLanguage](type-aliases/OCRLanguage.md) +- [ResourceSource](type-aliases/ResourceSource.md) +- [SpeechToTextLanguage](type-aliases/SpeechToTextLanguage.md) +- [TensorBuffer](type-aliases/TensorBuffer.md) + +## Variables + +- [ALL_MINILM_L6_V2](variables/ALL_MINILM_L6_V2.md) +- [ALL_MPNET_BASE_V2](variables/ALL_MPNET_BASE_V2.md) +- [BK_SDM_TINY_VPRED_256](variables/BK_SDM_TINY_VPRED_256.md) +- [BK_SDM_TINY_VPRED_512](variables/BK_SDM_TINY_VPRED_512.md) +- [CLIP_VIT_BASE_PATCH32_IMAGE](variables/CLIP_VIT_BASE_PATCH32_IMAGE.md) +- [CLIP_VIT_BASE_PATCH32_TEXT](variables/CLIP_VIT_BASE_PATCH32_TEXT.md) +- [DEEPLAB_V3_RESNET50](variables/DEEPLAB_V3_RESNET50.md) +- [DEFAULT_CHAT_CONFIG](variables/DEFAULT_CHAT_CONFIG.md) +- [DEFAULT_CONTEXT_WINDOW_LENGTH](variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md) +- [DEFAULT_MESSAGE_HISTORY](variables/DEFAULT_MESSAGE_HISTORY.md) +- [DEFAULT_SYSTEM_PROMPT](variables/DEFAULT_SYSTEM_PROMPT.md) +- [EFFICIENTNET_V2_S](variables/EFFICIENTNET_V2_S.md) +- [FSMN_VAD](variables/FSMN_VAD.md) +- [HAMMER2_1_0_5B](variables/HAMMER2_1_0_5B.md) +- [HAMMER2_1_0_5B_QUANTIZED](variables/HAMMER2_1_0_5B_QUANTIZED.md) +- [HAMMER2_1_1_5B](variables/HAMMER2_1_1_5B.md) +- [HAMMER2_1_1_5B_QUANTIZED](variables/HAMMER2_1_1_5B_QUANTIZED.md) +- [HAMMER2_1_3B](variables/HAMMER2_1_3B.md) +- [HAMMER2_1_3B_QUANTIZED](variables/HAMMER2_1_3B_QUANTIZED.md) +- [KOKORO_EN](variables/KOKORO_EN.md) +- [KOKORO_VOICE_AF_HEART](variables/KOKORO_VOICE_AF_HEART.md) +- [KOKORO_VOICE_AF_RIVER](variables/KOKORO_VOICE_AF_RIVER.md) +- [KOKORO_VOICE_AF_SARAH](variables/KOKORO_VOICE_AF_SARAH.md) +- [KOKORO_VOICE_AM_ADAM](variables/KOKORO_VOICE_AM_ADAM.md) +- [KOKORO_VOICE_AM_MICHAEL](variables/KOKORO_VOICE_AM_MICHAEL.md) +- [KOKORO_VOICE_AM_SANTA](variables/KOKORO_VOICE_AM_SANTA.md) +- [KOKORO_VOICE_BF_EMMA](variables/KOKORO_VOICE_BF_EMMA.md) +- [KOKORO_VOICE_BM_DANIEL](variables/KOKORO_VOICE_BM_DANIEL.md) +- [LLAMA3_2_1B](variables/LLAMA3_2_1B.md) +- [LLAMA3_2_1B_QLORA](variables/LLAMA3_2_1B_QLORA.md) +- [LLAMA3_2_1B_SPINQUANT](variables/LLAMA3_2_1B_SPINQUANT.md) +- [LLAMA3_2_3B](variables/LLAMA3_2_3B.md) +- [LLAMA3_2_3B_QLORA](variables/LLAMA3_2_3B_QLORA.md) +- [LLAMA3_2_3B_SPINQUANT](variables/LLAMA3_2_3B_SPINQUANT.md) +- [MULTI_QA_MINILM_L6_COS_V1](variables/MULTI_QA_MINILM_L6_COS_V1.md) +- [MULTI_QA_MPNET_BASE_DOT_V1](variables/MULTI_QA_MPNET_BASE_DOT_V1.md) +- [OCR_ABAZA](variables/OCR_ABAZA.md) +- [OCR_ADYGHE](variables/OCR_ADYGHE.md) +- [OCR_AFRIKAANS](variables/OCR_AFRIKAANS.md) +- [OCR_ALBANIAN](variables/OCR_ALBANIAN.md) +- [OCR_AVAR](variables/OCR_AVAR.md) +- [OCR_AZERBAIJANI](variables/OCR_AZERBAIJANI.md) +- [OCR_BELARUSIAN](variables/OCR_BELARUSIAN.md) +- [OCR_BOSNIAN](variables/OCR_BOSNIAN.md) +- [OCR_BULGARIAN](variables/OCR_BULGARIAN.md) +- [OCR_CHECHEN](variables/OCR_CHECHEN.md) +- [OCR_CROATIAN](variables/OCR_CROATIAN.md) +- [OCR_CZECH](variables/OCR_CZECH.md) +- [OCR_DANISH](variables/OCR_DANISH.md) +- [OCR_DARGWA](variables/OCR_DARGWA.md) +- [OCR_DUTCH](variables/OCR_DUTCH.md) +- [OCR_ENGLISH](variables/OCR_ENGLISH.md) +- [OCR_ESTONIAN](variables/OCR_ESTONIAN.md) +- [OCR_FRENCH](variables/OCR_FRENCH.md) +- [OCR_GERMAN](variables/OCR_GERMAN.md) +- [OCR_HUNGARIAN](variables/OCR_HUNGARIAN.md) +- [OCR_ICELANDIC](variables/OCR_ICELANDIC.md) +- [OCR_INDONESIAN](variables/OCR_INDONESIAN.md) +- [OCR_INGUSH](variables/OCR_INGUSH.md) +- [OCR_IRISH](variables/OCR_IRISH.md) +- [OCR_ITALIAN](variables/OCR_ITALIAN.md) +- [OCR_JAPANESE](variables/OCR_JAPANESE.md) +- [OCR_KANNADA](variables/OCR_KANNADA.md) +- [OCR_KARBADIAN](variables/OCR_KARBADIAN.md) +- [OCR_KOREAN](variables/OCR_KOREAN.md) +- [OCR_KURDISH](variables/OCR_KURDISH.md) +- [OCR_LAK](variables/OCR_LAK.md) +- [OCR_LATIN](variables/OCR_LATIN.md) +- [OCR_LATVIAN](variables/OCR_LATVIAN.md) +- [OCR_LEZGHIAN](variables/OCR_LEZGHIAN.md) +- [OCR_LITHUANIAN](variables/OCR_LITHUANIAN.md) +- [OCR_MALAY](variables/OCR_MALAY.md) +- [OCR_MALTESE](variables/OCR_MALTESE.md) +- [OCR_MAORI](variables/OCR_MAORI.md) +- [OCR_MONGOLIAN](variables/OCR_MONGOLIAN.md) +- [OCR_NORWEGIAN](variables/OCR_NORWEGIAN.md) +- [OCR_OCCITAN](variables/OCR_OCCITAN.md) +- [OCR_PALI](variables/OCR_PALI.md) +- [OCR_POLISH](variables/OCR_POLISH.md) +- [OCR_PORTUGUESE](variables/OCR_PORTUGUESE.md) +- [OCR_ROMANIAN](variables/OCR_ROMANIAN.md) +- [OCR_RUSSIAN](variables/OCR_RUSSIAN.md) +- [OCR_SERBIAN_CYRILLIC](variables/OCR_SERBIAN_CYRILLIC.md) +- [OCR_SERBIAN_LATIN](variables/OCR_SERBIAN_LATIN.md) +- [OCR_SIMPLIFIED_CHINESE](variables/OCR_SIMPLIFIED_CHINESE.md) +- [OCR_SLOVAK](variables/OCR_SLOVAK.md) +- [OCR_SLOVENIAN](variables/OCR_SLOVENIAN.md) +- [OCR_SPANISH](variables/OCR_SPANISH.md) +- [OCR_SWAHILI](variables/OCR_SWAHILI.md) +- [OCR_SWEDISH](variables/OCR_SWEDISH.md) +- [OCR_TABASSARAN](variables/OCR_TABASSARAN.md) +- [OCR_TAGALOG](variables/OCR_TAGALOG.md) +- [OCR_TAJIK](variables/OCR_TAJIK.md) +- [OCR_TELUGU](variables/OCR_TELUGU.md) +- [OCR_TURKISH](variables/OCR_TURKISH.md) +- [OCR_UKRAINIAN](variables/OCR_UKRAINIAN.md) +- [OCR_UZBEK](variables/OCR_UZBEK.md) +- [OCR_VIETNAMESE](variables/OCR_VIETNAMESE.md) +- [OCR_WELSH](variables/OCR_WELSH.md) +- [parseToolCall](variables/parseToolCall.md) +- [PHI_4_MINI_4B](variables/PHI_4_MINI_4B.md) +- [PHI_4_MINI_4B_QUANTIZED](variables/PHI_4_MINI_4B_QUANTIZED.md) +- [QWEN2_5_0_5B](variables/QWEN2_5_0_5B.md) +- [QWEN2_5_0_5B_QUANTIZED](variables/QWEN2_5_0_5B_QUANTIZED.md) +- [QWEN2_5_1_5B](variables/QWEN2_5_1_5B.md) +- [QWEN2_5_1_5B_QUANTIZED](variables/QWEN2_5_1_5B_QUANTIZED.md) +- [QWEN2_5_3B](variables/QWEN2_5_3B.md) +- [QWEN2_5_3B_QUANTIZED](variables/QWEN2_5_3B_QUANTIZED.md) +- [QWEN3_0_6B](variables/QWEN3_0_6B.md) +- [QWEN3_0_6B_QUANTIZED](variables/QWEN3_0_6B_QUANTIZED.md) +- [QWEN3_1_7B](variables/QWEN3_1_7B.md) +- [QWEN3_1_7B_QUANTIZED](variables/QWEN3_1_7B_QUANTIZED.md) +- [QWEN3_4B](variables/QWEN3_4B.md) +- [QWEN3_4B_QUANTIZED](variables/QWEN3_4B_QUANTIZED.md) +- [SMOLLM2_1_1_7B](variables/SMOLLM2_1_1_7B.md) +- [SMOLLM2_1_1_7B_QUANTIZED](variables/SMOLLM2_1_1_7B_QUANTIZED.md) +- [SMOLLM2_1_135M](variables/SMOLLM2_1_135M.md) +- [SMOLLM2_1_135M_QUANTIZED](variables/SMOLLM2_1_135M_QUANTIZED.md) +- [SMOLLM2_1_360M](variables/SMOLLM2_1_360M.md) +- [SMOLLM2_1_360M_QUANTIZED](variables/SMOLLM2_1_360M_QUANTIZED.md) +- [SPECIAL_TOKENS](variables/SPECIAL_TOKENS.md) +- [SSDLITE_320_MOBILENET_V3_LARGE](variables/SSDLITE_320_MOBILENET_V3_LARGE.md) +- [STYLE_TRANSFER_CANDY](variables/STYLE_TRANSFER_CANDY.md) +- [STYLE_TRANSFER_MOSAIC](variables/STYLE_TRANSFER_MOSAIC.md) +- [STYLE_TRANSFER_RAIN_PRINCESS](variables/STYLE_TRANSFER_RAIN_PRINCESS.md) +- [STYLE_TRANSFER_UDNIE](variables/STYLE_TRANSFER_UDNIE.md) +- [VERTICAL_OCR_ABAZA](variables/VERTICAL_OCR_ABAZA.md) +- [VERTICAL_OCR_ADYGHE](variables/VERTICAL_OCR_ADYGHE.md) +- [VERTICAL_OCR_AFRIKAANS](variables/VERTICAL_OCR_AFRIKAANS.md) +- [VERTICAL_OCR_ALBANIAN](variables/VERTICAL_OCR_ALBANIAN.md) +- [VERTICAL_OCR_AVAR](variables/VERTICAL_OCR_AVAR.md) +- [VERTICAL_OCR_AZERBAIJANI](variables/VERTICAL_OCR_AZERBAIJANI.md) +- [VERTICAL_OCR_BELARUSIAN](variables/VERTICAL_OCR_BELARUSIAN.md) +- [VERTICAL_OCR_BOSNIAN](variables/VERTICAL_OCR_BOSNIAN.md) +- [VERTICAL_OCR_BULGARIAN](variables/VERTICAL_OCR_BULGARIAN.md) +- [VERTICAL_OCR_CHECHEN](variables/VERTICAL_OCR_CHECHEN.md) +- [VERTICAL_OCR_CROATIAN](variables/VERTICAL_OCR_CROATIAN.md) +- [VERTICAL_OCR_CZECH](variables/VERTICAL_OCR_CZECH.md) +- [VERTICAL_OCR_DANISH](variables/VERTICAL_OCR_DANISH.md) +- [VERTICAL_OCR_DARGWA](variables/VERTICAL_OCR_DARGWA.md) +- [VERTICAL_OCR_DUTCH](variables/VERTICAL_OCR_DUTCH.md) +- [VERTICAL_OCR_ENGLISH](variables/VERTICAL_OCR_ENGLISH.md) +- [VERTICAL_OCR_ESTONIAN](variables/VERTICAL_OCR_ESTONIAN.md) +- [VERTICAL_OCR_FRENCH](variables/VERTICAL_OCR_FRENCH.md) +- [VERTICAL_OCR_GERMAN](variables/VERTICAL_OCR_GERMAN.md) +- [VERTICAL_OCR_HUNGARIAN](variables/VERTICAL_OCR_HUNGARIAN.md) +- [VERTICAL_OCR_ICELANDIC](variables/VERTICAL_OCR_ICELANDIC.md) +- [VERTICAL_OCR_INDONESIAN](variables/VERTICAL_OCR_INDONESIAN.md) +- [VERTICAL_OCR_INGUSH](variables/VERTICAL_OCR_INGUSH.md) +- [VERTICAL_OCR_IRISH](variables/VERTICAL_OCR_IRISH.md) +- [VERTICAL_OCR_ITALIAN](variables/VERTICAL_OCR_ITALIAN.md) +- [VERTICAL_OCR_JAPANESE](variables/VERTICAL_OCR_JAPANESE.md) +- [VERTICAL_OCR_KANNADA](variables/VERTICAL_OCR_KANNADA.md) +- [VERTICAL_OCR_KARBADIAN](variables/VERTICAL_OCR_KARBADIAN.md) +- [VERTICAL_OCR_KOREAN](variables/VERTICAL_OCR_KOREAN.md) +- [VERTICAL_OCR_KURDISH](variables/VERTICAL_OCR_KURDISH.md) +- [VERTICAL_OCR_LAK](variables/VERTICAL_OCR_LAK.md) +- [VERTICAL_OCR_LATIN](variables/VERTICAL_OCR_LATIN.md) +- [VERTICAL_OCR_LATVIAN](variables/VERTICAL_OCR_LATVIAN.md) +- [VERTICAL_OCR_LEZGHIAN](variables/VERTICAL_OCR_LEZGHIAN.md) +- [VERTICAL_OCR_LITHUANIAN](variables/VERTICAL_OCR_LITHUANIAN.md) +- [VERTICAL_OCR_MALAY](variables/VERTICAL_OCR_MALAY.md) +- [VERTICAL_OCR_MALTESE](variables/VERTICAL_OCR_MALTESE.md) +- [VERTICAL_OCR_MAORI](variables/VERTICAL_OCR_MAORI.md) +- [VERTICAL_OCR_MONGOLIAN](variables/VERTICAL_OCR_MONGOLIAN.md) +- [VERTICAL_OCR_NORWEGIAN](variables/VERTICAL_OCR_NORWEGIAN.md) +- [VERTICAL_OCR_OCCITAN](variables/VERTICAL_OCR_OCCITAN.md) +- [VERTICAL_OCR_PALI](variables/VERTICAL_OCR_PALI.md) +- [VERTICAL_OCR_POLISH](variables/VERTICAL_OCR_POLISH.md) +- [VERTICAL_OCR_PORTUGUESE](variables/VERTICAL_OCR_PORTUGUESE.md) +- [VERTICAL_OCR_ROMANIAN](variables/VERTICAL_OCR_ROMANIAN.md) +- [VERTICAL_OCR_RUSSIAN](variables/VERTICAL_OCR_RUSSIAN.md) +- [VERTICAL_OCR_SERBIAN_CYRILLIC](variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md) +- [VERTICAL_OCR_SERBIAN_LATIN](variables/VERTICAL_OCR_SERBIAN_LATIN.md) +- [VERTICAL_OCR_SIMPLIFIED_CHINESE](variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md) +- [VERTICAL_OCR_SLOVAK](variables/VERTICAL_OCR_SLOVAK.md) +- [VERTICAL_OCR_SLOVENIAN](variables/VERTICAL_OCR_SLOVENIAN.md) +- [VERTICAL_OCR_SPANISH](variables/VERTICAL_OCR_SPANISH.md) +- [VERTICAL_OCR_SWAHILI](variables/VERTICAL_OCR_SWAHILI.md) +- [VERTICAL_OCR_SWEDISH](variables/VERTICAL_OCR_SWEDISH.md) +- [VERTICAL_OCR_TABASSARAN](variables/VERTICAL_OCR_TABASSARAN.md) +- [VERTICAL_OCR_TAGALOG](variables/VERTICAL_OCR_TAGALOG.md) +- [VERTICAL_OCR_TAJIK](variables/VERTICAL_OCR_TAJIK.md) +- [VERTICAL_OCR_TELUGU](variables/VERTICAL_OCR_TELUGU.md) +- [VERTICAL_OCR_TURKISH](variables/VERTICAL_OCR_TURKISH.md) +- [VERTICAL_OCR_UKRAINIAN](variables/VERTICAL_OCR_UKRAINIAN.md) +- [VERTICAL_OCR_UZBEK](variables/VERTICAL_OCR_UZBEK.md) +- [VERTICAL_OCR_VIETNAMESE](variables/VERTICAL_OCR_VIETNAMESE.md) +- [VERTICAL_OCR_WELSH](variables/VERTICAL_OCR_WELSH.md) +- [WHISPER_BASE](variables/WHISPER_BASE.md) +- [WHISPER_BASE_EN](variables/WHISPER_BASE_EN.md) +- [WHISPER_SMALL](variables/WHISPER_SMALL.md) +- [WHISPER_SMALL_EN](variables/WHISPER_SMALL_EN.md) +- [WHISPER_TINY](variables/WHISPER_TINY.md) +- [WHISPER_TINY_EN](variables/WHISPER_TINY_EN.md) +- [WHISPER_TINY_EN_QUANTIZED](variables/WHISPER_TINY_EN_QUANTIZED.md) + +## Functions + +- [DEFAULT_STRUCTURED_OUTPUT_PROMPT](functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md) +- [fixAndValidateStructuredOutput](functions/fixAndValidateStructuredOutput.md) +- [getStructuredOutputPrompt](functions/getStructuredOutputPrompt.md) +- [useClassification](functions/useClassification.md) +- [useExecutorchModule](functions/useExecutorchModule.md) +- [useImageEmbeddings](functions/useImageEmbeddings.md) +- [useImageSegmentation](functions/useImageSegmentation.md) +- [useLLM](functions/useLLM.md) +- [useObjectDetection](functions/useObjectDetection.md) +- [useOCR](functions/useOCR.md) +- [useSpeechToText](functions/useSpeechToText.md) +- [useStyleTransfer](functions/useStyleTransfer.md) +- [useTextEmbeddings](functions/useTextEmbeddings.md) +- [useTextToImage](functions/useTextToImage.md) +- [useTextToSpeech](functions/useTextToSpeech.md) +- [useTokenizer](functions/useTokenizer.md) +- [useVAD](functions/useVAD.md) +- [useVerticalOCR](functions/useVerticalOCR.md) diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md new file mode 100644 index 000000000..17cb15d92 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -0,0 +1,35 @@ +# Interface: Bbox + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L1) + +## Properties + +### x1 + +> **x1**: `number` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L2) + +--- + +### x2 + +> **x2**: `number` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L3) + +--- + +### y1 + +> **y1**: `number` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L4) + +--- + +### y2 + +> **y2**: `number` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L5) diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md new file mode 100644 index 000000000..f1a5b207e --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -0,0 +1,27 @@ +# Interface: ChatConfig + +Defined in: [packages/react-native-executorch/src/types/llm.ts:43](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L43) + +## Properties + +### contextWindowLength + +> **contextWindowLength**: `number` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:45](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L45) + +--- + +### initialMessageHistory + +> **initialMessageHistory**: [`Message`](Message.md)[] + +Defined in: [packages/react-native-executorch/src/types/llm.ts:44](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L44) + +--- + +### systemPrompt + +> **systemPrompt**: `string` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:46](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L46) diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md new file mode 100644 index 000000000..3e7e6e32d --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -0,0 +1,11 @@ +# Interface: DecodingOptions + +Defined in: [packages/react-native-executorch/src/types/stt.ts:81](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L81) + +## Properties + +### language? + +> `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) + +Defined in: [packages/react-native-executorch/src/types/stt.ts:82](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L82) diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md new file mode 100644 index 000000000..1cd0dd2f2 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -0,0 +1,27 @@ +# Interface: Detection + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L8) + +## Properties + +### bbox + +> **bbox**: [`Bbox`](Bbox.md) + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L9) + +--- + +### label + +> **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L10) + +--- + +### score + +> **score**: `number` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L11) diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md new file mode 100644 index 000000000..7cf93fe20 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -0,0 +1,35 @@ +# Interface: GenerationConfig + +Defined in: [packages/react-native-executorch/src/types/llm.ts:55](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L55) + +## Properties + +### batchTimeInterval? + +> `optional` **batchTimeInterval**: `number` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L59) + +--- + +### outputTokenBatchSize? + +> `optional` **outputTokenBatchSize**: `number` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:58](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L58) + +--- + +### temperature? + +> `optional` **temperature**: `number` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:56](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L56) + +--- + +### topp? + +> `optional` **topp**: `number` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:57](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L57) diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md new file mode 100644 index 000000000..cb97ac822 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -0,0 +1,169 @@ +# Interface: LLMType + +Defined in: [packages/react-native-executorch/src/types/llm.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L3) + +## Properties + +### configure() + +> **configure**: (`__namedParameters`) => `void` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L11) + +#### Parameters + +##### \_\_namedParameters + +###### chatConfig? + +`Partial`\<[`ChatConfig`](ChatConfig.md)\> + +###### generationConfig? + +[`GenerationConfig`](GenerationConfig.md) + +###### toolsConfig? + +[`ToolsConfig`](ToolsConfig.md) + +#### Returns + +`void` + +--- + +### deleteMessage() + +> **deleteMessage**: (`index`) => `void` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:23](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L23) + +#### Parameters + +##### index + +`number` + +#### Returns + +`void` + +--- + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L9) + +--- + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L10) + +--- + +### generate() + +> **generate**: (`messages`, `tools?`) => `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/types/llm.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L21) + +#### Parameters + +##### messages + +[`Message`](Message.md)[] + +##### tools? + +`Object`[] + +#### Returns + +`Promise`\<`void`\> + +--- + +### getGeneratedTokenCount() + +> **getGeneratedTokenCount**: () => `number` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L20) + +#### Returns + +`number` + +--- + +### interrupt() + +> **interrupt**: () => `void` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:24](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L24) + +#### Returns + +`void` + +--- + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L8) + +--- + +### isReady + +> **isReady**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L7) + +--- + +### messageHistory + +> **messageHistory**: [`Message`](Message.md)[] + +Defined in: [packages/react-native-executorch/src/types/llm.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L4) + +--- + +### response + +> **response**: `string` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L5) + +--- + +### sendMessage() + +> **sendMessage**: (`message`) => `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/types/llm.ts:22](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L22) + +#### Parameters + +##### message + +`string` + +#### Returns + +`Promise`\<`void`\> + +--- + +### token + +> **token**: `string` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L6) diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md new file mode 100644 index 000000000..ba9e2f7f4 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -0,0 +1,19 @@ +# Interface: Message + +Defined in: [packages/react-native-executorch/src/types/llm.ts:29](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L29) + +## Properties + +### content + +> **content**: `string` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:31](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L31) + +--- + +### role + +> **role**: [`MessageRole`](../type-aliases/MessageRole.md) + +Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L30) diff --git a/docs/docs/06-api-reference/interfaces/OCRBbox.md b/docs/docs/06-api-reference/interfaces/OCRBbox.md new file mode 100644 index 000000000..c60e07373 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/OCRBbox.md @@ -0,0 +1,19 @@ +# Interface: OCRBbox + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L9) + +## Properties + +### x + +> **x**: `number` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L10) + +--- + +### y + +> **y**: `number` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L11) diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md new file mode 100644 index 000000000..2ac8a64c1 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -0,0 +1,27 @@ +# Interface: OCRDetection + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L3) + +## Properties + +### bbox + +> **bbox**: [`OCRBbox`](OCRBbox.md)[] + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L4) + +--- + +### score + +> **score**: `number` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L6) + +--- + +### text + +> **text**: `string` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L5) diff --git a/docs/docs/06-api-reference/interfaces/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md new file mode 100644 index 000000000..94f604365 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -0,0 +1,19 @@ +# Interface: Segment + +Defined in: [packages/react-native-executorch/src/types/vad.ts:1](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/vad.ts#L1) + +## Properties + +### end + +> **end**: `number` + +Defined in: [packages/react-native-executorch/src/types/vad.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/vad.ts#L3) + +--- + +### start + +> **start**: `number` + +Defined in: [packages/react-native-executorch/src/types/vad.ts:2](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/vad.ts#L2) diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md new file mode 100644 index 000000000..ac4004faf --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -0,0 +1,35 @@ +# Interface: SpeechToTextModelConfig + +Defined in: [packages/react-native-executorch/src/types/stt.ts:85](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L85) + +## Properties + +### decoderSource + +> **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: [packages/react-native-executorch/src/types/stt.ts:88](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L88) + +--- + +### encoderSource + +> **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L87) + +--- + +### isMultilingual + +> **isMultilingual**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/stt.ts:86](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L86) + +--- + +### tokenizerSource + +> **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: [packages/react-native-executorch/src/types/stt.ts:89](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L89) diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md new file mode 100644 index 000000000..521063ded --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -0,0 +1,27 @@ +# Interface: TensorPtr + +Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L41) + +## Properties + +### dataPtr + +> **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) + +Defined in: [packages/react-native-executorch/src/types/common.ts:42](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L42) + +--- + +### scalarType + +> **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) + +Defined in: [packages/react-native-executorch/src/types/common.ts:44](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L44) + +--- + +### sizes + +> **sizes**: `number`[] + +Defined in: [packages/react-native-executorch/src/types/common.ts:43](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L43) diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md new file mode 100644 index 000000000..8d5f50291 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -0,0 +1,19 @@ +# Interface: ToolCall + +Defined in: [packages/react-native-executorch/src/types/llm.ts:34](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L34) + +## Properties + +### arguments + +> **arguments**: `Object` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:36](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L36) + +--- + +### toolName + +> **toolName**: `string` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L35) diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md new file mode 100644 index 000000000..7e321b09d --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -0,0 +1,37 @@ +# Interface: ToolsConfig + +Defined in: [packages/react-native-executorch/src/types/llm.ts:49](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L49) + +## Properties + +### displayToolCalls? + +> `optional` **displayToolCalls**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:52](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L52) + +--- + +### executeToolCallback() + +> **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> + +Defined in: [packages/react-native-executorch/src/types/llm.ts:51](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L51) + +#### Parameters + +##### call + +[`ToolCall`](ToolCall.md) + +#### Returns + +`Promise`\<`string` \| `null`\> + +--- + +### tools + +> **tools**: `Object`[] + +Defined in: [packages/react-native-executorch/src/types/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L50) diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md new file mode 100644 index 000000000..487201d5e --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -0,0 +1,5 @@ +# Type Alias: LLMTool + +> **LLMTool** = `Object` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:41](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L41) diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md new file mode 100644 index 000000000..324dbc6aa --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -0,0 +1,5 @@ +# Type Alias: MessageRole + +> **MessageRole** = `"user"` \| `"assistant"` \| `"system"` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:27](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L27) diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md new file mode 100644 index 000000000..16db0aab6 --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -0,0 +1,5 @@ +# Type Alias: OCRLanguage + +> **OCRLanguage** = keyof _typeof_ `symbols` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L14) diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md new file mode 100644 index 000000000..f0225fc6a --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -0,0 +1,5 @@ +# Type Alias: ResourceSource + +> **ResourceSource** = `string` \| `number` \| `object` + +Defined in: [packages/react-native-executorch/src/types/common.ts:1](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L1) diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md new file mode 100644 index 000000000..a7c8e68a9 --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -0,0 +1,5 @@ +# Type Alias: SpeechToTextLanguage + +> **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` + +Defined in: [packages/react-native-executorch/src/types/stt.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L4) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md new file mode 100644 index 000000000..30c5122e3 --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -0,0 +1,5 @@ +# Type Alias: TensorBuffer + +> **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` + +Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L28) diff --git a/docs/docs/06-api-reference/typedoc-sidebar.cjs b/docs/docs/06-api-reference/typedoc-sidebar.cjs new file mode 100644 index 000000000..a24e8c1aa --- /dev/null +++ b/docs/docs/06-api-reference/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ +const typedocSidebar = {items:[{type:"category",label:"Enumerations",items:[{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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/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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{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/OCRBbox",label:"OCRBbox"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/TensorPtr",label:"TensorPtr"},{type:"doc",id:"06-api-reference/interfaces/ToolCall",label:"ToolCall"},{type:"doc",id:"06-api-reference/interfaces/ToolsConfig",label:"ToolsConfig"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_EN",label:"KOKORO_EN"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; +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 new file mode 100644 index 000000000..1805dbd63 --- /dev/null +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -0,0 +1,15 @@ +# Variable: ALL_MINILM_L6_V2 + +> `const` **ALL_MINILM_L6_V2**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L408) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `ALL_MINILM_L6_V2_MODEL` + +### tokenizerSource + +> **tokenizerSource**: `string` = `ALL_MINILM_L6_V2_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md new file mode 100644 index 000000000..0f362f25b --- /dev/null +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -0,0 +1,15 @@ +# Variable: ALL_MPNET_BASE_V2 + +> `const` **ALL_MPNET_BASE_V2**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L413) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `ALL_MPNET_BASE_V2_MODEL` + +### tokenizerSource + +> **tokenizerSource**: `string` = `ALL_MPNET_BASE_V2_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md new file mode 100644 index 000000000..1557a37f9 --- /dev/null +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -0,0 +1,27 @@ +# Variable: BK_SDM_TINY_VPRED_256 + +> `const` **BK_SDM_TINY_VPRED_256**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L442) + +## Type Declaration + +### decoderSource + +> **decoderSource**: `string` + +### encoderSource + +> **encoderSource**: `string` + +### schedulerSource + +> **schedulerSource**: `string` + +### tokenizerSource + +> **tokenizerSource**: `string` + +### unetSource + +> **unetSource**: `string` diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md new file mode 100644 index 000000000..a669619ac --- /dev/null +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -0,0 +1,27 @@ +# Variable: BK_SDM_TINY_VPRED_512 + +> `const` **BK_SDM_TINY_VPRED_512**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L434) + +## Type Declaration + +### decoderSource + +> **decoderSource**: `string` + +### encoderSource + +> **encoderSource**: `string` + +### schedulerSource + +> **schedulerSource**: `string` + +### tokenizerSource + +> **tokenizerSource**: `string` + +### unetSource + +> **unetSource**: `string` diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md new file mode 100644 index 000000000..5504715b3 --- /dev/null +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -0,0 +1,11 @@ +# Variable: CLIP_VIT_BASE_PATCH32_IMAGE + +> `const` **CLIP_VIT_BASE_PATCH32_IMAGE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L392) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `CLIP_VIT_BASE_PATCH32_IMAGE_MODEL` diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md new file mode 100644 index 000000000..b7c45b13a --- /dev/null +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -0,0 +1,15 @@ +# Variable: CLIP_VIT_BASE_PATCH32_TEXT + +> `const` **CLIP_VIT_BASE_PATCH32_TEXT**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L428) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `CLIP_VIT_BASE_PATCH32_TEXT_MODEL` + +### tokenizerSource + +> **tokenizerSource**: `string` = `CLIP_VIT_BASE_PATCH32_TEXT_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md new file mode 100644 index 000000000..90d7709e4 --- /dev/null +++ b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md @@ -0,0 +1,11 @@ +# Variable: DEEPLAB_V3_RESNET50 + +> `const` **DEEPLAB_V3_RESNET50**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L385) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `DEEPLAB_V3_RESNET50_MODEL` diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md new file mode 100644 index 000000000..e073a5614 --- /dev/null +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -0,0 +1,5 @@ +# Variable: DEFAULT_CHAT_CONFIG + +> `const` **DEFAULT_CHAT_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) + +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md new file mode 100644 index 000000000..b7c500472 --- /dev/null +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md @@ -0,0 +1,5 @@ +# Variable: DEFAULT_CONTEXT_WINDOW_LENGTH + +> `const` **DEFAULT_CONTEXT_WINDOW_LENGTH**: `5` = `5` + +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md new file mode 100644 index 000000000..56b9766df --- /dev/null +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -0,0 +1,5 @@ +# Variable: DEFAULT_MESSAGE_HISTORY + +> `const` **DEFAULT_MESSAGE_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` + +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md new file mode 100644 index 000000000..e548b8b19 --- /dev/null +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -0,0 +1,5 @@ +# Variable: DEFAULT_SYSTEM_PROMPT + +> `const` **DEFAULT_SYSTEM_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` + +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) diff --git a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md new file mode 100644 index 000000000..75891beef --- /dev/null +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -0,0 +1,11 @@ +# Variable: EFFICIENTNET_V2_S + +> `const` **EFFICIENTNET_V2_S**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L260) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `EFFICIENTNET_V2_S_MODEL` diff --git a/docs/docs/06-api-reference/variables/FSMN_VAD.md b/docs/docs/06-api-reference/variables/FSMN_VAD.md new file mode 100644 index 000000000..5b7bc2b85 --- /dev/null +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -0,0 +1,11 @@ +# Variable: FSMN_VAD + +> `const` **FSMN_VAD**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L453) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `FSMN_VAD_MODEL` diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md new file mode 100644 index 000000000..bdac191c3 --- /dev/null +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -0,0 +1,19 @@ +# Variable: HAMMER2_1_0_5B + +> `const` **HAMMER2_1_0_5B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L108) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `HAMMER2_1_0_5B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md new file mode 100644 index 000000000..e282d8142 --- /dev/null +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: HAMMER2_1_0_5B_QUANTIZED + +> `const` **HAMMER2_1_0_5B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L114) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `HAMMER2_1_0_5B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md new file mode 100644 index 000000000..83f1653c2 --- /dev/null +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -0,0 +1,19 @@ +# Variable: HAMMER2_1_1_5B + +> `const` **HAMMER2_1_1_5B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L120) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `HAMMER2_1_1_5B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md new file mode 100644 index 000000000..a8de56ef6 --- /dev/null +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: HAMMER2_1_1_5B_QUANTIZED + +> `const` **HAMMER2_1_1_5B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L126) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `HAMMER2_1_1_5B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md new file mode 100644 index 000000000..aaf3e4040 --- /dev/null +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -0,0 +1,19 @@ +# Variable: HAMMER2_1_3B + +> `const` **HAMMER2_1_3B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L132) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `HAMMER2_1_3B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md new file mode 100644 index 000000000..7e118fd31 --- /dev/null +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: HAMMER2_1_3B_QUANTIZED + +> `const` **HAMMER2_1_3B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L138) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `HAMMER2_1_3B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `HAMMER2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `HAMMER2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/KOKORO_EN.md b/docs/docs/06-api-reference/variables/KOKORO_EN.md new file mode 100644 index 000000000..ceb6c9e44 --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_EN.md @@ -0,0 +1,27 @@ +# Variable: KOKORO_EN + +> `const` **KOKORO_EN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/models.ts#L9) + +## Type Declaration + +### durationPredictorSource + +> **durationPredictorSource**: `string` = `KOKORO_EN_DURATION_PREDICTOR` + +### f0nPredictorSource + +> **f0nPredictorSource**: `string` = `KOKORO_EN_F0N_PREDICTOR` + +### textDecoderSource + +> **textDecoderSource**: `string` = `KOKORO_EN_TEXT_DECODER` + +### textEncoderSource + +> **textEncoderSource**: `string` = `KOKORO_EN_TEXT_ENCODER` + +### type + +> **type**: `"kokoro"` diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md new file mode 100644 index 000000000..27edddeef --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -0,0 +1,5 @@ +# Variable: KOKORO_VOICE_AF_HEART + +> `const` **KOKORO_VOICE_AF_HEART**: `VoiceConfig` + +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L21) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md new file mode 100644 index 000000000..00efb4b5f --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -0,0 +1,5 @@ +# Variable: KOKORO_VOICE_AF_RIVER + +> `const` **KOKORO_VOICE_AF_RIVER**: `VoiceConfig` + +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L26) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md new file mode 100644 index 000000000..e269bf6ac --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -0,0 +1,5 @@ +# Variable: KOKORO_VOICE_AF_SARAH + +> `const` **KOKORO_VOICE_AF_SARAH**: `VoiceConfig` + +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L31) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md new file mode 100644 index 000000000..84dee7043 --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -0,0 +1,5 @@ +# Variable: KOKORO_VOICE_AM_ADAM + +> `const` **KOKORO_VOICE_AM_ADAM**: `VoiceConfig` + +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L36) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md new file mode 100644 index 000000000..d7dbe07f7 --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -0,0 +1,5 @@ +# Variable: KOKORO_VOICE_AM_MICHAEL + +> `const` **KOKORO_VOICE_AM_MICHAEL**: `VoiceConfig` + +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L41) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md new file mode 100644 index 000000000..9c0919c53 --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -0,0 +1,5 @@ +# Variable: KOKORO_VOICE_AM_SANTA + +> `const` **KOKORO_VOICE_AM_SANTA**: `VoiceConfig` + +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L46) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md new file mode 100644 index 000000000..05d12bace --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -0,0 +1,5 @@ +# Variable: KOKORO_VOICE_BF_EMMA + +> `const` **KOKORO_VOICE_BF_EMMA**: `VoiceConfig` + +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L51) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md new file mode 100644 index 000000000..ea0491ef6 --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -0,0 +1,5 @@ +# Variable: KOKORO_VOICE_BM_DANIEL + +> `const` **KOKORO_VOICE_BM_DANIEL**: `VoiceConfig` + +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L56) diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md new file mode 100644 index 000000000..5aa347cb3 --- /dev/null +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -0,0 +1,19 @@ +# Variable: LLAMA3_2_1B + +> `const` **LLAMA3_2_1B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L34) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `LLAMA3_2_1B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md new file mode 100644 index 000000000..4319564ed --- /dev/null +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -0,0 +1,19 @@ +# Variable: LLAMA3_2_1B_QLORA + +> `const` **LLAMA3_2_1B_QLORA**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L40) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `LLAMA3_2_1B_QLORA_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md new file mode 100644 index 000000000..1ba6e7241 --- /dev/null +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -0,0 +1,19 @@ +# Variable: LLAMA3_2_1B_SPINQUANT + +> `const` **LLAMA3_2_1B_SPINQUANT**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L46) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `LLAMA3_2_1B_SPINQUANT_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md new file mode 100644 index 000000000..f9e697186 --- /dev/null +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -0,0 +1,19 @@ +# Variable: LLAMA3_2_3B + +> `const` **LLAMA3_2_3B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L16) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `LLAMA3_2_3B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md new file mode 100644 index 000000000..4ab5b1d68 --- /dev/null +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -0,0 +1,19 @@ +# Variable: LLAMA3_2_3B_QLORA + +> `const` **LLAMA3_2_3B_QLORA**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L22) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `LLAMA3_2_3B_QLORA_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md new file mode 100644 index 000000000..47add3a09 --- /dev/null +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -0,0 +1,19 @@ +# Variable: LLAMA3_2_3B_SPINQUANT + +> `const` **LLAMA3_2_3B_SPINQUANT**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L28) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `LLAMA3_2_3B_SPINQUANT_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `LLAMA3_2_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `LLAMA3_2_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md new file mode 100644 index 000000000..522486051 --- /dev/null +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -0,0 +1,15 @@ +# Variable: MULTI_QA_MINILM_L6_COS_V1 + +> `const` **MULTI_QA_MINILM_L6_COS_V1**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L418) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `MULTI_QA_MINILM_L6_COS_V1_MODEL` + +### tokenizerSource + +> **tokenizerSource**: `string` = `MULTI_QA_MINILM_L6_COS_V1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md new file mode 100644 index 000000000..4d87af0de --- /dev/null +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -0,0 +1,15 @@ +# Variable: MULTI_QA_MPNET_BASE_DOT_V1 + +> `const` **MULTI_QA_MPNET_BASE_DOT_V1**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L423) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `MULTI_QA_MPNET_BASE_DOT_V1_MODEL` + +### tokenizerSource + +> **tokenizerSource**: `string` = `MULTI_QA_MPNET_BASE_DOT_V1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md new file mode 100644 index 000000000..19432a174 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -0,0 +1,19 @@ +# Variable: OCR_ABAZA + +> `const` **OCR_ABAZA**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L41) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md new file mode 100644 index 000000000..612cb3fdd --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -0,0 +1,19 @@ +# Variable: OCR_ADYGHE + +> `const` **OCR_ADYGHE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L47) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md new file mode 100644 index 000000000..b55263429 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -0,0 +1,19 @@ +# Variable: OCR_AFRIKAANS + +> `const` **OCR_AFRIKAANS**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L53) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md new file mode 100644 index 000000000..b4f8c606e --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_ALBANIAN + +> `const` **OCR_ALBANIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L362) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md new file mode 100644 index 000000000..3b5a2c9b2 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -0,0 +1,19 @@ +# Variable: OCR_AVAR + +> `const` **OCR_AVAR**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L59) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md new file mode 100644 index 000000000..5609ade93 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -0,0 +1,19 @@ +# Variable: OCR_AZERBAIJANI + +> `const` **OCR_AZERBAIJANI**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L65) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md new file mode 100644 index 000000000..bd907e1d9 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_BELARUSIAN + +> `const` **OCR_BELARUSIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L71) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md new file mode 100644 index 000000000..89990be53 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_BOSNIAN + +> `const` **OCR_BOSNIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L83) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md new file mode 100644 index 000000000..7809e2d94 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_BULGARIAN + +> `const` **OCR_BULGARIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L77) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md new file mode 100644 index 000000000..0005193f7 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -0,0 +1,19 @@ +# Variable: OCR_CHECHEN + +> `const` **OCR_CHECHEN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L98) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md new file mode 100644 index 000000000..1203090e9 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_CROATIAN + +> `const` **OCR_CROATIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L164) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md new file mode 100644 index 000000000..d38799ab0 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -0,0 +1,19 @@ +# Variable: OCR_CZECH + +> `const` **OCR_CZECH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L104) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md new file mode 100644 index 000000000..84fb25d69 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -0,0 +1,19 @@ +# Variable: OCR_DANISH + +> `const` **OCR_DANISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L116) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md new file mode 100644 index 000000000..b142b9603 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -0,0 +1,19 @@ +# Variable: OCR_DARGWA + +> `const` **OCR_DARGWA**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L122) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md new file mode 100644 index 000000000..f0cf7548f --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -0,0 +1,19 @@ +# Variable: OCR_DUTCH + +> `const` **OCR_DUTCH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L284) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md new file mode 100644 index 000000000..da64f54ab --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -0,0 +1,19 @@ +# Variable: OCR_ENGLISH + +> `const` **OCR_ENGLISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L134) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md new file mode 100644 index 000000000..73f0af604 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_ESTONIAN + +> `const` **OCR_ESTONIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L146) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md new file mode 100644 index 000000000..9c615a456 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -0,0 +1,19 @@ +# Variable: OCR_FRENCH + +> `const` **OCR_FRENCH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L152) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md new file mode 100644 index 000000000..01fbd87c8 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_GERMAN + +> `const` **OCR_GERMAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L128) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md new file mode 100644 index 000000000..35416297e --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_HUNGARIAN + +> `const` **OCR_HUNGARIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L170) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md new file mode 100644 index 000000000..1d51204e0 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -0,0 +1,19 @@ +# Variable: OCR_ICELANDIC + +> `const` **OCR_ICELANDIC**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L188) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md new file mode 100644 index 000000000..07e5e0c9b --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_INDONESIAN + +> `const` **OCR_INDONESIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L176) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md new file mode 100644 index 000000000..badae9f4c --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -0,0 +1,19 @@ +# Variable: OCR_INGUSH + +> `const` **OCR_INGUSH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L182) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md new file mode 100644 index 000000000..46fe0baec --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -0,0 +1,19 @@ +# Variable: OCR_IRISH + +> `const` **OCR_IRISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L158) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md new file mode 100644 index 000000000..18ade1d26 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_ITALIAN + +> `const` **OCR_ITALIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L194) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md new file mode 100644 index 000000000..8a1f81faf --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -0,0 +1,19 @@ +# Variable: OCR_JAPANESE + +> `const` **OCR_JAPANESE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L200) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md new file mode 100644 index 000000000..e54f4b053 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -0,0 +1,19 @@ +# Variable: OCR_KANNADA + +> `const` **OCR_KANNADA**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L212) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md new file mode 100644 index 000000000..9b59d25bd --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_KARBADIAN + +> `const` **OCR_KARBADIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L206) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md new file mode 100644 index 000000000..d5aee6e7a --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_KOREAN + +> `const` **OCR_KOREAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L218) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md new file mode 100644 index 000000000..14d6d62ee --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -0,0 +1,19 @@ +# Variable: OCR_KURDISH + +> `const` **OCR_KURDISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L224) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md new file mode 100644 index 000000000..675be6f8e --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -0,0 +1,19 @@ +# Variable: OCR_LAK + +> `const` **OCR_LAK**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L236) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md new file mode 100644 index 000000000..2eb9b4c54 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -0,0 +1,19 @@ +# Variable: OCR_LATIN + +> `const` **OCR_LATIN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L230) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md new file mode 100644 index 000000000..ae8cc195f --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_LATVIAN + +> `const` **OCR_LATVIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L254) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md new file mode 100644 index 000000000..070683b4b --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_LEZGHIAN + +> `const` **OCR_LEZGHIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L242) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md new file mode 100644 index 000000000..17e41a057 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_LITHUANIAN + +> `const` **OCR_LITHUANIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L248) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md new file mode 100644 index 000000000..324a47969 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -0,0 +1,19 @@ +# Variable: OCR_MALAY + +> `const` **OCR_MALAY**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L272) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md new file mode 100644 index 000000000..d92715d08 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -0,0 +1,19 @@ +# Variable: OCR_MALTESE + +> `const` **OCR_MALTESE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L278) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md new file mode 100644 index 000000000..7d53f883e --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -0,0 +1,19 @@ +# Variable: OCR_MAORI + +> `const` **OCR_MAORI**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L260) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md new file mode 100644 index 000000000..36db4d816 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_MONGOLIAN + +> `const` **OCR_MONGOLIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L266) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md new file mode 100644 index 000000000..61569626d --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_NORWEGIAN + +> `const` **OCR_NORWEGIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L290) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md new file mode 100644 index 000000000..bcfacd03b --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_OCCITAN + +> `const` **OCR_OCCITAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L296) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md new file mode 100644 index 000000000..e10e16ca0 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -0,0 +1,19 @@ +# Variable: OCR_PALI + +> `const` **OCR_PALI**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L302) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md new file mode 100644 index 000000000..64d23ba53 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -0,0 +1,19 @@ +# Variable: OCR_POLISH + +> `const` **OCR_POLISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L308) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md new file mode 100644 index 000000000..42757234f --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -0,0 +1,19 @@ +# Variable: OCR_PORTUGUESE + +> `const` **OCR_PORTUGUESE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L314) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md new file mode 100644 index 000000000..befe8032c --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_ROMANIAN + +> `const` **OCR_ROMANIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L320) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md new file mode 100644 index 000000000..592cfd2f9 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_RUSSIAN + +> `const` **OCR_RUSSIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L326) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md new file mode 100644 index 000000000..db3ad8d13 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -0,0 +1,19 @@ +# Variable: OCR_SERBIAN_CYRILLIC + +> `const` **OCR_SERBIAN_CYRILLIC**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L332) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md new file mode 100644 index 000000000..a3c6435cb --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -0,0 +1,19 @@ +# Variable: OCR_SERBIAN_LATIN + +> `const` **OCR_SERBIAN_LATIN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L341) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md new file mode 100644 index 000000000..fa413a1be --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -0,0 +1,19 @@ +# Variable: OCR_SIMPLIFIED_CHINESE + +> `const` **OCR_SIMPLIFIED_CHINESE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L89) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md new file mode 100644 index 000000000..c38302f56 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -0,0 +1,19 @@ +# Variable: OCR_SLOVAK + +> `const` **OCR_SLOVAK**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L350) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md new file mode 100644 index 000000000..388f2c599 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_SLOVENIAN + +> `const` **OCR_SLOVENIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L356) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md new file mode 100644 index 000000000..283311a21 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -0,0 +1,19 @@ +# Variable: OCR_SPANISH + +> `const` **OCR_SPANISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L140) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md new file mode 100644 index 000000000..fe3abc6db --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -0,0 +1,19 @@ +# Variable: OCR_SWAHILI + +> `const` **OCR_SWAHILI**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L374) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md new file mode 100644 index 000000000..c88fb62b1 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -0,0 +1,19 @@ +# Variable: OCR_SWEDISH + +> `const` **OCR_SWEDISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L368) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md new file mode 100644 index 000000000..f2c2dfefe --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_TABASSARAN + +> `const` **OCR_TABASSARAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L380) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md new file mode 100644 index 000000000..01c12a9cb --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -0,0 +1,19 @@ +# Variable: OCR_TAGALOG + +> `const` **OCR_TAGALOG**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L398) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md new file mode 100644 index 000000000..00a08dca7 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -0,0 +1,19 @@ +# Variable: OCR_TAJIK + +> `const` **OCR_TAJIK**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L392) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md new file mode 100644 index 000000000..e94103a10 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -0,0 +1,19 @@ +# Variable: OCR_TELUGU + +> `const` **OCR_TELUGU**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L386) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md new file mode 100644 index 000000000..0bac226b2 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -0,0 +1,19 @@ +# Variable: OCR_TURKISH + +> `const` **OCR_TURKISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L404) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md new file mode 100644 index 000000000..2c135e8d8 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -0,0 +1,19 @@ +# Variable: OCR_UKRAINIAN + +> `const` **OCR_UKRAINIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L410) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md new file mode 100644 index 000000000..b9705bcca --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -0,0 +1,19 @@ +# Variable: OCR_UZBEK + +> `const` **OCR_UZBEK**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L416) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md new file mode 100644 index 000000000..162d48588 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -0,0 +1,19 @@ +# Variable: OCR_VIETNAMESE + +> `const` **OCR_VIETNAMESE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L422) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md new file mode 100644 index 000000000..c5beded26 --- /dev/null +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -0,0 +1,19 @@ +# Variable: OCR_WELSH + +> `const` **OCR_WELSH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L110) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md new file mode 100644 index 000000000..b20a5d86e --- /dev/null +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -0,0 +1,19 @@ +# Variable: PHI_4_MINI_4B + +> `const` **PHI_4_MINI_4B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L242) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `PHI_4_MINI_4B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `PHI_4_MINI_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `PHI_4_MINI_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md new file mode 100644 index 000000000..f5c1e9b01 --- /dev/null +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: PHI_4_MINI_4B_QUANTIZED + +> `const` **PHI_4_MINI_4B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L248) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `PHI_4_MINI_4B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `PHI_4_MINI_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `PHI_4_MINI_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md new file mode 100644 index 000000000..e2330a17d --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -0,0 +1,19 @@ +# Variable: QWEN2_5_0_5B + +> `const` **QWEN2_5_0_5B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L200) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN2_5_0_5B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md new file mode 100644 index 000000000..1d6ba34b1 --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: QWEN2_5_0_5B_QUANTIZED + +> `const` **QWEN2_5_0_5B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L206) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN2_5_0_5B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md new file mode 100644 index 000000000..425dd068f --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -0,0 +1,19 @@ +# Variable: QWEN2_5_1_5B + +> `const` **QWEN2_5_1_5B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L212) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN2_5_1_5B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md new file mode 100644 index 000000000..0bf455e05 --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: QWEN2_5_1_5B_QUANTIZED + +> `const` **QWEN2_5_1_5B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L218) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN2_5_1_5B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md new file mode 100644 index 000000000..d00e3623c --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -0,0 +1,19 @@ +# Variable: QWEN2_5_3B + +> `const` **QWEN2_5_3B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L224) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN2_5_3B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md new file mode 100644 index 000000000..674722c29 --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: QWEN2_5_3B_QUANTIZED + +> `const` **QWEN2_5_3B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L230) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN2_5_3B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN2_5_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN2_5_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md new file mode 100644 index 000000000..f261a2e42 --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -0,0 +1,19 @@ +# Variable: QWEN3_0_6B + +> `const` **QWEN3_0_6B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L62) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN3_0_6B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md new file mode 100644 index 000000000..8cc2b86f2 --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: QWEN3_0_6B_QUANTIZED + +> `const` **QWEN3_0_6B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L68) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN3_0_6B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md new file mode 100644 index 000000000..d0737586d --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -0,0 +1,19 @@ +# Variable: QWEN3_1_7B + +> `const` **QWEN3_1_7B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L74) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN3_1_7B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md new file mode 100644 index 000000000..dda0d7348 --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: QWEN3_1_7B_QUANTIZED + +> `const` **QWEN3_1_7B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L80) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN3_1_7B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md new file mode 100644 index 000000000..3a7449110 --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -0,0 +1,19 @@ +# Variable: QWEN3_4B + +> `const` **QWEN3_4B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L86) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN3_4B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md new file mode 100644 index 000000000..4ebb8999e --- /dev/null +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: QWEN3_4B_QUANTIZED + +> `const` **QWEN3_4B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L92) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `QWEN3_4B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `QWEN3_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `QWEN3_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md new file mode 100644 index 000000000..b2d89140c --- /dev/null +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -0,0 +1,19 @@ +# Variable: SMOLLM2_1_135M + +> `const` **SMOLLM2_1_135M**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L154) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `SMOLLM2_1_135M_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md new file mode 100644 index 000000000..b0427345d --- /dev/null +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: SMOLLM2_1_135M_QUANTIZED + +> `const` **SMOLLM2_1_135M_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L160) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `SMOLLM2_1_135M_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md new file mode 100644 index 000000000..9e2170808 --- /dev/null +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -0,0 +1,19 @@ +# Variable: SMOLLM2_1_1_7B + +> `const` **SMOLLM2_1_1_7B**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L178) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `SMOLLM2_1_1_7B_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md new file mode 100644 index 000000000..58418d3a6 --- /dev/null +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: SMOLLM2_1_1_7B_QUANTIZED + +> `const` **SMOLLM2_1_1_7B_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L184) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `SMOLLM2_1_1_7B_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md new file mode 100644 index 000000000..5fd185cce --- /dev/null +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -0,0 +1,19 @@ +# Variable: SMOLLM2_1_360M + +> `const` **SMOLLM2_1_360M**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L166) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `SMOLLM2_1_360M_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md new file mode 100644 index 000000000..5a11af32e --- /dev/null +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -0,0 +1,19 @@ +# Variable: SMOLLM2_1_360M_QUANTIZED + +> `const` **SMOLLM2_1_360M_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L172) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `SMOLLM2_1_360M_QUANTIZED_MODEL` + +### tokenizerConfigSource + +> **tokenizerConfigSource**: `string` = `SMOLLM2_1_TOKENIZER_CONFIG` + +### tokenizerSource + +> **tokenizerSource**: `string` = `SMOLLM2_1_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md new file mode 100644 index 000000000..1a974e2e2 --- /dev/null +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -0,0 +1,35 @@ +# Variable: SPECIAL_TOKENS + +> `const` **SPECIAL_TOKENS**: `object` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:62](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L62) + +## Type Declaration + +### BOS_TOKEN + +> **BOS_TOKEN**: `string` = `'bos_token'` + +### CLS_TOKEN + +> **CLS_TOKEN**: `string` = `'cls_token'` + +### EOS_TOKEN + +> **EOS_TOKEN**: `string` = `'eos_token'` + +### MASK_TOKEN + +> **MASK_TOKEN**: `string` = `'mask_token'` + +### PAD_TOKEN + +> **PAD_TOKEN**: `string` = `'pad_token'` + +### SEP_TOKEN + +> **SEP_TOKEN**: `string` = `'sep_token'` + +### UNK_TOKEN + +> **UNK_TOKEN**: `string` = `'unk_token'` diff --git a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md new file mode 100644 index 000000000..2e33ac08c --- /dev/null +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -0,0 +1,11 @@ +# Variable: SSDLITE_320_MOBILENET_V3_LARGE + +> `const` **SSDLITE_320_MOBILENET_V3_LARGE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L267) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `SSDLITE_320_MOBILENET_V3_LARGE_MODEL` diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md new file mode 100644 index 000000000..4625a8f01 --- /dev/null +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -0,0 +1,11 @@ +# Variable: STYLE_TRANSFER_CANDY + +> `const` **STYLE_TRANSFER_CANDY**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L289) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `STYLE_TRANSFER_CANDY_MODEL` diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md new file mode 100644 index 000000000..0a616fb29 --- /dev/null +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -0,0 +1,11 @@ +# Variable: STYLE_TRANSFER_MOSAIC + +> `const` **STYLE_TRANSFER_MOSAIC**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L293) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `STYLE_TRANSFER_MOSAIC_MODEL` diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md new file mode 100644 index 000000000..19ef2e565 --- /dev/null +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -0,0 +1,11 @@ +# Variable: STYLE_TRANSFER_RAIN_PRINCESS + +> `const` **STYLE_TRANSFER_RAIN_PRINCESS**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L297) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `STYLE_TRANSFER_RAIN_PRINCESS_MODEL` diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md new file mode 100644 index 000000000..d67da5291 --- /dev/null +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -0,0 +1,11 @@ +# Variable: STYLE_TRANSFER_UDNIE + +> `const` **STYLE_TRANSFER_UDNIE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L301) + +## Type Declaration + +### modelSource + +> **modelSource**: `string` = `STYLE_TRANSFER_UDNIE_MODEL` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md new file mode 100644 index 000000000..f54a7b4bb --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_ABAZA + +> `const` **VERTICAL_OCR_ABAZA**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L42) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md new file mode 100644 index 000000000..b8f1e29d8 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_ADYGHE + +> `const` **VERTICAL_OCR_ADYGHE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L48) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md new file mode 100644 index 000000000..6c75fa636 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_AFRIKAANS + +> `const` **VERTICAL_OCR_AFRIKAANS**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L54) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md new file mode 100644 index 000000000..6edb3e133 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_ALBANIAN + +> `const` **VERTICAL_OCR_ALBANIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L363) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md new file mode 100644 index 000000000..5392ae0b4 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_AVAR + +> `const` **VERTICAL_OCR_AVAR**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L60) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md new file mode 100644 index 000000000..c0d3ba2cf --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_AZERBAIJANI + +> `const` **VERTICAL_OCR_AZERBAIJANI**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L66) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md new file mode 100644 index 000000000..db49b50cb --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_BELARUSIAN + +> `const` **VERTICAL_OCR_BELARUSIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L72) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md new file mode 100644 index 000000000..cbf888e06 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_BOSNIAN + +> `const` **VERTICAL_OCR_BOSNIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L84) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md new file mode 100644 index 000000000..e789c3941 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_BULGARIAN + +> `const` **VERTICAL_OCR_BULGARIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L78) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md new file mode 100644 index 000000000..5c8c900b3 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_CHECHEN + +> `const` **VERTICAL_OCR_CHECHEN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L99) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md new file mode 100644 index 000000000..cf51fcac1 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_CROATIAN + +> `const` **VERTICAL_OCR_CROATIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L165) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md new file mode 100644 index 000000000..d28ce7236 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_CZECH + +> `const` **VERTICAL_OCR_CZECH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L105) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md new file mode 100644 index 000000000..0a912ad38 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_DANISH + +> `const` **VERTICAL_OCR_DANISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L117) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md new file mode 100644 index 000000000..e89fcce22 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_DARGWA + +> `const` **VERTICAL_OCR_DARGWA**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L123) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md new file mode 100644 index 000000000..bfefdec33 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_DUTCH + +> `const` **VERTICAL_OCR_DUTCH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L285) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md new file mode 100644 index 000000000..16bb5f470 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_ENGLISH + +> `const` **VERTICAL_OCR_ENGLISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L135) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md new file mode 100644 index 000000000..3a3a2bdef --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_ESTONIAN + +> `const` **VERTICAL_OCR_ESTONIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L147) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md new file mode 100644 index 000000000..6f3464b75 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_FRENCH + +> `const` **VERTICAL_OCR_FRENCH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L153) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md new file mode 100644 index 000000000..14e94e3ef --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_GERMAN + +> `const` **VERTICAL_OCR_GERMAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L129) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md new file mode 100644 index 000000000..08febc0e4 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_HUNGARIAN + +> `const` **VERTICAL_OCR_HUNGARIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L171) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md new file mode 100644 index 000000000..ba4a62136 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_ICELANDIC + +> `const` **VERTICAL_OCR_ICELANDIC**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L189) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md new file mode 100644 index 000000000..11f54d17f --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_INDONESIAN + +> `const` **VERTICAL_OCR_INDONESIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L177) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md new file mode 100644 index 000000000..fd17893c4 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_INGUSH + +> `const` **VERTICAL_OCR_INGUSH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L183) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md new file mode 100644 index 000000000..3b87245ef --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_IRISH + +> `const` **VERTICAL_OCR_IRISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L159) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md new file mode 100644 index 000000000..3f6908b92 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_ITALIAN + +> `const` **VERTICAL_OCR_ITALIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L195) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md new file mode 100644 index 000000000..7af946618 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_JAPANESE + +> `const` **VERTICAL_OCR_JAPANESE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L201) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md new file mode 100644 index 000000000..6f76491ee --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_KANNADA + +> `const` **VERTICAL_OCR_KANNADA**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L213) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md new file mode 100644 index 000000000..e761e42d3 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_KARBADIAN + +> `const` **VERTICAL_OCR_KARBADIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L207) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md new file mode 100644 index 000000000..7801544b7 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_KOREAN + +> `const` **VERTICAL_OCR_KOREAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L219) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md new file mode 100644 index 000000000..bbd7a68b1 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_KURDISH + +> `const` **VERTICAL_OCR_KURDISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L225) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md new file mode 100644 index 000000000..3d674ce41 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_LAK + +> `const` **VERTICAL_OCR_LAK**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L237) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md new file mode 100644 index 000000000..04ef719dd --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_LATIN + +> `const` **VERTICAL_OCR_LATIN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L231) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md new file mode 100644 index 000000000..d528028f5 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_LATVIAN + +> `const` **VERTICAL_OCR_LATVIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L255) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md new file mode 100644 index 000000000..695bf4df1 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_LEZGHIAN + +> `const` **VERTICAL_OCR_LEZGHIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L243) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md new file mode 100644 index 000000000..5142816d0 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_LITHUANIAN + +> `const` **VERTICAL_OCR_LITHUANIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L249) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md new file mode 100644 index 000000000..ee166a8ba --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_MALAY + +> `const` **VERTICAL_OCR_MALAY**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L273) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md new file mode 100644 index 000000000..d24e32e57 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_MALTESE + +> `const` **VERTICAL_OCR_MALTESE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L279) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md new file mode 100644 index 000000000..6b9678530 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_MAORI + +> `const` **VERTICAL_OCR_MAORI**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L261) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md new file mode 100644 index 000000000..14da0fa2d --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_MONGOLIAN + +> `const` **VERTICAL_OCR_MONGOLIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L267) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md new file mode 100644 index 000000000..44ba693d5 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_NORWEGIAN + +> `const` **VERTICAL_OCR_NORWEGIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L291) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md new file mode 100644 index 000000000..6b4535f58 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_OCCITAN + +> `const` **VERTICAL_OCR_OCCITAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L297) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md new file mode 100644 index 000000000..630dd7586 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_PALI + +> `const` **VERTICAL_OCR_PALI**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L303) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md new file mode 100644 index 000000000..3d61da085 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_POLISH + +> `const` **VERTICAL_OCR_POLISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L309) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md new file mode 100644 index 000000000..647a3e399 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_PORTUGUESE + +> `const` **VERTICAL_OCR_PORTUGUESE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L315) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md new file mode 100644 index 000000000..5cc64d78b --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_ROMANIAN + +> `const` **VERTICAL_OCR_ROMANIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L321) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md new file mode 100644 index 000000000..40e197deb --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_RUSSIAN + +> `const` **VERTICAL_OCR_RUSSIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L327) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md new file mode 100644 index 000000000..e7f9689fb --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_SERBIAN_CYRILLIC + +> `const` **VERTICAL_OCR_SERBIAN_CYRILLIC**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L336) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md new file mode 100644 index 000000000..7935d06be --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_SERBIAN_LATIN + +> `const` **VERTICAL_OCR_SERBIAN_LATIN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L345) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md new file mode 100644 index 000000000..85e1a6608 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_SIMPLIFIED_CHINESE + +> `const` **VERTICAL_OCR_SIMPLIFIED_CHINESE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L93) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md new file mode 100644 index 000000000..754542a83 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_SLOVAK + +> `const` **VERTICAL_OCR_SLOVAK**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L351) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md new file mode 100644 index 000000000..e79d778fb --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_SLOVENIAN + +> `const` **VERTICAL_OCR_SLOVENIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L357) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md new file mode 100644 index 000000000..95413eb2c --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_SPANISH + +> `const` **VERTICAL_OCR_SPANISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L141) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md new file mode 100644 index 000000000..7edb86547 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_SWAHILI + +> `const` **VERTICAL_OCR_SWAHILI**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L375) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md new file mode 100644 index 000000000..76ea9a096 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_SWEDISH + +> `const` **VERTICAL_OCR_SWEDISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L369) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md new file mode 100644 index 000000000..df3bbf53b --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_TABASSARAN + +> `const` **VERTICAL_OCR_TABASSARAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L381) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md new file mode 100644 index 000000000..c42ae0632 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_TAGALOG + +> `const` **VERTICAL_OCR_TAGALOG**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L399) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md new file mode 100644 index 000000000..d5ab025e7 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_TAJIK + +> `const` **VERTICAL_OCR_TAJIK**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L393) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md new file mode 100644 index 000000000..149101021 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_TELUGU + +> `const` **VERTICAL_OCR_TELUGU**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L387) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md new file mode 100644 index 000000000..23ea2671d --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_TURKISH + +> `const` **VERTICAL_OCR_TURKISH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L405) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md new file mode 100644 index 000000000..c3cc9a6f2 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_UKRAINIAN + +> `const` **VERTICAL_OCR_UKRAINIAN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L411) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md new file mode 100644 index 000000000..2a304d606 --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_UZBEK + +> `const` **VERTICAL_OCR_UZBEK**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L417) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md new file mode 100644 index 000000000..83dd8f93c --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_VIETNAMESE + +> `const` **VERTICAL_OCR_VIETNAMESE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L423) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md new file mode 100644 index 000000000..1b38cbc0d --- /dev/null +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md @@ -0,0 +1,19 @@ +# Variable: VERTICAL_OCR_WELSH + +> `const` **VERTICAL_OCR_WELSH**: `object` + +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L111) + +## Type Declaration + +### detectorSource + +> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` + +### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +### recognizerSource + +> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md new file mode 100644 index 000000000..28a69a8d6 --- /dev/null +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -0,0 +1,23 @@ +# Variable: WHISPER_BASE + +> `const` **WHISPER_BASE**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L368) + +## Type Declaration + +### decoderSource + +> **decoderSource**: `string` = `WHISPER_BASE_DECODER_MODEL` + +### encoderSource + +> **encoderSource**: `string` = `WHISPER_BASE_ENCODER_MODEL` + +### isMultilingual + +> **isMultilingual**: `boolean` = `true` + +### tokenizerSource + +> **tokenizerSource**: `string` = `WHISPER_BASE_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md new file mode 100644 index 000000000..a00f77585 --- /dev/null +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -0,0 +1,23 @@ +# Variable: WHISPER_BASE_EN + +> `const` **WHISPER_BASE_EN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L347) + +## Type Declaration + +### decoderSource + +> **decoderSource**: `string` = `WHISPER_BASE_EN_DECODER` + +### encoderSource + +> **encoderSource**: `string` = `WHISPER_BASE_EN_ENCODER` + +### isMultilingual + +> **isMultilingual**: `boolean` = `false` + +### tokenizerSource + +> **tokenizerSource**: `string` = `WHISPER_BASE_EN_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md new file mode 100644 index 000000000..448b32933 --- /dev/null +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -0,0 +1,23 @@ +# Variable: WHISPER_SMALL + +> `const` **WHISPER_SMALL**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L375) + +## Type Declaration + +### decoderSource + +> **decoderSource**: `string` = `WHISPER_SMALL_DECODER_MODEL` + +### encoderSource + +> **encoderSource**: `string` = `WHISPER_SMALL_ENCODER_MODEL` + +### isMultilingual + +> **isMultilingual**: `boolean` = `true` + +### tokenizerSource + +> **tokenizerSource**: `string` = `WHISPER_SMALL_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md new file mode 100644 index 000000000..84e3eefa8 --- /dev/null +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -0,0 +1,23 @@ +# Variable: WHISPER_SMALL_EN + +> `const` **WHISPER_SMALL_EN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L354) + +## Type Declaration + +### decoderSource + +> **decoderSource**: `string` = `WHISPER_SMALL_EN_DECODER` + +### encoderSource + +> **encoderSource**: `string` = `WHISPER_SMALL_EN_ENCODER` + +### isMultilingual + +> **isMultilingual**: `boolean` = `false` + +### tokenizerSource + +> **tokenizerSource**: `string` = `WHISPER_SMALL_EN_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md new file mode 100644 index 000000000..89f94665a --- /dev/null +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -0,0 +1,23 @@ +# Variable: WHISPER_TINY + +> `const` **WHISPER_TINY**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L361) + +## Type Declaration + +### decoderSource + +> **decoderSource**: `string` = `WHISPER_TINY_DECODER_MODEL` + +### encoderSource + +> **encoderSource**: `string` = `WHISPER_TINY_ENCODER_MODEL` + +### isMultilingual + +> **isMultilingual**: `boolean` = `true` + +### tokenizerSource + +> **tokenizerSource**: `string` = `WHISPER_TINY_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md new file mode 100644 index 000000000..cd77d6b78 --- /dev/null +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -0,0 +1,23 @@ +# Variable: WHISPER_TINY_EN + +> `const` **WHISPER_TINY_EN**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L333) + +## Type Declaration + +### decoderSource + +> **decoderSource**: `string` = `WHISPER_TINY_EN_DECODER` + +### encoderSource + +> **encoderSource**: `string` = `WHISPER_TINY_EN_ENCODER` + +### isMultilingual + +> **isMultilingual**: `boolean` = `false` + +### tokenizerSource + +> **tokenizerSource**: `string` = `WHISPER_TINY_EN_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md new file mode 100644 index 000000000..069484681 --- /dev/null +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -0,0 +1,23 @@ +# Variable: WHISPER_TINY_EN_QUANTIZED + +> `const` **WHISPER_TINY_EN_QUANTIZED**: `object` + +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L340) + +## Type Declaration + +### decoderSource + +> **decoderSource**: `string` = `WHISPER_TINY_EN_DECODER_QUANTIZED` + +### encoderSource + +> **encoderSource**: `string` = `WHISPER_TINY_EN_ENCODER_QUANTIZED` + +### isMultilingual + +> **isMultilingual**: `boolean` = `false` + +### tokenizerSource + +> **tokenizerSource**: `string` = `WHISPER_TINY_EN_TOKENIZER` diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md new file mode 100644 index 000000000..0b27f39aa --- /dev/null +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -0,0 +1,15 @@ +# Variable: parseToolCall() + +> `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] + +Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/llm.ts#L9) + +## Parameters + +### message + +`string` + +## Returns + +[`ToolCall`](../interfaces/ToolCall.md)[] diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index d4c15ddf2..66314c245 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -60,7 +60,7 @@ const config = { // 2. Point to the specific tsconfig inside that package tsconfig: '../packages/react-native-executorch/tsconfig.doc.json', - out: './docs/api', + out: './docs/06-api-reference', // Remove invalid 'sidebar' option (v4+) // sidebar: { ... } diff --git a/docs/sidebars.js b/docs/sidebars.js index 190c0a67f..9199fa33c 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -44,20 +44,39 @@ const sidebars = { // --------------------------------------------------------- // 2. The New Clean API Section // --------------------------------------------------------- + // { + // type: 'category', + // label: 'API Reference', + // collapsible: false, + // collapsed: false, + // link: { + // type: 'doc', + // id: 'api-reference/index', // This links to the page containing Classes/Enums list + // }, + // // LEAVE THIS EMPTY. + // // Instead of listing 100 files in the sidebar, we let the user + // // click "API Reference" and use the Table of Contents (Right Sidebar) + // // to jump to Classes, Enums, etc. + // items: [], + // }, + { type: 'category', label: 'API Reference', - collapsible: false, - collapsed: false, - link: { - type: 'doc', - id: 'api/index', // This links to the page containing Classes/Enums list - }, - // LEAVE THIS EMPTY. - // Instead of listing 100 files in the sidebar, we let the user - // click "API Reference" and use the Table of Contents (Right Sidebar) - // to jump to Classes, Enums, etc. - items: [], + collapsible: false, // Allows expanding/collapsing + collapsed: false, // Open by default + + // 1. REMOVE the 'link' property from here. + // This makes the "API Reference" label just a section header, not a link. + + items: [ + // 2. ADD the link here as a child item + { + type: 'doc', + id: 'api-reference/index', + label: 'API Reference', // Optional: Rename it to "Overview" or "Introduction" to avoid repetition + }, + ], }, // { type: 'autogenerated', dirName: '.' }, // { diff --git a/packages/react-native-executorch/tsconfig.doc.json b/packages/react-native-executorch/tsconfig.doc.json new file mode 100644 index 000000000..6104102d0 --- /dev/null +++ b/packages/react-native-executorch/tsconfig.doc.json @@ -0,0 +1,9 @@ +{ + "extends": "./tsconfig.json", + "include": ["src/**/*"], + "compilerOptions": { + "noEmit": true, + "skipLibCheck": true, + "jsx": "react" + } +} From 6ec733db79e7beab4f9c88b6ff7fe73bdc6fb7c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Thu, 22 Jan 2026 22:50:04 +0100 Subject: [PATCH 03/15] Add support for automatic documentation for the first few hooks --- .../classes/ClassificationModule.md | 14 +- .../classes/ExecutorchModule.md | 14 +- .../classes/ImageEmbeddingsModule.md | 14 +- .../classes/ImageSegmentationModule.md | 14 +- .../06-api-reference/classes/LLMModule.md | 24 +-- .../06-api-reference/classes/OCRModule.md | 10 +- .../classes/ObjectDetectionModule.md | 14 +- .../classes/ResourceFetcher.md | 20 +-- .../classes/RnExecutorchError.md | 12 +- .../classes/SpeechToTextModule.md | 28 +++- .../classes/StyleTransferModule.md | 14 +- .../classes/TextEmbeddingsModule.md | 14 +- .../classes/TextToImageModule.md | 18 +- .../classes/TokenizerModule.md | 16 +- .../06-api-reference/classes/VADModule.md | 14 +- .../classes/VerticalOCRModule.md | 10 +- .../enumerations/DeeplabLabel.md | 46 +++--- .../enumerations/RnExecutorchErrorCode.md | 86 +++++----- .../enumerations/ScalarType.md | 48 +++--- .../DEFAULT_STRUCTURED_OUTPUT_PROMPT.md | 2 +- .../fixAndValidateStructuredOutput.md | 2 +- .../functions/getStructuredOutputPrompt.md | 2 +- .../functions/useClassification.md | 18 +- .../functions/useExecutorchModule.md | 18 +- .../functions/useImageEmbeddings.md | 18 +- .../functions/useImageSegmentation.md | 18 +- .../docs/06-api-reference/functions/useLLM.md | 20 ++- .../docs/06-api-reference/functions/useOCR.md | 2 +- .../functions/useObjectDetection.md | 18 +- .../functions/useSpeechToText.md | 48 +++++- .../functions/useStyleTransfer.md | 18 +- .../functions/useTextEmbeddings.md | 26 ++- .../functions/useTextToImage.md | 2 +- .../functions/useTextToSpeech.md | 2 +- .../functions/useTokenizer.md | 2 +- .../docs/06-api-reference/functions/useVAD.md | 18 +- .../functions/useVerticalOCR.md | 2 +- docs/docs/06-api-reference/index.md | 1 + docs/docs/06-api-reference/interfaces/Bbox.md | 10 +- .../06-api-reference/interfaces/ChatConfig.md | 16 +- .../interfaces/DecodingOptions.md | 4 +- .../06-api-reference/interfaces/Detection.md | 8 +- .../interfaces/GenerationConfig.md | 20 ++- .../06-api-reference/interfaces/LLMType.md | 100 ++++++++++-- .../06-api-reference/interfaces/Message.md | 12 +- .../06-api-reference/interfaces/OCRBbox.md | 6 +- .../interfaces/OCRDetection.md | 8 +- .../docs/06-api-reference/interfaces/Props.md | 35 ++++ .../06-api-reference/interfaces/Segment.md | 6 +- .../interfaces/SpeechToTextModelConfig.md | 10 +- .../06-api-reference/interfaces/TensorPtr.md | 8 +- .../06-api-reference/interfaces/ToolCall.md | 6 +- .../interfaces/ToolsConfig.md | 16 +- .../06-api-reference/type-aliases/LLMTool.md | 2 +- .../type-aliases/MessageRole.md | 4 +- .../type-aliases/OCRLanguage.md | 2 +- .../type-aliases/ResourceSource.md | 4 +- .../type-aliases/SpeechToTextLanguage.md | 2 +- .../type-aliases/TensorBuffer.md | 2 +- .../docs/06-api-reference/typedoc-sidebar.cjs | 2 +- .../variables/ALL_MINILM_L6_V2.md | 2 +- .../variables/ALL_MPNET_BASE_V2.md | 2 +- .../variables/BK_SDM_TINY_VPRED_256.md | 2 +- .../variables/BK_SDM_TINY_VPRED_512.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 2 +- .../variables/DEEPLAB_V3_RESNET50.md | 2 +- .../variables/DEFAULT_CHAT_CONFIG.md | 2 +- .../DEFAULT_CONTEXT_WINDOW_LENGTH.md | 2 +- .../variables/DEFAULT_MESSAGE_HISTORY.md | 2 +- .../variables/DEFAULT_SYSTEM_PROMPT.md | 2 +- .../variables/EFFICIENTNET_V2_S.md | 2 +- .../06-api-reference/variables/FSMN_VAD.md | 2 +- .../variables/HAMMER2_1_0_5B.md | 2 +- .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_1_5B.md | 2 +- .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_3B.md | 2 +- .../variables/HAMMER2_1_3B_QUANTIZED.md | 2 +- .../06-api-reference/variables/KOKORO_EN.md | 2 +- .../variables/KOKORO_VOICE_AF_HEART.md | 2 +- .../variables/KOKORO_VOICE_AF_RIVER.md | 2 +- .../variables/KOKORO_VOICE_AF_SARAH.md | 2 +- .../variables/KOKORO_VOICE_AM_ADAM.md | 2 +- .../variables/KOKORO_VOICE_AM_MICHAEL.md | 2 +- .../variables/KOKORO_VOICE_AM_SANTA.md | 2 +- .../variables/KOKORO_VOICE_BF_EMMA.md | 2 +- .../variables/KOKORO_VOICE_BM_DANIEL.md | 2 +- .../06-api-reference/variables/LLAMA3_2_1B.md | 2 +- .../variables/LLAMA3_2_1B_QLORA.md | 2 +- .../variables/LLAMA3_2_1B_SPINQUANT.md | 2 +- .../06-api-reference/variables/LLAMA3_2_3B.md | 2 +- .../variables/LLAMA3_2_3B_QLORA.md | 2 +- .../variables/LLAMA3_2_3B_SPINQUANT.md | 2 +- .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 2 +- .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 2 +- .../06-api-reference/variables/OCR_ABAZA.md | 2 +- .../06-api-reference/variables/OCR_ADYGHE.md | 2 +- .../variables/OCR_AFRIKAANS.md | 2 +- .../variables/OCR_ALBANIAN.md | 2 +- .../06-api-reference/variables/OCR_AVAR.md | 2 +- .../variables/OCR_AZERBAIJANI.md | 2 +- .../variables/OCR_BELARUSIAN.md | 2 +- .../06-api-reference/variables/OCR_BOSNIAN.md | 2 +- .../variables/OCR_BULGARIAN.md | 2 +- .../06-api-reference/variables/OCR_CHECHEN.md | 2 +- .../variables/OCR_CROATIAN.md | 2 +- .../06-api-reference/variables/OCR_CZECH.md | 2 +- .../06-api-reference/variables/OCR_DANISH.md | 2 +- .../06-api-reference/variables/OCR_DARGWA.md | 2 +- .../06-api-reference/variables/OCR_DUTCH.md | 2 +- .../06-api-reference/variables/OCR_ENGLISH.md | 2 +- .../variables/OCR_ESTONIAN.md | 2 +- .../06-api-reference/variables/OCR_FRENCH.md | 2 +- .../06-api-reference/variables/OCR_GERMAN.md | 2 +- .../variables/OCR_HUNGARIAN.md | 2 +- .../variables/OCR_ICELANDIC.md | 2 +- .../variables/OCR_INDONESIAN.md | 2 +- .../06-api-reference/variables/OCR_INGUSH.md | 2 +- .../06-api-reference/variables/OCR_IRISH.md | 2 +- .../06-api-reference/variables/OCR_ITALIAN.md | 2 +- .../variables/OCR_JAPANESE.md | 2 +- .../06-api-reference/variables/OCR_KANNADA.md | 2 +- .../variables/OCR_KARBADIAN.md | 2 +- .../06-api-reference/variables/OCR_KOREAN.md | 2 +- .../06-api-reference/variables/OCR_KURDISH.md | 2 +- .../06-api-reference/variables/OCR_LAK.md | 2 +- .../06-api-reference/variables/OCR_LATIN.md | 2 +- .../06-api-reference/variables/OCR_LATVIAN.md | 2 +- .../variables/OCR_LEZGHIAN.md | 2 +- .../variables/OCR_LITHUANIAN.md | 2 +- .../06-api-reference/variables/OCR_MALAY.md | 2 +- .../06-api-reference/variables/OCR_MALTESE.md | 2 +- .../06-api-reference/variables/OCR_MAORI.md | 2 +- .../variables/OCR_MONGOLIAN.md | 2 +- .../variables/OCR_NORWEGIAN.md | 2 +- .../06-api-reference/variables/OCR_OCCITAN.md | 2 +- .../06-api-reference/variables/OCR_PALI.md | 2 +- .../06-api-reference/variables/OCR_POLISH.md | 2 +- .../variables/OCR_PORTUGUESE.md | 2 +- .../variables/OCR_ROMANIAN.md | 2 +- .../06-api-reference/variables/OCR_RUSSIAN.md | 2 +- .../variables/OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/OCR_SERBIAN_LATIN.md | 2 +- .../variables/OCR_SIMPLIFIED_CHINESE.md | 2 +- .../06-api-reference/variables/OCR_SLOVAK.md | 2 +- .../variables/OCR_SLOVENIAN.md | 2 +- .../06-api-reference/variables/OCR_SPANISH.md | 2 +- .../06-api-reference/variables/OCR_SWAHILI.md | 2 +- .../06-api-reference/variables/OCR_SWEDISH.md | 2 +- .../variables/OCR_TABASSARAN.md | 2 +- .../06-api-reference/variables/OCR_TAGALOG.md | 2 +- .../06-api-reference/variables/OCR_TAJIK.md | 2 +- .../06-api-reference/variables/OCR_TELUGU.md | 2 +- .../06-api-reference/variables/OCR_TURKISH.md | 2 +- .../variables/OCR_UKRAINIAN.md | 2 +- .../06-api-reference/variables/OCR_UZBEK.md | 2 +- .../variables/OCR_VIETNAMESE.md | 2 +- .../06-api-reference/variables/OCR_WELSH.md | 2 +- .../variables/PHI_4_MINI_4B.md | 2 +- .../variables/PHI_4_MINI_4B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_0_5B.md | 2 +- .../variables/QWEN2_5_0_5B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_1_5B.md | 2 +- .../variables/QWEN2_5_1_5B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN2_5_3B.md | 2 +- .../variables/QWEN2_5_3B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_0_6B.md | 2 +- .../variables/QWEN3_0_6B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_1_7B.md | 2 +- .../variables/QWEN3_1_7B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_4B.md | 2 +- .../variables/QWEN3_4B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_135M.md | 2 +- .../variables/SMOLLM2_1_135M_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_1_7B.md | 2 +- .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_360M.md | 2 +- .../variables/SMOLLM2_1_360M_QUANTIZED.md | 2 +- .../variables/SPECIAL_TOKENS.md | 2 +- .../SSDLITE_320_MOBILENET_V3_LARGE.md | 2 +- .../variables/STYLE_TRANSFER_CANDY.md | 2 +- .../variables/STYLE_TRANSFER_MOSAIC.md | 2 +- .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 2 +- .../variables/STYLE_TRANSFER_UDNIE.md | 2 +- .../variables/VERTICAL_OCR_ABAZA.md | 2 +- .../variables/VERTICAL_OCR_ADYGHE.md | 2 +- .../variables/VERTICAL_OCR_AFRIKAANS.md | 2 +- .../variables/VERTICAL_OCR_ALBANIAN.md | 2 +- .../variables/VERTICAL_OCR_AVAR.md | 2 +- .../variables/VERTICAL_OCR_AZERBAIJANI.md | 2 +- .../variables/VERTICAL_OCR_BELARUSIAN.md | 2 +- .../variables/VERTICAL_OCR_BOSNIAN.md | 2 +- .../variables/VERTICAL_OCR_BULGARIAN.md | 2 +- .../variables/VERTICAL_OCR_CHECHEN.md | 2 +- .../variables/VERTICAL_OCR_CROATIAN.md | 2 +- .../variables/VERTICAL_OCR_CZECH.md | 2 +- .../variables/VERTICAL_OCR_DANISH.md | 2 +- .../variables/VERTICAL_OCR_DARGWA.md | 2 +- .../variables/VERTICAL_OCR_DUTCH.md | 2 +- .../variables/VERTICAL_OCR_ENGLISH.md | 2 +- .../variables/VERTICAL_OCR_ESTONIAN.md | 2 +- .../variables/VERTICAL_OCR_FRENCH.md | 2 +- .../variables/VERTICAL_OCR_GERMAN.md | 2 +- .../variables/VERTICAL_OCR_HUNGARIAN.md | 2 +- .../variables/VERTICAL_OCR_ICELANDIC.md | 2 +- .../variables/VERTICAL_OCR_INDONESIAN.md | 2 +- .../variables/VERTICAL_OCR_INGUSH.md | 2 +- .../variables/VERTICAL_OCR_IRISH.md | 2 +- .../variables/VERTICAL_OCR_ITALIAN.md | 2 +- .../variables/VERTICAL_OCR_JAPANESE.md | 2 +- .../variables/VERTICAL_OCR_KANNADA.md | 2 +- .../variables/VERTICAL_OCR_KARBADIAN.md | 2 +- .../variables/VERTICAL_OCR_KOREAN.md | 2 +- .../variables/VERTICAL_OCR_KURDISH.md | 2 +- .../variables/VERTICAL_OCR_LAK.md | 2 +- .../variables/VERTICAL_OCR_LATIN.md | 2 +- .../variables/VERTICAL_OCR_LATVIAN.md | 2 +- .../variables/VERTICAL_OCR_LEZGHIAN.md | 2 +- .../variables/VERTICAL_OCR_LITHUANIAN.md | 2 +- .../variables/VERTICAL_OCR_MALAY.md | 2 +- .../variables/VERTICAL_OCR_MALTESE.md | 2 +- .../variables/VERTICAL_OCR_MAORI.md | 2 +- .../variables/VERTICAL_OCR_MONGOLIAN.md | 2 +- .../variables/VERTICAL_OCR_NORWEGIAN.md | 2 +- .../variables/VERTICAL_OCR_OCCITAN.md | 2 +- .../variables/VERTICAL_OCR_PALI.md | 2 +- .../variables/VERTICAL_OCR_POLISH.md | 2 +- .../variables/VERTICAL_OCR_PORTUGUESE.md | 2 +- .../variables/VERTICAL_OCR_ROMANIAN.md | 2 +- .../variables/VERTICAL_OCR_RUSSIAN.md | 2 +- .../VERTICAL_OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/VERTICAL_OCR_SERBIAN_LATIN.md | 2 +- .../VERTICAL_OCR_SIMPLIFIED_CHINESE.md | 2 +- .../variables/VERTICAL_OCR_SLOVAK.md | 2 +- .../variables/VERTICAL_OCR_SLOVENIAN.md | 2 +- .../variables/VERTICAL_OCR_SPANISH.md | 2 +- .../variables/VERTICAL_OCR_SWAHILI.md | 2 +- .../variables/VERTICAL_OCR_SWEDISH.md | 2 +- .../variables/VERTICAL_OCR_TABASSARAN.md | 2 +- .../variables/VERTICAL_OCR_TAGALOG.md | 2 +- .../variables/VERTICAL_OCR_TAJIK.md | 2 +- .../variables/VERTICAL_OCR_TELUGU.md | 2 +- .../variables/VERTICAL_OCR_TURKISH.md | 2 +- .../variables/VERTICAL_OCR_UKRAINIAN.md | 2 +- .../variables/VERTICAL_OCR_UZBEK.md | 2 +- .../variables/VERTICAL_OCR_VIETNAMESE.md | 2 +- .../variables/VERTICAL_OCR_WELSH.md | 2 +- .../variables/WHISPER_BASE.md | 2 +- .../variables/WHISPER_BASE_EN.md | 2 +- .../variables/WHISPER_SMALL.md | 2 +- .../variables/WHISPER_SMALL_EN.md | 2 +- .../variables/WHISPER_TINY.md | 2 +- .../variables/WHISPER_TINY_EN.md | 2 +- .../variables/WHISPER_TINY_EN_QUANTIZED.md | 2 +- .../variables/parseToolCall.md | 2 +- .../src/errors/errorUtils.ts | 18 ++ .../natural_language_processing/useLLM.ts | 21 ++- .../useSpeechToText.ts | 69 ++++++++ .../useTextEmbeddings.ts | 21 ++- .../src/hooks/useModule.ts | 22 +++ .../SpeechToTextModule.ts | 14 ++ .../src/types/common.ts | 10 ++ .../react-native-executorch/src/types/llm.ts | 154 ++++++++++++++++++ 264 files changed, 1151 insertions(+), 520 deletions(-) create mode 100644 docs/docs/06-api-reference/interfaces/Props.md diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index 9685d2676..9c6c9b9af 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,6 @@ # Class: ClassificationModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Classi > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Classi > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index 40d068b4d..30aae9ab0 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -1,6 +1,6 @@ # Class: ExecutorchModule -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L26) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md index b25edabfd..60d4d5307 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: ImageEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageE > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageE > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md index 5008a394e..f7119293b 100644 --- a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -1,6 +1,6 @@ # Class: ImageSegmentationModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageS > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) #### Parameters @@ -80,7 +80,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageS > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -128,7 +128,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md index 9faf44cd5..297065665 100644 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -1,6 +1,6 @@ # Class: LLMModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L11) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L11) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **new LLMModule**(`__namedParameters`): `LLMModule` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **configure**(`__namedParameters`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L52) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L52) #### Parameters @@ -64,7 +64,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:92](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L92) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:92](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L92) #### Returns @@ -76,7 +76,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:79](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L79) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:79](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L79) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **forward**(`input`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L64) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L64) #### Parameters @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **generate**(`messages`, `tools?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L69) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L69) #### Parameters @@ -134,7 +134,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **getGeneratedTokenCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) #### Returns @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:84](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L84) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:84](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L84) #### Returns @@ -158,7 +158,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L30) #### Parameters @@ -190,7 +190,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) #### Parameters @@ -208,7 +208,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **setTokenCallback**(`__namedParameters`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L44) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L44) #### Parameters diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md index ab409ae99..a31c51a4e 100644 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -1,6 +1,6 @@ # Class: OCRModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRMod > **new OCRModule**(): `OCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRMod > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRMod > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRMod > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index 638298c36..6cf8c8479 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -1,6 +1,6 @@ # Class: ObjectDetectionModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Object > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Object > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -124,7 +124,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md index 5373127c9..96f4bc582 100644 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -1,6 +1,6 @@ # Class: ResourceFetcher -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](h > `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](h > `static` **cancelFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251]( > `static` **deleteResources**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278]( > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](h > `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290]( > `static` **listDownloadedFiles**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) #### Returns @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268]( > `static` **listDownloadedModels**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) #### Returns @@ -126,7 +126,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273]( > `static` **pauseFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) #### Parameters @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241]( > `static` **resumeFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) #### Parameters diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md index fdfc74a32..498f943cc 100644 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -1,6 +1,6 @@ # Class: RnExecutorchError -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/errorUtils.ts#L3) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/errorUtils.ts#L3) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https: > **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/errorUtils.ts#L7) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/errorUtils.ts#L14) #### Parameters @@ -42,7 +42,9 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https: > `optional` **cause**: `unknown` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/errorUtils.ts#L5) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/errorUtils.ts#L12) + +The original cause of the error, if any. #### Overrides @@ -54,7 +56,9 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:5](https: > **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/errorUtils.ts#L4) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/errorUtils.ts#L7) + +The error code representing the type of error. --- diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md index db2b5bffc..ff834692d 100644 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -1,6 +1,6 @@ # Class: SpeechToTextModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L7) ## Constructors @@ -18,29 +18,37 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:67](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L67) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L74) + +Runs the decoder of the model. Passing number[] is deprecated. #### Parameters ##### tokens +The input tokens. + `number`[] | `Int32Array`\<`ArrayBufferLike`\> ##### encoderOutput +The encoder output. + `number`[] | `Float32Array`\<`ArrayBufferLike`\> #### Returns `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> +Decoded output. + --- ### delete() > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L51) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L51) #### Returns @@ -52,7 +60,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L55) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L55) #### Parameters @@ -70,7 +78,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L17) #### Parameters @@ -92,7 +100,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **stream**(`options`): `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:113](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L113) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:121](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L121) #### Parameters @@ -110,7 +118,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:168](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L168) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:176](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L176) #### Parameters @@ -128,7 +136,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:178](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L178) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:186](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L186) #### Returns @@ -140,7 +148,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **transcribe**(`waveform`, `options`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:94](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L94) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:102](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L102) Transcribes audio using the Whisper model. @@ -156,6 +164,8 @@ The Float32Array audio data. [`DecodingOptions`](../interfaces/DecodingOptions.md) = `{}` +Decoding options including language. + #### Returns `Promise`\<`string`\> diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index 2144dd68b..4ac103def 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,6 @@ # Class: StyleTransferModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleT > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleT > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index 71cbb8f5e..505508afe 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: TextEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L35) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L35) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index 046f911d5..461441771 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -1,6 +1,6 @@ # Class: TextToImageModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextTo > **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) #### Parameters @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextTo > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -62,7 +62,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) #### Parameters @@ -92,7 +92,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextTo > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -140,7 +140,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) #### Returns @@ -152,7 +152,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextTo > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md index 077747345..807e131f5 100644 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -1,6 +1,6 @@ # Class: TokenizerModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **nativeModule**: `any` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L7) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L31) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L31) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **encode**(`s`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L27) #### Parameters @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L38) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L38) #### Returns @@ -78,7 +78,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **idToToken**(`tokenId`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L42) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L42) #### Parameters @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L9) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L46) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L46) #### Parameters diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index 7082b0829..4410ad91f 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -1,6 +1,6 @@ # Class: VADModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L26) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md index 9672d8410..cf6c8de6a 100644 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -1,6 +1,6 @@ # Class: VerticalOCRModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Vertic > **new VerticalOCRModule**(): `VerticalOCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Vertic > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Vertic > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Vertic > **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md index 5db27ec99..7b94664e3 100644 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -1,6 +1,6 @@ # Enumeration: DeeplabLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L2) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L2) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2]( > **AEROPLANE**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L4) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L4) --- @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4]( > **ARGMAX**: `21` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) --- @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24] > **BACKGROUND**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L3) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L3) --- @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3]( > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) --- @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5]( > **BIRD**: `3` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) --- @@ -48,7 +48,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6]( > **BOAT**: `4` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) --- @@ -56,7 +56,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7]( > **BOTTLE**: `5` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) --- @@ -64,7 +64,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8]( > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) --- @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9]( > **CAR**: `7` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) --- @@ -80,7 +80,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10] > **CAT**: `8` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) --- @@ -88,7 +88,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11] > **CHAIR**: `9` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) --- @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12] > **COW**: `10` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) --- @@ -104,7 +104,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13] > **DININGTABLE**: `11` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) --- @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14] > **DOG**: `12` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) --- @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15] > **HORSE**: `13` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) --- @@ -128,7 +128,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16] > **MOTORBIKE**: `14` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) --- @@ -136,7 +136,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17] > **PERSON**: `15` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) --- @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18] > **POTTEDPLANT**: `16` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) --- @@ -152,7 +152,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19] > **SHEEP**: `17` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) --- @@ -160,7 +160,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20] > **SOFA**: `18` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) --- @@ -168,7 +168,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21] > **TRAIN**: `19` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) --- @@ -176,4 +176,4 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22] > **TVMONITOR**: `20` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md index 99870edbc..43d96983b 100644 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -1,6 +1,6 @@ # Enumeration: RnExecutorchErrorCode -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https: > **AccessFailed**: `34` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) --- @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](http > **DelegateInvalidCompatibility**: `48` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) --- @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](http > **DelegateInvalidHandle**: `50` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) --- @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](http > **DelegateMemoryAllocationFailed**: `49` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) --- @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](http > **DownloadInterrupted**: `118` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) Thrown when the number of downloaded files is unexpected, due to download interruptions. @@ -50,7 +50,7 @@ Thrown when the number of downloaded files is unexpected, due to download interr > **EndOfMethod**: `3` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) --- @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](http > **FileReadFailed**: `114` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. @@ -68,7 +68,7 @@ Thrown when a file read operation failed. This could be invalid image url passed > **FileWriteFailed**: `103` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) An error ocurred when saving a file. This could be, for instance a result image from an image model. @@ -78,7 +78,7 @@ An error ocurred when saving a file. This could be, for instance a result image > **Internal**: `1` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) --- @@ -86,7 +86,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](http > **InvalidArgument**: `18` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) --- @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](http > **InvalidConfig**: `112` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. @@ -104,7 +104,7 @@ Thrown when config parameters passed to a model are invalid. For example, when L > **InvalidExternalData**: `36` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) --- @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](http > **InvalidModelOutput**: `115` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) Thrown when the size of model output is unexpected. @@ -122,7 +122,7 @@ Thrown when the size of model output is unexpected. > **InvalidModelSource**: `255` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) Thrown when the type of model source passed by the user is invalid. @@ -132,7 +132,7 @@ Thrown when the type of model source passed by the user is invalid. > **InvalidProgram**: `35` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) --- @@ -140,7 +140,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](http > **InvalidState**: `2` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) --- @@ -148,7 +148,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](http > **InvalidType**: `19` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) --- @@ -156,7 +156,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](http > **InvalidUserInput**: `117` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). @@ -166,7 +166,7 @@ Thrown when the input passed to our APIs is invalid, for example when passing an > **LanguageNotSupported**: `105` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. @@ -176,7 +176,7 @@ Thrown when a language is passed to a multi-language model that is not supported > **MemoryAllocationFailed**: `33` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) --- @@ -184,7 +184,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](http > **MissingDataChunk**: `161` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) Thrown when streaming transcription is attempted but audio data chunk is missing. @@ -194,7 +194,7 @@ Thrown when streaming transcription is attempted but audio data chunk is missing > **ModelGenerating**: `104` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. @@ -204,7 +204,7 @@ Thrown when a user tries to run a model that is currently processing. It is only > **ModuleNotLoaded**: `102` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. @@ -214,7 +214,7 @@ Thrown when a user tries to run a model that is not yet downloaded or loaded int > **MultilingualConfiguration**: `160` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. @@ -224,7 +224,7 @@ Thrown when there's a configuration mismatch between multilingual and language s > **NotFound**: `32` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) --- @@ -232,7 +232,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](http > **NotImplemented**: `17` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) --- @@ -240,7 +240,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](http > **NotSupported**: `16` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) --- @@ -248,7 +248,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](http > **Ok**: `0` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) --- @@ -256,7 +256,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](http > **OperatorMissing**: `20` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) --- @@ -264,7 +264,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](http > **OutOfResources**: `37` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) --- @@ -272,7 +272,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](http > **ResourceFetcherAlreadyOngoing**: `183` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) Thrown when trying to resume a download that is already ongoing. @@ -282,7 +282,7 @@ Thrown when trying to resume a download that is already ongoing. > **ResourceFetcherAlreadyPaused**: `182` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) Thrown when trying to pause a download that is already paused. @@ -292,7 +292,7 @@ Thrown when trying to pause a download that is already paused. > **ResourceFetcherDownloadFailed**: `180` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. @@ -302,7 +302,7 @@ Thrown when a resource fails to download. This could be due to invalid URL, or f > **ResourceFetcherDownloadInProgress**: `181` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) Thrown when a user tries to trigger a download that's already in progress. @@ -312,7 +312,7 @@ Thrown when a user tries to trigger a download that's already in progress. > **ResourceFetcherMissingUri**: `185` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) Thrown when required URI information is missing for a download operation. @@ -322,7 +322,7 @@ Thrown when required URI information is missing for a download operation. > **ResourceFetcherNotActive**: `184` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) Thrown when trying to pause, resume, or cancel a download that is not active. @@ -332,7 +332,7 @@ Thrown when trying to pause, resume, or cancel a download that is not active. > **StreamingInProgress**: `163` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) Thrown when trying to start a new streaming session while another is already in progress. @@ -342,7 +342,7 @@ Thrown when trying to start a new streaming session while another is already in > **StreamingNotStarted**: `162` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) Thrown when trying to stop or insert data into a stream that hasn't been started. @@ -352,7 +352,7 @@ Thrown when trying to stop or insert data into a stream that hasn't been started > **ThreadPoolError**: `113` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) Thrown when React Native ExecuTorch threadpool problem occurs. @@ -362,7 +362,7 @@ Thrown when React Native ExecuTorch threadpool problem occurs. > **UnexpectedNumInputs**: `97` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) Thrown when the number of passed inputs to the model is different than the model metadata specifies. @@ -372,7 +372,7 @@ Thrown when the number of passed inputs to the model is different than the model > **UnknownError**: `101` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. @@ -382,6 +382,6 @@ An umbrella-error that is thrown usually when something unexpected happens, for > **WrongDimensions**: `116` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md index e72113aee..8061a7e82 100644 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -1,6 +1,8 @@ # Enumeration: ScalarType -Defined in: [packages/react-native-executorch/src/types/common.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L3) +Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L13) + +Enum representing the scalar types of tensors. ## Enumeration Members @@ -8,7 +10,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:3](https://git > **BITS16**: `22` -Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L18) +Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L28) --- @@ -16,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://gi > **BOOL**: `11` -Defined in: [packages/react-native-executorch/src/types/common.ts:12](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L12) +Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L22) --- @@ -24,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:12](https://gi > **BYTE**: `0` -Defined in: [packages/react-native-executorch/src/types/common.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L4) +Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L14) --- @@ -32,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:4](https://git > **CHAR**: `1` -Defined in: [packages/react-native-executorch/src/types/common.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L5) +Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L15) --- @@ -40,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:5](https://git > **DOUBLE**: `7` -Defined in: [packages/react-native-executorch/src/types/common.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L11) +Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L21) --- @@ -48,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:11](https://gi > **FLOAT**: `6` -Defined in: [packages/react-native-executorch/src/types/common.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L10) +Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L20) --- @@ -56,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:10](https://gi > **FLOAT8E4M3FN**: `24` -Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L20) +Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L30) --- @@ -64,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://gi > **FLOAT8E4M3FNUZ**: `26` -Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L22) +Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L32) --- @@ -72,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://gi > **FLOAT8E5M2**: `23` -Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L19) +Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L29) --- @@ -80,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://gi > **FLOAT8E5M2FNUZ**: `25` -Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L21) +Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L31) --- @@ -88,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://gi > **HALF**: `5` -Defined in: [packages/react-native-executorch/src/types/common.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L9) +Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L19) --- @@ -96,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:9](https://git > **INT**: `3` -Defined in: [packages/react-native-executorch/src/types/common.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L7) +Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L17) --- @@ -104,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:7](https://git > **LONG**: `4` -Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L8) +Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L18) --- @@ -112,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://git > **QINT32**: `14` -Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L15) +Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L25) --- @@ -120,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://gi > **QINT8**: `12` -Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L13) +Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L23) --- @@ -128,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://gi > **QUINT2X4**: `17` -Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L17) +Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L27) --- @@ -136,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://gi > **QUINT4X2**: `16` -Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L16) +Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L26) --- @@ -144,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://gi > **QUINT8**: `13` -Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L14) +Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L24) --- @@ -152,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://gi > **SHORT**: `2` -Defined in: [packages/react-native-executorch/src/types/common.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L6) +Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L16) --- @@ -160,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:6](https://git > **UINT16**: `27` -Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L23) +Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L33) --- @@ -168,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://gi > **UINT32**: `28` -Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L24) +Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L34) --- @@ -176,4 +178,4 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://gi > **UINT64**: `29` -Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L25) +Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L35) diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md index e4993a5a6..f1099868c 100644 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -2,7 +2,7 @@ > **DEFAULT_STRUCTURED_OUTPUT_PROMPT**(`structuredOutputSchema`): `string` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) ## Parameters diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md index 1b8b22b1e..229f474f8 100644 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -2,7 +2,7 @@ > **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> -Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/llm.ts#L81) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/llm.ts#L81) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md index eccaede92..c9b72f00a 100644 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -2,7 +2,7 @@ > **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` -Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/llm.ts#L50) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/llm.ts#L50) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md index 8a4e9a3a5..c216dab14 100644 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -2,7 +2,7 @@ > **useClassification**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L10) ## Parameters @@ -12,34 +12,46 @@ Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useClass ## Returns -`object` - ### downloadProgress > **downloadProgress**: `number` +Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. + ### error > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +Contains the error message if the model failed to load. + ### forward() > **forward**: (...`input`) => `Promise`\<`any`\> +This function runs the model's forward method with the provided input arguments. + #### Parameters ##### input ...\[`string`\] +Input arguments for the model's forward method. + #### Returns `Promise`\<`any`\> +The output from the model's forward method. + ### isGenerating > **isGenerating**: `boolean` +Indicates whether the model is currently generating a response. + ### isReady > **isReady**: `boolean` + +Indicates whether the model is ready. diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md index b6b5b94ba..cf4fa9c19 100644 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -2,7 +2,7 @@ > **useExecutorchModule**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L10) ## Parameters @@ -12,34 +12,46 @@ Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchMod ## Returns -`object` - ### downloadProgress > **downloadProgress**: `number` +Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. + ### error > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +Contains the error message if the model failed to load. + ### forward() > **forward**: (...`input`) => `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +This function runs the model's forward method with the provided input arguments. + #### Parameters ##### input ...\[[`TensorPtr`](../interfaces/TensorPtr.md)[]\] +Input arguments for the model's forward method. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +The output from the model's forward method. + ### isGenerating > **isGenerating**: `boolean` +Indicates whether the model is currently generating a response. + ### isReady > **isReady**: `boolean` + +Indicates whether the model is ready. diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md index ca31ae3da..34a5423f7 100644 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -2,7 +2,7 @@ > **useImageEmbeddings**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L10) ## Parameters @@ -12,34 +12,46 @@ Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImage ## Returns -`object` - ### downloadProgress > **downloadProgress**: `number` +Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. + ### error > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +Contains the error message if the model failed to load. + ### forward() > **forward**: (...`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> +This function runs the model's forward method with the provided input arguments. + #### Parameters ##### input ...\[`string`\] +Input arguments for the model's forward method. + #### Returns `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> +The output from the model's forward method. + ### isGenerating > **isGenerating**: `boolean` +Indicates whether the model is currently generating a response. + ### isReady > **isReady**: `boolean` + +Indicates whether the model is ready. diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md index 3f981986c..41252d44c 100644 --- a/docs/docs/06-api-reference/functions/useImageSegmentation.md +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -2,7 +2,7 @@ > **useImageSegmentation**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L10) ## Parameters @@ -12,34 +12,46 @@ Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImage ## Returns -`object` - ### downloadProgress > **downloadProgress**: `number` +Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. + ### error > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +Contains the error message if the model failed to load. + ### forward() > **forward**: (...`input`) => `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> +This function runs the model's forward method with the provided input arguments. + #### Parameters ##### input ...\[`string`, [`DeeplabLabel`](../enumerations/DeeplabLabel.md)[], `boolean`\] +Input arguments for the model's forward method. + #### Returns `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> +The output from the model's forward method. + ### isGenerating > **isGenerating**: `boolean` +Indicates whether the model is currently generating a response. + ### isReady > **isReady**: `boolean` + +Indicates whether the model is ready. diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md index 601bcd9e8..039804d9d 100644 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -1,12 +1,16 @@ # Function: useLLM() -> **useLLM**(`__namedParameters`): [`LLMType`](../interfaces/LLMType.md) +> **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L17) +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts:20](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L20) + +React hook for managing a Large Language Model (LLM) instance. ## Parameters -### \_\_namedParameters +### model + +Object containing model, tokenizer, and tokenizer config sources. #### model @@ -16,18 +20,28 @@ Defined in: [packages/react-native-executorch/src/hooks/natural_language_process [`ResourceSource`](../type-aliases/ResourceSource.md) +`ResourceSource` that specifies the location of the model binary. + #### model.tokenizerConfigSource [`ResourceSource`](../type-aliases/ResourceSource.md) +`ResourceSource` pointing to the JSON file which contains the tokenizer config. + #### model.tokenizerSource [`ResourceSource`](../type-aliases/ResourceSource.md) +`ResourceSource pointing` to the JSON file which contains the tokenizer. + #### preventLoad? `boolean` = `false` +Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. + ## Returns [`LLMType`](../interfaces/LLMType.md) + +An object implementing the `LLMType` interface for interacting with the LLM. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md index 3713605fe..1cae57bdd 100644 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -2,7 +2,7 @@ > **useOCR**(`__namedParameters`): `OCRModule` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L15) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md index ed5813785..f42855379 100644 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -2,7 +2,7 @@ > **useObjectDetection**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L10) ## Parameters @@ -12,34 +12,46 @@ Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useObjec ## Returns -`object` - ### downloadProgress > **downloadProgress**: `number` +Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. + ### error > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +Contains the error message if the model failed to load. + ### forward() > **forward**: (...`input`) => `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> +This function runs the model's forward method with the provided input arguments. + #### Parameters ##### input ...\[`string`, `number`\] +Input arguments for the model's forward method. + #### Returns `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> +The output from the model's forward method. + ### isGenerating > **isGenerating**: `boolean` +Indicates whether the model is currently generating a response. + ### isReady > **isReady**: `boolean` + +Indicates whether the model is ready. diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md index 5406027ae..fd28fd820 100644 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -1,33 +1,51 @@ # Function: useSpeechToText() -> **useSpeechToText**(`__namedParameters`): `object` +> **useSpeechToText**(`speechToTextConfiguration`): `object` -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L7) +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L12) ## Parameters -### \_\_namedParameters +### speechToTextConfiguration + +Configuration object containing `model` source and optional `preventLoad` flag. #### model [`SpeechToTextModelConfig`](../interfaces/SpeechToTextModelConfig.md) +Object containing: + +`isMultilingual` - A boolean flag indicating whether the model supports multiple languages. + +`encoderSource` - A string that specifies the location of a `.pte` file for the encoder. + +`decoderSource` - A string that specifies the location of a `.pte` file for the decoder. + +`tokenizerSource` - A string that specifies the location to the tokenizer for the model. + #### preventLoad? `boolean` = `false` +Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. + ## Returns -`object` +Ready to use Speech to Text model. ### committedTranscription > **committedTranscription**: `string` +Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. + ### decode() > **decode**: (...`args`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> +Runs the decoder of the model. Passing `number[]` is deprecated. + #### Parameters ##### args @@ -42,10 +60,14 @@ Defined in: [packages/react-native-executorch/src/hooks/natural_language_process > **downloadProgress**: `number` +Tracks the progress of the model download process. + ### encode() > **encode**: (...`args`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> +Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. + #### Parameters ##### args @@ -60,28 +82,40 @@ Defined in: [packages/react-native-executorch/src/hooks/natural_language_process > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +Contains the error message if the model failed to load. + ### isGenerating > **isGenerating**: `boolean` +Indicates whether the model is currently processing an inference. + ### isReady > **isReady**: `boolean` +Indicates whether the model has successfully loaded and is ready for inference. + ### nonCommittedTranscription > **nonCommittedTranscription**: `string` +Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. + ### stream() > **stream**: (`options?`) => `Promise`\<`string`\> +Starts a streaming transcription process. Use in combination with `streamInsert` to feed audio chunks and `streamStop` to end the stream. The argument is an options object, e.g. `{ language: 'es' }` for multilingual models. Updates `committedTranscription` and `nonCommittedTranscription` as transcription progresses. + #### Parameters ##### options? [`DecodingOptions`](../interfaces/DecodingOptions.md) +Decoding options including language. + #### Returns `Promise`\<`string`\> @@ -90,6 +124,8 @@ Defined in: [packages/react-native-executorch/src/hooks/natural_language_process > **streamInsert**: (...`args`) => `void` +Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Call this repeatedly as new audio data becomes available. Passing `number[]` is deprecated. + #### Parameters ##### args @@ -104,6 +140,8 @@ Defined in: [packages/react-native-executorch/src/hooks/natural_language_process > **streamStop**: (...`args`) => `void` +Stops the ongoing streaming transcription process. + #### Parameters ##### args @@ -118,6 +156,8 @@ Defined in: [packages/react-native-executorch/src/hooks/natural_language_process > **transcribe**: (...`args`) => `Promise`\<`string`\> +Starts a transcription process for a given input array, which should be a waveform at 16kHz. The second argument is an options object, e.g. `{ language: 'es' }` for multilingual models. Resolves a promise with the output transcription when the model is finished. Passing `number[]` is deprecated. + #### Parameters ##### args diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md index 6de43125c..d0b6a6f48 100644 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -2,7 +2,7 @@ > **useStyleTransfer**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L10) ## Parameters @@ -12,34 +12,46 @@ Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useStyle ## Returns -`object` - ### downloadProgress > **downloadProgress**: `number` +Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. + ### error > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +Contains the error message if the model failed to load. + ### forward() > **forward**: (...`input`) => `Promise`\<`string`\> +This function runs the model's forward method with the provided input arguments. + #### Parameters ##### input ...\[`string`\] +Input arguments for the model's forward method. + #### Returns `Promise`\<`string`\> +The output from the model's forward method. + ### isGenerating > **isGenerating**: `boolean` +Indicates whether the model is currently generating a response. + ### isReady > **isReady**: `boolean` + +Indicates whether the model is ready. diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md index 78fe9ca89..2d2dd0f91 100644 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -1,45 +1,61 @@ # Function: useTextEmbeddings() -> **useTextEmbeddings**(`__namedParameters`): `object` +> **useTextEmbeddings**(`TextEmbeddingsConfiguration`): `object` -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:32](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L32) ## Parameters -### \_\_namedParameters +### TextEmbeddingsConfiguration -`Props` +[`Props`](../interfaces/Props.md) + +Configuration object containing `model` source and optional `preventLoad` flag. ## Returns -`object` +- Ready to use Text Embeddings model. ### downloadProgress > **downloadProgress**: `number` +Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. + ### error > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +Contains the error message if the model failed to load. + ### forward() > **forward**: (...`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> +This function runs the model's forward method with the provided input arguments. + #### Parameters ##### input ...\[`string`\] +Input arguments for the model's forward method. + #### Returns `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> +The output from the model's forward method. + ### isGenerating > **isGenerating**: `boolean` +Indicates whether the model is currently generating a response. + ### isReady > **isReady**: `boolean` + +Indicates whether the model is ready. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md index b5a9c4a1d..4af61c6b7 100644 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -2,7 +2,7 @@ > **useTextToImage**(`__namedParameters`): `TextToImageType` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L21) +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L21) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md index 4ae95ae27..8f278a32b 100644 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -2,7 +2,7 @@ > **useTextToSpeech**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts:15](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L15) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md index 2fcb645ef..2581c282b 100644 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -2,7 +2,7 @@ > **useTokenizer**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L7) +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L7) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md index bf033e10c..ad00ea6e8 100644 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -2,7 +2,7 @@ > **useVAD**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L10) ## Parameters @@ -12,34 +12,46 @@ Defined in: [packages/react-native-executorch/src/hooks/natural_language_process ## Returns -`object` - ### downloadProgress > **downloadProgress**: `number` +Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. + ### error > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +Contains the error message if the model failed to load. + ### forward() > **forward**: (...`input`) => `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> +This function runs the model's forward method with the provided input arguments. + #### Parameters ##### input ...\[`Float32Array`\<`ArrayBufferLike`\>\] +Input arguments for the model's forward method. + #### Returns `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> +The output from the model's forward method. + ### isGenerating > **isGenerating**: `boolean` +Indicates whether the model is currently generating a response. + ### isReady > **isReady**: `boolean` + +Indicates whether the model is ready. diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md index 89853a7db..ceff29cb2 100644 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -2,7 +2,7 @@ > **useVerticalOCR**(`__namedParameters`): `OCRModule` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L15) ## Parameters diff --git a/docs/docs/06-api-reference/index.md b/docs/docs/06-api-reference/index.md index a0387372e..0377f3166 100644 --- a/docs/docs/06-api-reference/index.md +++ b/docs/docs/06-api-reference/index.md @@ -36,6 +36,7 @@ - [Message](interfaces/Message.md) - [OCRBbox](interfaces/OCRBbox.md) - [OCRDetection](interfaces/OCRDetection.md) +- [Props](interfaces/Props.md) - [Segment](interfaces/Segment.md) - [SpeechToTextModelConfig](interfaces/SpeechToTextModelConfig.md) - [TensorPtr](interfaces/TensorPtr.md) diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md index 17cb15d92..fcea8fbe1 100644 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -1,6 +1,6 @@ # Interface: Bbox -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L1) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L1) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](ht > **x1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L2) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L2) --- @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](ht > **x2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L3) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L3) --- @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](ht > **y1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L4) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L4) --- @@ -32,4 +32,4 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](ht > **y2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L5) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L5) diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md index f1a5b207e..982443c8b 100644 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -1,6 +1,8 @@ # Interface: ChatConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:43](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L43) +Defined in: [packages/react-native-executorch/src/types/llm.ts:155](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L155) + +Object configuring chat management. ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:43](https://githu > **contextWindowLength**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:45](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L45) +Defined in: [packages/react-native-executorch/src/types/llm.ts:164](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L164) + +The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. --- @@ -16,7 +20,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:45](https://githu > **initialMessageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:44](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L44) +Defined in: [packages/react-native-executorch/src/types/llm.ts:159](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L159) + +An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. --- @@ -24,4 +30,6 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:44](https://githu > **systemPrompt**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:46](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L46) +Defined in: [packages/react-native-executorch/src/types/llm.ts:169](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L169) + +Often used to tell the model what is its purpose, for example - "Be a helpful translator". diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md index 3e7e6e32d..22a903ae0 100644 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -1,6 +1,6 @@ # Interface: DecodingOptions -Defined in: [packages/react-native-executorch/src/types/stt.ts:81](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L81) +Defined in: [packages/react-native-executorch/src/types/stt.ts:81](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L81) ## Properties @@ -8,4 +8,4 @@ Defined in: [packages/react-native-executorch/src/types/stt.ts:81](https://githu > `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:82](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L82) +Defined in: [packages/react-native-executorch/src/types/stt.ts:82](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L82) diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md index 1cd0dd2f2..89e00bbf9 100644 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -1,6 +1,6 @@ # Interface: Detection -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L8) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L8) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](ht > **bbox**: [`Bbox`](Bbox.md) -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L9) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L9) --- @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](ht > **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L10) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L10) --- @@ -24,4 +24,4 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](h > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/objectDetection.ts#L11) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L11) diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md index 7cf93fe20..838e4d762 100644 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -1,6 +1,8 @@ # Interface: GenerationConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:55](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L55) +Defined in: [packages/react-native-executorch/src/types/llm.ts:195](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L195) + +Object configuring generation settings. ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:55](https://githu > `optional` **batchTimeInterval**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L59) +Defined in: [packages/react-native-executorch/src/types/llm.ts:214](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L214) + +Upper limit on the time interval between consecutive token batches. --- @@ -16,7 +20,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://githu > `optional` **outputTokenBatchSize**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:58](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L58) +Defined in: [packages/react-native-executorch/src/types/llm.ts:209](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L209) + +Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). --- @@ -24,7 +30,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:58](https://githu > `optional` **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:56](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L56) +Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L199) + +Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. --- @@ -32,4 +40,6 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:56](https://githu > `optional` **topp**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:57](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L57) +Defined in: [packages/react-native-executorch/src/types/llm.ts:204](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L204) + +Only samples from the smallest set of tokens whose cumulative probability exceeds topp. diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md index cb97ac822..508bb2f0a 100644 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -1,31 +1,64 @@ # Interface: LLMType -Defined in: [packages/react-native-executorch/src/types/llm.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L3) +Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L6) + +React hook for managing a Large Language Model (LLM) instance. ## Properties ### configure() -> **configure**: (`__namedParameters`) => `void` +> **configure**: (`configuration`) => `void` + +Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L48) -Defined in: [packages/react-native-executorch/src/types/llm.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L11) +Configures chat and tool calling. +See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. #### Parameters -##### \_\_namedParameters +##### configuration + +Configuration object containing `chatConfig`, `toolsConfig`, and `generationConfig`. ###### chatConfig? `Partial`\<[`ChatConfig`](ChatConfig.md)\> +Object configuring chat management, contains following properties: + +`systemPrompt` - Often used to tell the model what is its purpose, for example - "Be a helpful translator". + +`initialMessageHistory` - An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. + +`contextWindowLength` - The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. + ###### generationConfig? [`GenerationConfig`](GenerationConfig.md) +Object configuring generation settings. + +`outputTokenBatchSize` - Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). + +`batchTimeInterval` - Upper limit on the time interval between consecutive token batches. + +`temperature` - Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. + +`topp` - Only samples from the smallest set of tokens whose cumulative probability exceeds topp. + ###### toolsConfig? [`ToolsConfig`](ToolsConfig.md) +Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: + +`tools` - List of objects defining tools. + +`executeToolCallback` - Function that accepts `ToolCall`, executes tool and returns the string to model. + +`displayToolCalls` - If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. + #### Returns `void` @@ -36,7 +69,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:11](https://githu > **deleteMessage**: (`index`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:23](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L23) +Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L114) + +Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. #### Parameters @@ -44,6 +79,8 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:23](https://githu `number` +The index of the message to delete from history. + #### Returns `void` @@ -54,7 +91,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:23](https://githu > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L9) +Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L35) + +Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. --- @@ -62,7 +101,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:9](https://github > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L10) +Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L40) + +Contains the error message if the model failed to load. --- @@ -70,7 +111,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://githu > **generate**: (`messages`, `tools?`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L21) +Defined in: [packages/react-native-executorch/src/types/llm.ts:100](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L100) + +Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. #### Parameters @@ -78,10 +121,14 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:21](https://githu [`Message`](Message.md)[] +Array of messages representing the chat history. + ##### tools? `Object`[] +Optional array of tools that can be used during generation. + #### Returns `Promise`\<`void`\> @@ -92,19 +139,25 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:21](https://githu > **getGeneratedTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L20) +Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L93) + +Returns the number of tokens generated so far in the current generation. #### Returns `number` +The count of generated tokens. + --- ### interrupt() > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:24](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L24) +Defined in: [packages/react-native-executorch/src/types/llm.ts:119](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L119) + +Function to interrupt the current inference. #### Returns @@ -116,7 +169,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:24](https://githu > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:8](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L8) +Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L30) + +Indicates whether the model is currently generating a response. --- @@ -124,7 +179,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:8](https://github > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:7](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L7) +Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L25) + +Indicates whether the model is ready. --- @@ -132,7 +189,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:7](https://github > **messageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L4) +Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L10) + +History containing all messages in conversation. This field is updated after model responds to sendMessage. --- @@ -140,7 +199,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:4](https://github > **response**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L5) +Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L15) + +State of the generated response. This field is updated with each token generated by the model. --- @@ -148,7 +209,10 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:5](https://github > **sendMessage**: (`message`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:22](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L22) +Defined in: [packages/react-native-executorch/src/types/llm.ts:107](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L107) + +Function to add user message to conversation. +After model responds, `messageHistory` will be updated with both user message and model response. #### Parameters @@ -156,6 +220,8 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:22](https://githu `string` +The message string to send. + #### Returns `Promise`\<`void`\> @@ -166,4 +232,6 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:22](https://githu > **token**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L6) +Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L20) + +The most recently generated token. diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md index ba9e2f7f4..9a69921bf 100644 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -1,6 +1,8 @@ # Interface: Message -Defined in: [packages/react-native-executorch/src/types/llm.ts:29](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L29) +Defined in: [packages/react-native-executorch/src/types/llm.ts:130](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L130) + +Represents a message in the conversation. ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:29](https://githu > **content**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:31](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L31) +Defined in: [packages/react-native-executorch/src/types/llm.ts:139](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L139) + +Content of the message. --- @@ -16,4 +20,6 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:31](https://githu > **role**: [`MessageRole`](../type-aliases/MessageRole.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L30) +Defined in: [packages/react-native-executorch/src/types/llm.ts:134](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L134) + +Role of the message sender of type `MessageRole`. diff --git a/docs/docs/06-api-reference/interfaces/OCRBbox.md b/docs/docs/06-api-reference/interfaces/OCRBbox.md index c60e07373..dd93374bb 100644 --- a/docs/docs/06-api-reference/interfaces/OCRBbox.md +++ b/docs/docs/06-api-reference/interfaces/OCRBbox.md @@ -1,6 +1,6 @@ # Interface: OCRBbox -Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L9) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L9) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github > **x**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L10) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L10) --- @@ -16,4 +16,4 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://githu > **y**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:11](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L11) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:11](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L11) diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md index 2ac8a64c1..e944ecc5d 100644 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -1,6 +1,6 @@ # Interface: OCRDetection -Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L3) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L3) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github > **bbox**: [`OCRBbox`](OCRBbox.md)[] -Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L4) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L4) --- @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L6) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L6) --- @@ -24,4 +24,4 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:5](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L5) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L5) diff --git a/docs/docs/06-api-reference/interfaces/Props.md b/docs/docs/06-api-reference/interfaces/Props.md new file mode 100644 index 000000000..2218ef04b --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/Props.md @@ -0,0 +1,35 @@ +# Interface: Props + +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L8) + +Props for the useTextEmbeddings hook. + +## Properties + +### model + +> **model**: `object` + +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L9) + +#### modelSource + +> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +`ResourceSource` that specifies the location of the model binary. + +#### tokenizerSource + +> **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +`ResourceSource` pointing to the JSON file which contains the tokenizer. + +--- + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:24](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L24) + +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/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index 94f604365..fd655c0cb 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,6 @@ # Interface: Segment -Defined in: [packages/react-native-executorch/src/types/vad.ts:1](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/vad.ts#L1) +Defined in: [packages/react-native-executorch/src/types/vad.ts:1](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/vad.ts#L1) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/vad.ts:1](https://github > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/vad.ts#L3) +Defined in: [packages/react-native-executorch/src/types/vad.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/vad.ts#L3) --- @@ -16,4 +16,4 @@ Defined in: [packages/react-native-executorch/src/types/vad.ts:3](https://github > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:2](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/vad.ts#L2) +Defined in: [packages/react-native-executorch/src/types/vad.ts:2](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/vad.ts#L2) diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md index ac4004faf..dda579dd3 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextModelConfig -Defined in: [packages/react-native-executorch/src/types/stt.ts:85](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L85) +Defined in: [packages/react-native-executorch/src/types/stt.ts:85](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L85) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/stt.ts:85](https://githu > **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:88](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L88) +Defined in: [packages/react-native-executorch/src/types/stt.ts:88](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L88) --- @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/stt.ts:88](https://githu > **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L87) +Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L87) --- @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://githu > **isMultilingual**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:86](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L86) +Defined in: [packages/react-native-executorch/src/types/stt.ts:86](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L86) --- @@ -32,4 +32,4 @@ Defined in: [packages/react-native-executorch/src/types/stt.ts:86](https://githu > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:89](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L89) +Defined in: [packages/react-native-executorch/src/types/stt.ts:89](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L89) diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md index 521063ded..43258582a 100644 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -1,6 +1,6 @@ # Interface: TensorPtr -Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L41) +Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L51) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://gi > **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:42](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L42) +Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L52) --- @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:42](https://gi > **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:44](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L44) +Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L54) --- @@ -24,4 +24,4 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:44](https://gi > **sizes**: `number`[] -Defined in: [packages/react-native-executorch/src/types/common.ts:43](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L43) +Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L53) diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md index 8d5f50291..da6675be9 100644 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -1,6 +1,6 @@ # Interface: ToolCall -Defined in: [packages/react-native-executorch/src/types/llm.ts:34](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L34) +Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L142) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:34](https://githu > **arguments**: `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:36](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L36) +Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L144) --- @@ -16,4 +16,4 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:36](https://githu > **toolName**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L35) +Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L143) diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md index 7e321b09d..c6bc91c96 100644 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -1,6 +1,8 @@ # Interface: ToolsConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:49](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L49) +Defined in: [packages/react-native-executorch/src/types/llm.ts:175](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L175) + +Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:49](https://githu > `optional` **displayToolCalls**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:52](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L52) +Defined in: [packages/react-native-executorch/src/types/llm.ts:189](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L189) + +If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. --- @@ -16,7 +20,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:52](https://githu > **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:51](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L51) +Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L184) + +Function that accepts `ToolCall`, executes tool and returns the string to model. #### Parameters @@ -34,4 +40,6 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:51](https://githu > **tools**: `Object`[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L50) +Defined in: [packages/react-native-executorch/src/types/llm.ts:179](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L179) + +List of objects defining tools. diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md index 487201d5e..e68c6da20 100644 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -2,4 +2,4 @@ > **LLMTool** = `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:41](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L41) +Defined in: [packages/react-native-executorch/src/types/llm.ts:149](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L149) diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md index 324dbc6aa..bbca55926 100644 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -2,4 +2,6 @@ > **MessageRole** = `"user"` \| `"assistant"` \| `"system"` -Defined in: [packages/react-native-executorch/src/types/llm.ts:27](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L27) +Defined in: [packages/react-native-executorch/src/types/llm.ts:125](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L125) + +Roles that a message sender can have. diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md index 16db0aab6..e1a641609 100644 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -2,4 +2,4 @@ > **OCRLanguage** = keyof _typeof_ `symbols` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/ocr.ts#L14) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L14) diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md index f0225fc6a..c2bc85101 100644 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -2,4 +2,6 @@ > **ResourceSource** = `string` \| `number` \| `object` -Defined in: [packages/react-native-executorch/src/types/common.ts:1](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L1) +Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L8) + +Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md index a7c8e68a9..de49dadfb 100644 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -2,4 +2,4 @@ > **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:4](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/stt.ts#L4) +Defined in: [packages/react-native-executorch/src/types/stt.ts:4](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L4) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md index 30c5122e3..817a275e6 100644 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -2,4 +2,4 @@ > **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` -Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/common.ts#L28) +Defined in: [packages/react-native-executorch/src/types/common.ts:38](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L38) diff --git a/docs/docs/06-api-reference/typedoc-sidebar.cjs b/docs/docs/06-api-reference/typedoc-sidebar.cjs index a24e8c1aa..fd7b328c4 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:"Enumerations",items:[{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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/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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{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/OCRBbox",label:"OCRBbox"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/TensorPtr",label:"TensorPtr"},{type:"doc",id:"06-api-reference/interfaces/ToolCall",label:"ToolCall"},{type:"doc",id:"06-api-reference/interfaces/ToolsConfig",label:"ToolsConfig"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_EN",label:"KOKORO_EN"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; +const typedocSidebar = {items:[{type:"category",label:"Enumerations",items:[{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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/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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{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/OCRBbox",label:"OCRBbox"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/Props",label:"Props"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/TensorPtr",label:"TensorPtr"},{type:"doc",id:"06-api-reference/interfaces/ToolCall",label:"ToolCall"},{type:"doc",id:"06-api-reference/interfaces/ToolsConfig",label:"ToolsConfig"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_EN",label:"KOKORO_EN"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; 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 1805dbd63..eadcff5e8 100644 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -2,7 +2,7 @@ > `const` **ALL_MINILM_L6_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L408) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L408) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md index 0f362f25b..d0fbfdad8 100644 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -2,7 +2,7 @@ > `const` **ALL_MPNET_BASE_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L413) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L413) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md index 1557a37f9..dc25ef44a 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -2,7 +2,7 @@ > `const` **BK_SDM_TINY_VPRED_256**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L442) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L442) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index a669619ac..e925bc62e 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -2,7 +2,7 @@ > `const` **BK_SDM_TINY_VPRED_512**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L434) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L434) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index 5504715b3..092aa8292 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -2,7 +2,7 @@ > `const` **CLIP_VIT_BASE_PATCH32_IMAGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md index b7c45b13a..0af3b32bc 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -2,7 +2,7 @@ > `const` **CLIP_VIT_BASE_PATCH32_TEXT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L428) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L428) ## 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 90d7709e4..e274ae6c6 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: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L385) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L385) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md index e073a5614..ea7b77d95 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -2,4 +2,4 @@ > `const` **DEFAULT_CHAT_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md index b7c500472..7377b47a7 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md @@ -2,4 +2,4 @@ > `const` **DEFAULT_CONTEXT_WINDOW_LENGTH**: `5` = `5` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md index 56b9766df..b3d2807d6 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -2,4 +2,4 @@ > `const` **DEFAULT_MESSAGE_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md index e548b8b19..a15c3a0d3 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -2,4 +2,4 @@ > `const` **DEFAULT_SYSTEM_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) 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 75891beef..3cc2c73ba 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -2,7 +2,7 @@ > `const` **EFFICIENTNET_V2_S**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L260) ## 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 5b7bc2b85..af0f649fa 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -2,7 +2,7 @@ > `const` **FSMN_VAD**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L453) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L453) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md index bdac191c3..e032eb8ff 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_0_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L108) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L108) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md index e282d8142..4167ac5a2 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_0_5B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L114) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L114) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md index 83f1653c2..f609379e9 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_1_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L120) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L120) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md index a8de56ef6..42e14c72f 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_1_5B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L126) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L126) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md index aaf3e4040..7c3211163 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L132) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L132) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md index 7e118fd31..2bc729f9c 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2_1_3B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L138) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L138) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_EN.md b/docs/docs/06-api-reference/variables/KOKORO_EN.md index ceb6c9e44..4b2a2d7a3 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_EN.md +++ b/docs/docs/06-api-reference/variables/KOKORO_EN.md @@ -2,7 +2,7 @@ > `const` **KOKORO_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/models.ts#L9) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/models.ts#L9) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md index 27edddeef..c8ea641f6 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AF_HEART**: `VoiceConfig` -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L21) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md index 00efb4b5f..684f95a39 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AF_RIVER**: `VoiceConfig` -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L26) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L26) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md index e269bf6ac..7e15c5308 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AF_SARAH**: `VoiceConfig` -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L31) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L31) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md index 84dee7043..38beab25c 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AM_ADAM**: `VoiceConfig` -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L36) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L36) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md index d7dbe07f7..89f43b98d 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AM_MICHAEL**: `VoiceConfig` -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L41) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md index 9c0919c53..3f366276f 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_AM_SANTA**: `VoiceConfig` -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L46) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md index 05d12bace..817b7565b 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_BF_EMMA**: `VoiceConfig` -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L51) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L51) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md index ea0491ef6..a152389df 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO_VOICE_BM_DANIEL**: `VoiceConfig` -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/tts/voices.ts#L56) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L56) 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 5aa347cb3..7fa696a99 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_1B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L34) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L34) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md index 4319564ed..4eafaf042 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_1B_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L40) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L40) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md index 1ba6e7241..41d91225d 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_1B_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L46) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md index f9e697186..4a0c028ac 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L16) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L16) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md index 4ab5b1d68..1b1a28d99 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_3B_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L22) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md index 47add3a09..bcad89ac9 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3_2_3B_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L28) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L28) ## 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 522486051..8802514ef 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI_QA_MINILM_L6_COS_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L418) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L418) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md index 4d87af0de..f60a3ad7c 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI_QA_MPNET_BASE_DOT_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md index 19432a174..1ead9a99e 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **OCR_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L41) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md index 612cb3fdd..1b29e12e6 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **OCR_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L47) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L47) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md index b55263429..88864c53b 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **OCR_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L53) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L53) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md index b4f8c606e..988daa042 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L362) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L362) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md index 3b5a2c9b2..2e7a31989 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **OCR_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L59) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L59) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md index 5609ade93..b9f30da49 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **OCR_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L65) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L65) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md index bd907e1d9..ff49d8899 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L71) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L71) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md index 89990be53..88a899010 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L83) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L83) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md index 7809e2d94..96980a160 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L77) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L77) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md index 0005193f7..743dd8baf 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **OCR_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L98) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L98) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md index 1203090e9..616700fc5 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L164) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L164) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md index d38799ab0..98a7bf367 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **OCR_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L104) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L104) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md index 84fb25d69..618234dc0 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **OCR_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L116) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L116) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md index b142b9603..4e5af610f 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **OCR_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L122) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L122) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md index f0cf7548f..2bfc5c667 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **OCR_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L284) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md index da64f54ab..b6ebe3880 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **OCR_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L134) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L134) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md index 73f0af604..31877ae32 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L146) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L146) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md index 9c615a456..f007c43c0 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **OCR_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L152) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L152) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md index 01fbd87c8..dc2e382f9 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **OCR_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L128) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L128) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md index 35416297e..5ea41f175 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L170) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L170) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md index 1d51204e0..91e1d1d25 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **OCR_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L188) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L188) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md index 07e5e0c9b..0d40e4250 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L176) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L176) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md index badae9f4c..907f0f820 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **OCR_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L182) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L182) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md index 46fe0baec..a2e788efc 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **OCR_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L158) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L158) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md index 18ade1d26..019c2fba5 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L194) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L194) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md index 8a1f81faf..a5dd9e1da 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **OCR_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md index e54f4b053..8dbe27eb9 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **OCR_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md index 9b59d25bd..71396d447 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md index d5aee6e7a..2bc5e5c3a 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **OCR_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md index 14d6d62ee..bf342cea1 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **OCR_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md index 675be6f8e..8b9000086 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **OCR_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L236) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L236) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md index 2eb9b4c54..caa27edb4 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md index ae8cc195f..21b1e305a 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L254) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L254) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md index 070683b4b..1d78fb116 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md index 17e41a057..d657dbba8 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md index 324a47969..1cab7b152 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **OCR_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L272) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L272) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md index d92715d08..8b425bbb7 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **OCR_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L278) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L278) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md index 7d53f883e..24ffebdf5 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **OCR_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L260) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md index 36db4d816..86e521871 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L266) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L266) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md index 61569626d..67b9ec398 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L290) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L290) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md index bcfacd03b..01a80516a 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **OCR_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L296) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L296) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md index e10e16ca0..a581dcb71 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **OCR_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L302) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md index 64d23ba53..27b3343e7 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **OCR_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L308) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L308) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md index 42757234f..d5588ecda 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **OCR_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L314) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L314) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md index befe8032c..dd389d7d8 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L320) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L320) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md index 592cfd2f9..b5859d4fd 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L326) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L326) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md index db3ad8d13..2bd961a6c 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **OCR_SERBIAN_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L332) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L332) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md index a3c6435cb..2fcd4f40e 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR_SERBIAN_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L341) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L341) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md index fa413a1be..af47b90c2 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **OCR_SIMPLIFIED_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L89) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L89) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md index c38302f56..ac87adcfb 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **OCR_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L350) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L350) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md index 388f2c599..edfc63169 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L356) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L356) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md index 283311a21..1bc9616dd 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **OCR_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L140) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L140) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md index fe3abc6db..4c87a7a68 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **OCR_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L374) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L374) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md index c88fb62b1..dd1d5ee22 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **OCR_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md index f2c2dfefe..ca24d5d07 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **OCR_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L380) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L380) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md index 01c12a9cb..46462a629 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **OCR_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L398) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L398) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md index 00a08dca7..3ec48531a 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **OCR_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md index e94103a10..d5e3e73d6 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **OCR_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L386) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L386) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md index 0bac226b2..e8ce416b6 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **OCR_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L404) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L404) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md index 2c135e8d8..e78d09ebf 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **OCR_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L410) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L410) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md index b9705bcca..afa5a149b 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **OCR_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L416) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L416) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md index 162d48588..b54874ece 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **OCR_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L422) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L422) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md index c5beded26..705e896d7 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **OCR_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L110) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L110) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md index b20a5d86e..38a027ade 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -2,7 +2,7 @@ > `const` **PHI_4_MINI_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md index f5c1e9b01..be1e4d139 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **PHI_4_MINI_4B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md index e2330a17d..933962cff 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_0_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md index 1d6ba34b1..8f27b79ff 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_0_5B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md index 425dd068f..a3e7b189a 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_1_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md index 0bf455e05..130911e87 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_1_5B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md index d00e3623c..03716b914 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md index 674722c29..9b8543039 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2_5_3B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md index f261a2e42..c87cb1569 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -2,7 +2,7 @@ > `const` **QWEN3_0_6B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L62) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L62) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md index 8cc2b86f2..204ba8822 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3_0_6B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L68) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L68) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md index d0737586d..c895c9926 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -2,7 +2,7 @@ > `const` **QWEN3_1_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L74) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L74) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md index dda0d7348..56b58b1ff 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3_1_7B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L80) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L80) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index 3a7449110..02d7c1537 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -2,7 +2,7 @@ > `const` **QWEN3_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L86) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L86) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md index 4ebb8999e..b329b4dcb 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3_4B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L92) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L92) ## 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 b2d89140c..97f8d3615 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_135M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L154) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L154) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md index b0427345d..35419a82e 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_135M_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L160) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L160) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md index 9e2170808..0c8f1b63f 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_1_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L178) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L178) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md index 58418d3a6..851c909b5 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_1_7B_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L184) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L184) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md index 5fd185cce..4c3c5846b 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_360M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L166) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L166) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md index 5a11af32e..51824d209 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2_1_360M_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L172) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L172) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md index 1a974e2e2..5bc68627f 100644 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -2,7 +2,7 @@ > `const` **SPECIAL_TOKENS**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:62](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/types/llm.ts#L62) +Defined in: [packages/react-native-executorch/src/types/llm.ts:217](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L217) ## Type Declaration 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 2e33ac08c..5e387c0cd 100644 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `const` **SSDLITE_320_MOBILENET_V3_LARGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L267) ## 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 4625a8f01..2ae14a488 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -2,7 +2,7 @@ > `const` **STYLE_TRANSFER_CANDY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L289) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L289) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md index 0a616fb29..7f6de7860 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -2,7 +2,7 @@ > `const` **STYLE_TRANSFER_MOSAIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L293) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L293) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md index 19ef2e565..ed5e479ef 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -2,7 +2,7 @@ > `const` **STYLE_TRANSFER_RAIN_PRINCESS**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md index d67da5291..a9c1fde9b 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -2,7 +2,7 @@ > `const` **STYLE_TRANSFER_UDNIE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L301) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L301) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md index f54a7b4bb..2aaa64a93 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L42) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L42) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md index b8f1e29d8..9090b19d3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L48) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L48) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md index 6c75fa636..ff2972c3a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L54) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L54) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md index 6edb3e133..4eb7ad342 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L363) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L363) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md index 5392ae0b4..1513f17f8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L60) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L60) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md index c0d3ba2cf..a0116b64a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L66) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L66) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md index db49b50cb..035908210 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L72) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L72) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md index cbf888e06..198120d5b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L84) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L84) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md index e789c3941..919ee820a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L78) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L78) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md index 5c8c900b3..46f2259d8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L99) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L99) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md index cf51fcac1..899d802b6 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L165) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L165) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md index d28ce7236..a579ed59c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L105) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L105) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md index 0a912ad38..5401ee13a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L117) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L117) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md index e89fcce22..cef614a86 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L123) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L123) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md index bfefdec33..d65907046 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L285) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L285) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md index 16bb5f470..0d9695a72 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L135) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L135) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md index 3a3a2bdef..5bc55d1a8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L147) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L147) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md index 6f3464b75..bcac00e8f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L153) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L153) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md index 14e94e3ef..80679a77c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L129) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L129) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md index 08febc0e4..501581274 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L171) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L171) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md index ba4a62136..9dcc08905 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L189) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L189) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md index 11f54d17f..1edb7425d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L177) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L177) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md index fd17893c4..f3474bf01 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L183) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L183) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md index 3b87245ef..e1d320202 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L159) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L159) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md index 3f6908b92..a5ccc4b04 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L195) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L195) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md index 7af946618..d0ef95787 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L201) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L201) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md index 6f76491ee..63bfb2089 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L213) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L213) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md index e761e42d3..62a5aedca 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L207) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L207) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md index 7801544b7..4a297545a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L219) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L219) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md index bbd7a68b1..fa1e1d58b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L225) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L225) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md index 3d674ce41..14663480d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L237) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L237) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md index 04ef719dd..6800b38ce 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L231) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L231) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md index d528028f5..29ffec97b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L255) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L255) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md index 695bf4df1..a1f3d7dd8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L243) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L243) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md index 5142816d0..0f947e8f9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L249) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L249) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md index ee166a8ba..c77f85e96 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L273) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L273) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md index d24e32e57..cb1c6586f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L279) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L279) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md index 6b9678530..b5a78965f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L261) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L261) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md index 14da0fa2d..686c5d537 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L267) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md index 44ba693d5..8c2e4616d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L291) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L291) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md index 6b4535f58..d19321937 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md index 630dd7586..6977aed2d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L303) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L303) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md index 3d61da085..c96a451ab 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L309) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L309) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md index 647a3e399..171e876df 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L315) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L315) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md index 5cc64d78b..3a2900a15 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L321) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L321) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md index 40e197deb..2a3a02750 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L327) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L327) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md index e7f9689fb..ee6ee80d1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_SERBIAN_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L336) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L336) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md index 7935d06be..3890fefd3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_SERBIAN_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L345) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L345) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md index 85e1a6608..12d8d4ff5 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_SIMPLIFIED_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L93) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L93) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md index 754542a83..12ab56c31 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L351) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L351) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md index e79d778fb..9917dd0d5 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L357) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L357) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md index 95413eb2c..94787947c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L141) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L141) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md index 7edb86547..50c0de77b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md index 76ea9a096..82516a3fd 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L369) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L369) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md index df3bbf53b..9659482b8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L381) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L381) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md index c42ae0632..ce9faddf1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L399) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L399) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md index d5ab025e7..e504df9a4 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L393) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L393) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md index 149101021..7ca2210b2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L387) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L387) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md index 23ea2671d..7ab47b448 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L405) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L405) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md index c3cc9a6f2..9a8ef1418 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L411) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L411) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md index 2a304d606..320fe7383 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L417) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L417) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md index 83dd8f93c..92b61958d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md index 1b38cbc0d..ab0053ed1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL_OCR_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/ocr/models.ts#L111) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L111) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md index 28a69a8d6..f3e0eceed 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -2,7 +2,7 @@ > `const` **WHISPER_BASE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md index a00f77585..996453f8c 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER_BASE_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L347) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L347) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md index 448b32933..0aa2764c9 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -2,7 +2,7 @@ > `const` **WHISPER_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md index 84e3eefa8..dc0ef20a3 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER_SMALL_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L354) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L354) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md index 89f94665a..e2406f07c 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -2,7 +2,7 @@ > `const` **WHISPER_TINY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L361) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L361) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md index cd77d6b78..5ab1c059e 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER_TINY_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L333) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L333) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md index 069484681..9b5d6e5f9 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **WHISPER_TINY_EN_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/constants/modelUrls.ts#L340) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L340) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md index 0b27f39aa..3f049951a 100644 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -2,7 +2,7 @@ > `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] -Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/da1b9b6f6bcd0c76e913caeb68a23a84a79badba/packages/react-native-executorch/src/utils/llm.ts#L9) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/llm.ts#L9) ## Parameters diff --git a/packages/react-native-executorch/src/errors/errorUtils.ts b/packages/react-native-executorch/src/errors/errorUtils.ts index cc32f314b..90a616cdf 100644 --- a/packages/react-native-executorch/src/errors/errorUtils.ts +++ b/packages/react-native-executorch/src/errors/errorUtils.ts @@ -1,13 +1,31 @@ import { RnExecutorchErrorCode } from './ErrorCodes'; export class RnExecutorchError extends Error { + /** + * The error code representing the type of error. + */ public code: RnExecutorchErrorCode; + + /** + * The original cause of the error, if any. + */ public cause?: unknown; constructor(code: number, message: string, cause?: unknown) { super(message); + /** + * The error code representing the type of error. + */ this.code = code; + + /** + * The message describing the error. + */ this.message = message; + + /** + * The original cause of the error, if any. + */ this.cause = cause; } } diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts index 23882e65c..5544c65f5 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts @@ -11,18 +11,33 @@ import { import { LLMController } from '../../controllers/LLMController'; import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; -/* -Hook version of LLMModule -*/ +/** + * React hook for managing a Large Language Model (LLM) instance. + * + * @param model - Object containing model, tokenizer, and tokenizer config sources. + * @returns An object implementing the `LLMType` interface for interacting with the LLM. + */ export const useLLM = ({ model, preventLoad = false, }: { model: { + /** + * `ResourceSource` that specifies the location of the model binary. + */ modelSource: ResourceSource; + /** + * `ResourceSource pointing` to the JSON file which contains the tokenizer. + */ tokenizerSource: ResourceSource; + /** + * `ResourceSource` pointing to the JSON file which contains the tokenizer config. + */ tokenizerConfigSource: ResourceSource; }; + /** + * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. + */ preventLoad?: boolean; }): LLMType => { const [token, setToken] = useState(''); diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts index 3e1324f54..cb5157860 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts @@ -4,11 +4,31 @@ import { DecodingOptions, SpeechToTextModelConfig } from '../../types/stt'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; +/** + * + * @param speechToTextConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. + * @returns Ready to use Speech to Text model. + */ export const useSpeechToText = ({ model, preventLoad = false, }: { + /** + * Object containing: + * + * `isMultilingual` - A boolean flag indicating whether the model supports multiple languages. + * + * `encoderSource` - A string that specifies the location of a `.pte` file for the encoder. + * + * `decoderSource` - A string that specifies the location of a `.pte` file for the decoder. + * + * `tokenizerSource` - A string that specifies the location to the tokenizer for the model. + */ model: SpeechToTextModelConfig; + + /** + * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. + */ preventLoad?: boolean; }) => { const [error, setError] = useState(null); @@ -121,17 +141,66 @@ export const useSpeechToText = ({ ); return { + /** + * Contains the error message if the model failed to load. + */ error, + + /** + * Indicates whether the model has successfully loaded and is ready for inference. + */ isReady, + + /** + * Indicates whether the model is currently processing an inference. + */ isGenerating, + + /** + * Tracks the progress of the model download process. + */ downloadProgress, + + /** + * Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. + */ committedTranscription, + + /** + * Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. + */ nonCommittedTranscription, + + /** + * Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. + */ encode: stateWrapper(SpeechToTextModule.prototype.encode), + + /** + * Runs the decoder of the model. Passing `number[]` is deprecated. + * @param waveform - The encoded audio data. + */ decode: stateWrapper(SpeechToTextModule.prototype.decode), + + /** + * Starts a transcription process for a given input array, which should be a waveform at 16kHz. The second argument is an options object, e.g. `{ language: 'es' }` for multilingual models. Resolves a promise with the output transcription when the model is finished. Passing `number[]` is deprecated. + */ transcribe: stateWrapper(SpeechToTextModule.prototype.transcribe), + + /** + * Starts a streaming transcription process. Use in combination with `streamInsert` to feed audio chunks and `streamStop` to end the stream. The argument is an options object, e.g. `{ language: 'es' }` for multilingual models. Updates `committedTranscription` and `nonCommittedTranscription` as transcription progresses. + * @param options - Decoding options including language. + */ stream, + + /** + * Stops the ongoing streaming transcription process. + */ streamStop: wrapper(SpeechToTextModule.prototype.streamStop), + + /** + * Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Call this repeatedly as new audio data becomes available. Passing `number[]` is deprecated. + */ streamInsert: wrapper(SpeechToTextModule.prototype.streamInsert), }; }; 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 2f7ece798..562aa456b 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 @@ -2,14 +2,33 @@ import { TextEmbeddingsModule } from '../../modules/natural_language_processing/ import { ResourceSource } from '../../types/common'; import { useModule } from '../useModule'; -interface Props { +/** + * Props for the useTextEmbeddings hook. + */ +export interface Props { model: { + /** + * `ResourceSource` that specifies the location of the model binary. + */ modelSource: ResourceSource; + + /** + * `ResourceSource` pointing to the JSON file which contains the tokenizer. + */ tokenizerSource: ResourceSource; }; + + /** + * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. + */ preventLoad?: boolean; } +/** + * + * @param TextEmbeddingsConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. + * @returns - Ready to use Text Embeddings model. + */ export const useTextEmbeddings = ({ model, preventLoad = false }: Props) => useModule({ module: TextEmbeddingsModule, diff --git a/packages/react-native-executorch/src/hooks/useModule.ts b/packages/react-native-executorch/src/hooks/useModule.ts index 4c97abb67..e62f861f6 100644 --- a/packages/react-native-executorch/src/hooks/useModule.ts +++ b/packages/react-native-executorch/src/hooks/useModule.ts @@ -74,10 +74,32 @@ export const useModule = < }; return { + /** + * Contains the error message if the model failed to load. + */ error, + + /** + * Indicates whether the model is ready. + */ isReady, + + /** + * Indicates whether the model is currently generating a response. + */ isGenerating, + + /** + * Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. + */ downloadProgress, + + /** + * This function runs the model's forward method with the provided input arguments. + * + * @param input - Input arguments for the model's forward method. + * @returns The output from the model's forward method. + */ forward, }; }; diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts index 9619547c8..26c3aa1e6 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts @@ -64,6 +64,13 @@ export class SpeechToTextModule { return new Float32Array(await this.nativeModule.encode(waveform)); } + /** + * Runs the decoder of the model. Passing number[] is deprecated. + * + * @param tokens - The input tokens. + * @param encoderOutput - The encoder output. + * @returns Decoded output. + */ public async decode( tokens: Int32Array | number[], encoderOutput: Float32Array | number[] @@ -85,6 +92,13 @@ export class SpeechToTextModule { ); } + /** + * Transcribes audio using the Whisper model. + * + * @param waveform - The Float32Array audio data. + * @param options - Decoding options including language. + * @returns The transcription string. + */ public async transcribe( waveform: Float32Array | number[], options: DecodingOptions = {} diff --git a/packages/react-native-executorch/src/types/common.ts b/packages/react-native-executorch/src/types/common.ts index 165e8fe7f..06cb64a4f 100644 --- a/packages/react-native-executorch/src/types/common.ts +++ b/packages/react-native-executorch/src/types/common.ts @@ -1,5 +1,15 @@ +/** + * Common types used across the React Native Executorch package. + */ + +/** + * Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). + */ export type ResourceSource = string | number | object; +/** + * Enum representing the scalar types of tensors. + */ export enum ScalarType { BYTE = 0, CHAR = 1, diff --git a/packages/react-native-executorch/src/types/llm.ts b/packages/react-native-executorch/src/types/llm.ts index 53b13cbd0..e15d36020 100644 --- a/packages/react-native-executorch/src/types/llm.ts +++ b/packages/react-native-executorch/src/types/llm.ts @@ -1,33 +1,141 @@ import { RnExecutorchError } from '../errors/errorUtils'; +/** + * React hook for managing a Large Language Model (LLM) instance. + */ export interface LLMType { + /** + * History containing all messages in conversation. This field is updated after model responds to sendMessage. + */ messageHistory: Message[]; + + /** + * State of the generated response. This field is updated with each token generated by the model. + */ response: string; + + /** + * The most recently generated token. + */ token: string; + + /** + * Indicates whether the model is ready. + */ isReady: boolean; + + /** + * Indicates whether the model is currently generating a response. + */ isGenerating: boolean; + + /** + * Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. + */ downloadProgress: number; + + /** + * Contains the error message if the model failed to load. + */ error: RnExecutorchError | null; + + /** + * Configures chat and tool calling. + * See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. + * + * @param configuration - Configuration object containing `chatConfig`, `toolsConfig`, and `generationConfig`. + */ configure: ({ chatConfig, toolsConfig, generationConfig, }: { + /** + * Object configuring chat management, contains following properties: + * + * `systemPrompt` - Often used to tell the model what is its purpose, for example - "Be a helpful translator". + * + * `initialMessageHistory` - An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. + * + * `contextWindowLength` - The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. + */ chatConfig?: Partial; + + /** + * Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: + * + * `tools` - List of objects defining tools. + * + * `executeToolCallback` - Function that accepts `ToolCall`, executes tool and returns the string to model. + * + * `displayToolCalls` - If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. + */ toolsConfig?: ToolsConfig; + + /** + * Object configuring generation settings. + * + * `outputTokenBatchSize` - Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). + * + * `batchTimeInterval` - Upper limit on the time interval between consecutive token batches. + * + * `temperature` - Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. + * + * `topp` - Only samples from the smallest set of tokens whose cumulative probability exceeds topp. + */ generationConfig?: GenerationConfig; }) => void; + + /** + * Returns the number of tokens generated so far in the current generation. + * @returns The count of generated tokens. + */ getGeneratedTokenCount: () => number; + + /** + * Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. + * @param messages - Array of messages representing the chat history. + * @param tools - Optional array of tools that can be used during generation. + */ generate: (messages: Message[], tools?: LLMTool[]) => Promise; + + /** + * Function to add user message to conversation. + * After model responds, `messageHistory` will be updated with both user message and model response. + * @param message - The message string to send. + */ sendMessage: (message: string) => Promise; + + /** + * Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. + * @param index - The index of the message to delete from history. + * @returns + */ deleteMessage: (index: number) => void; + + /** + * Function to interrupt the current inference. + */ interrupt: () => void; } +/** + * Roles that a message sender can have. + */ export type MessageRole = 'user' | 'assistant' | 'system'; +/** + * Represents a message in the conversation. + */ export interface Message { + /** + * Role of the message sender of type `MessageRole`. + */ role: MessageRole; + + /** + * Content of the message. + */ content: string; } @@ -40,22 +148,68 @@ export interface ToolCall { // unfortunately there's no one standard so it's hard to type it better export type LLMTool = Object; +/** + * Object configuring chat management. + */ export interface ChatConfig { + /** + * An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. + */ initialMessageHistory: Message[]; + + /** + * The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. + */ contextWindowLength: number; + + /** + * Often used to tell the model what is its purpose, for example - "Be a helpful translator". + */ systemPrompt: string; } +/** + * Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. + */ export interface ToolsConfig { + /** + * List of objects defining tools. + */ tools: LLMTool[]; + + /** + * Function that accepts `ToolCall`, executes tool and returns the string to model. + */ executeToolCallback: (call: ToolCall) => Promise; + + /** + * If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. + */ displayToolCalls?: boolean; } +/** + * Object configuring generation settings. + */ export interface GenerationConfig { + /** + * Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. + */ temperature?: number; + + /** + * Only samples from the smallest set of tokens whose cumulative probability exceeds topp. + */ topp?: number; + + /** + * Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). + */ outputTokenBatchSize?: number; + + /** + * Upper limit on the time interval between consecutive token batches. + */ batchTimeInterval?: number; } From 9206beaa87b5f357ed32715147abe02648589838 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Fri, 23 Jan 2026 18:02:15 +0100 Subject: [PATCH 04/15] Another hooks handled --- .../classes/ClassificationModule.md | 22 +- .../classes/ExecutorchModule.md | 22 +- .../classes/ImageEmbeddingsModule.md | 22 +- .../classes/ImageSegmentationModule.md | 22 +- .../06-api-reference/classes/LLMModule.md | 42 +- .../06-api-reference/classes/OCRModule.md | 14 +- .../classes/ObjectDetectionModule.md | 22 +- .../classes/ResourceFetcher.md | 34 +- .../classes/RnExecutorchError.md | 38 +- .../classes/SpeechToTextModule.md | 32 +- .../classes/StyleTransferModule.md | 22 +- .../classes/TextEmbeddingsModule.md | 22 +- .../classes/TextToImageModule.md | 28 +- .../classes/TokenizerModule.md | 26 +- .../06-api-reference/classes/VADModule.md | 22 +- .../classes/VerticalOCRModule.md | 14 +- .../enumerations/DeeplabLabel.md | 88 ++-- .../enumerations/RnExecutorchErrorCode.md | 168 ++++---- .../enumerations/ScalarType.md | 88 ++-- .../DEFAULT_STRUCTURED_OUTPUT_PROMPT.md | 6 +- .../fixAndValidateStructuredOutput.md | 4 +- .../functions/getStructuredOutputPrompt.md | 4 +- .../functions/useClassification.md | 2 +- .../functions/useExecutorchModule.md | 2 +- .../functions/useImageEmbeddings.md | 2 +- .../functions/useImageSegmentation.md | 2 +- .../docs/06-api-reference/functions/useLLM.md | 2 +- .../docs/06-api-reference/functions/useOCR.md | 2 +- .../functions/useObjectDetection.md | 2 +- .../functions/useSpeechToText.md | 142 +----- .../functions/useStyleTransfer.md | 2 +- .../functions/useTextEmbeddings.md | 52 +-- .../functions/useTextToImage.md | 2 +- .../functions/useTextToSpeech.md | 6 +- .../functions/useTokenizer.md | 102 +---- .../docs/06-api-reference/functions/useVAD.md | 2 +- .../functions/useVerticalOCR.md | 2 +- docs/docs/06-api-reference/index.md | 403 +++++++++--------- docs/docs/06-api-reference/interfaces/Bbox.md | 16 +- .../06-api-reference/interfaces/ChatConfig.md | 12 +- .../interfaces/DecodingOptions.md | 8 +- .../06-api-reference/interfaces/Detection.md | 12 +- .../interfaces/GenerationConfig.md | 16 +- .../interfaces/KokoroConfig.md | 46 ++ .../interfaces/KokoroOptions.md | 17 + .../interfaces/KokoroVoiceExtras.md | 19 + .../06-api-reference/interfaces/LLMType.md | 52 +-- .../06-api-reference/interfaces/Message.md | 8 +- .../06-api-reference/interfaces/OCRBbox.md | 8 +- .../interfaces/OCRDetection.md | 12 +- .../docs/06-api-reference/interfaces/Props.md | 8 +- .../06-api-reference/interfaces/Segment.md | 8 +- .../interfaces/SpeechToTextModelConfig.md | 26 +- .../interfaces/SpeechToTextType.md | 215 ++++++++++ .../06-api-reference/interfaces/TensorPtr.md | 12 +- .../interfaces/TextEmbeddingsType.md | 70 +++ .../interfaces/TextToSpeechConfig.md | 35 ++ .../interfaces/TextToSpeechInput.md | 29 ++ .../interfaces/TextToSpeechStreamingInput.md | 90 ++++ .../interfaces/TokenizerType.md | 161 +++++++ .../06-api-reference/interfaces/ToolCall.md | 8 +- .../interfaces/ToolsConfig.md | 12 +- .../interfaces/VoiceConfig.md | 37 ++ .../06-api-reference/type-aliases/LLMTool.md | 2 +- .../type-aliases/MessageRole.md | 2 +- .../type-aliases/OCRLanguage.md | 4 +- .../type-aliases/ResourceSource.md | 2 +- .../type-aliases/SpeechToTextLanguage.md | 2 +- .../type-aliases/TensorBuffer.md | 2 +- .../type-aliases/TextToSpeechLanguage.md | 5 + .../docs/06-api-reference/typedoc-sidebar.cjs | 2 +- .../variables/ALL_MINILM_L6_V2.md | 6 +- .../variables/ALL_MPNET_BASE_V2.md | 6 +- .../variables/BK_SDM_TINY_VPRED_256.md | 6 +- .../variables/BK_SDM_TINY_VPRED_512.md | 6 +- .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 6 +- .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 6 +- .../variables/DEEPLAB_V3_RESNET50.md | 6 +- .../variables/DEFAULT_CHAT_CONFIG.md | 6 +- .../DEFAULT_CONTEXT_WINDOW_LENGTH.md | 6 +- .../variables/DEFAULT_MESSAGE_HISTORY.md | 6 +- .../variables/DEFAULT_SYSTEM_PROMPT.md | 6 +- .../variables/EFFICIENTNET_V2_S.md | 6 +- .../06-api-reference/variables/FSMN_VAD.md | 6 +- .../variables/HAMMER2_1_0_5B.md | 6 +- .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 6 +- .../variables/HAMMER2_1_1_5B.md | 6 +- .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 6 +- .../variables/HAMMER2_1_3B.md | 6 +- .../variables/HAMMER2_1_3B_QUANTIZED.md | 6 +- .../06-api-reference/variables/KOKORO_EN.md | 6 +- .../variables/KOKORO_VOICE_AF_HEART.md | 6 +- .../variables/KOKORO_VOICE_AF_RIVER.md | 6 +- .../variables/KOKORO_VOICE_AF_SARAH.md | 6 +- .../variables/KOKORO_VOICE_AM_ADAM.md | 6 +- .../variables/KOKORO_VOICE_AM_MICHAEL.md | 6 +- .../variables/KOKORO_VOICE_AM_SANTA.md | 6 +- .../variables/KOKORO_VOICE_BF_EMMA.md | 6 +- .../variables/KOKORO_VOICE_BM_DANIEL.md | 6 +- .../06-api-reference/variables/LLAMA3_2_1B.md | 6 +- .../variables/LLAMA3_2_1B_QLORA.md | 6 +- .../variables/LLAMA3_2_1B_SPINQUANT.md | 6 +- .../06-api-reference/variables/LLAMA3_2_3B.md | 6 +- .../variables/LLAMA3_2_3B_QLORA.md | 6 +- .../variables/LLAMA3_2_3B_SPINQUANT.md | 6 +- .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 6 +- .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 6 +- .../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 | 6 +- .../variables/PHI_4_MINI_4B_QUANTIZED.md | 6 +- .../variables/QWEN2_5_0_5B.md | 6 +- .../variables/QWEN2_5_0_5B_QUANTIZED.md | 6 +- .../variables/QWEN2_5_1_5B.md | 6 +- .../variables/QWEN2_5_1_5B_QUANTIZED.md | 6 +- .../06-api-reference/variables/QWEN2_5_3B.md | 6 +- .../variables/QWEN2_5_3B_QUANTIZED.md | 6 +- .../06-api-reference/variables/QWEN3_0_6B.md | 6 +- .../variables/QWEN3_0_6B_QUANTIZED.md | 6 +- .../06-api-reference/variables/QWEN3_1_7B.md | 6 +- .../variables/QWEN3_1_7B_QUANTIZED.md | 6 +- .../06-api-reference/variables/QWEN3_4B.md | 6 +- .../variables/QWEN3_4B_QUANTIZED.md | 6 +- .../variables/SMOLLM2_1_135M.md | 6 +- .../variables/SMOLLM2_1_135M_QUANTIZED.md | 6 +- .../variables/SMOLLM2_1_1_7B.md | 6 +- .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 6 +- .../variables/SMOLLM2_1_360M.md | 6 +- .../variables/SMOLLM2_1_360M_QUANTIZED.md | 6 +- .../variables/SPECIAL_TOKENS.md | 34 +- .../SSDLITE_320_MOBILENET_V3_LARGE.md | 6 +- .../variables/STYLE_TRANSFER_CANDY.md | 6 +- .../variables/STYLE_TRANSFER_MOSAIC.md | 6 +- .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 6 +- .../variables/STYLE_TRANSFER_UDNIE.md | 6 +- .../variables/VERTICAL_OCR_ABAZA.md | 6 +- .../variables/VERTICAL_OCR_ADYGHE.md | 6 +- .../variables/VERTICAL_OCR_AFRIKAANS.md | 6 +- .../variables/VERTICAL_OCR_ALBANIAN.md | 6 +- .../variables/VERTICAL_OCR_AVAR.md | 6 +- .../variables/VERTICAL_OCR_AZERBAIJANI.md | 6 +- .../variables/VERTICAL_OCR_BELARUSIAN.md | 6 +- .../variables/VERTICAL_OCR_BOSNIAN.md | 6 +- .../variables/VERTICAL_OCR_BULGARIAN.md | 6 +- .../variables/VERTICAL_OCR_CHECHEN.md | 6 +- .../variables/VERTICAL_OCR_CROATIAN.md | 6 +- .../variables/VERTICAL_OCR_CZECH.md | 6 +- .../variables/VERTICAL_OCR_DANISH.md | 6 +- .../variables/VERTICAL_OCR_DARGWA.md | 6 +- .../variables/VERTICAL_OCR_DUTCH.md | 6 +- .../variables/VERTICAL_OCR_ENGLISH.md | 6 +- .../variables/VERTICAL_OCR_ESTONIAN.md | 6 +- .../variables/VERTICAL_OCR_FRENCH.md | 6 +- .../variables/VERTICAL_OCR_GERMAN.md | 6 +- .../variables/VERTICAL_OCR_HUNGARIAN.md | 6 +- .../variables/VERTICAL_OCR_ICELANDIC.md | 6 +- .../variables/VERTICAL_OCR_INDONESIAN.md | 6 +- .../variables/VERTICAL_OCR_INGUSH.md | 6 +- .../variables/VERTICAL_OCR_IRISH.md | 6 +- .../variables/VERTICAL_OCR_ITALIAN.md | 6 +- .../variables/VERTICAL_OCR_JAPANESE.md | 6 +- .../variables/VERTICAL_OCR_KANNADA.md | 6 +- .../variables/VERTICAL_OCR_KARBADIAN.md | 6 +- .../variables/VERTICAL_OCR_KOREAN.md | 6 +- .../variables/VERTICAL_OCR_KURDISH.md | 6 +- .../variables/VERTICAL_OCR_LAK.md | 6 +- .../variables/VERTICAL_OCR_LATIN.md | 6 +- .../variables/VERTICAL_OCR_LATVIAN.md | 6 +- .../variables/VERTICAL_OCR_LEZGHIAN.md | 6 +- .../variables/VERTICAL_OCR_LITHUANIAN.md | 6 +- .../variables/VERTICAL_OCR_MALAY.md | 6 +- .../variables/VERTICAL_OCR_MALTESE.md | 6 +- .../variables/VERTICAL_OCR_MAORI.md | 6 +- .../variables/VERTICAL_OCR_MONGOLIAN.md | 6 +- .../variables/VERTICAL_OCR_NORWEGIAN.md | 6 +- .../variables/VERTICAL_OCR_OCCITAN.md | 6 +- .../variables/VERTICAL_OCR_PALI.md | 6 +- .../variables/VERTICAL_OCR_POLISH.md | 6 +- .../variables/VERTICAL_OCR_PORTUGUESE.md | 6 +- .../variables/VERTICAL_OCR_ROMANIAN.md | 6 +- .../variables/VERTICAL_OCR_RUSSIAN.md | 6 +- .../VERTICAL_OCR_SERBIAN_CYRILLIC.md | 6 +- .../variables/VERTICAL_OCR_SERBIAN_LATIN.md | 6 +- .../VERTICAL_OCR_SIMPLIFIED_CHINESE.md | 6 +- .../variables/VERTICAL_OCR_SLOVAK.md | 6 +- .../variables/VERTICAL_OCR_SLOVENIAN.md | 6 +- .../variables/VERTICAL_OCR_SPANISH.md | 6 +- .../variables/VERTICAL_OCR_SWAHILI.md | 6 +- .../variables/VERTICAL_OCR_SWEDISH.md | 6 +- .../variables/VERTICAL_OCR_TABASSARAN.md | 6 +- .../variables/VERTICAL_OCR_TAGALOG.md | 6 +- .../variables/VERTICAL_OCR_TAJIK.md | 6 +- .../variables/VERTICAL_OCR_TELUGU.md | 6 +- .../variables/VERTICAL_OCR_TURKISH.md | 6 +- .../variables/VERTICAL_OCR_UKRAINIAN.md | 6 +- .../variables/VERTICAL_OCR_UZBEK.md | 6 +- .../variables/VERTICAL_OCR_VIETNAMESE.md | 6 +- .../variables/VERTICAL_OCR_WELSH.md | 6 +- .../variables/WHISPER_BASE.md | 6 +- .../variables/WHISPER_BASE_EN.md | 6 +- .../variables/WHISPER_SMALL.md | 6 +- .../variables/WHISPER_SMALL_EN.md | 6 +- .../variables/WHISPER_TINY.md | 6 +- .../variables/WHISPER_TINY_EN.md | 6 +- .../variables/WHISPER_TINY_EN_QUANTIZED.md | 6 +- .../variables/parseToolCall.md | 2 +- .../useSpeechToText.ts | 56 +-- .../useTextEmbeddings.ts | 31 +- .../useTokenizer.ts | 19 +- packages/react-native-executorch/src/index.ts | 9 +- .../react-native-executorch/src/types/stt.ts | 107 +++++ .../src/types/textEmbeddings.ts | 56 +++ .../src/types/tokenizer.ts | 60 +++ 274 files changed, 2328 insertions(+), 1657 deletions(-) create mode 100644 docs/docs/06-api-reference/interfaces/KokoroConfig.md create mode 100644 docs/docs/06-api-reference/interfaces/KokoroOptions.md create mode 100644 docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md create mode 100644 docs/docs/06-api-reference/interfaces/SpeechToTextType.md create mode 100644 docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md create mode 100644 docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md create mode 100644 docs/docs/06-api-reference/interfaces/TextToSpeechInput.md create mode 100644 docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md create mode 100644 docs/docs/06-api-reference/interfaces/TokenizerType.md create mode 100644 docs/docs/06-api-reference/interfaces/VoiceConfig.md create mode 100644 docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md create mode 100644 packages/react-native-executorch/src/types/textEmbeddings.ts create mode 100644 packages/react-native-executorch/src/types/tokenizer.ts diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index 9c6c9b9af..61bf46610 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,6 @@ # Class: ClassificationModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Classi > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -48,13 +48,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http `BaseModule.delete` ---- +*** ### forward() > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) #### Parameters @@ -66,13 +66,13 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Classi `Promise`\<`any`\> ---- +*** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -88,13 +88,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http `BaseModule.forwardET` ---- +*** ### getInputShape() > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -114,13 +114,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `BaseModule.getInputShape` ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index 30aae9ab0..e7214a4bf 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -1,6 +1,6 @@ # Class: ExecutorchModule -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -48,13 +48,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http `BaseModule.delete` ---- +*** ### forward() > **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L26) #### Parameters @@ -66,13 +66,13 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> ---- +*** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -88,13 +88,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http `BaseModule.forwardET` ---- +*** ### getInputShape() > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -114,13 +114,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `BaseModule.getInputShape` ---- +*** ### load() > **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md index 60d4d5307..ba9e003d1 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: ImageEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageE > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -48,13 +48,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http `BaseModule.delete` ---- +*** ### forward() > **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) #### Parameters @@ -66,13 +66,13 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageE `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> ---- +*** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -88,13 +88,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http `BaseModule.forwardET` ---- +*** ### getInputShape() > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -114,13 +114,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `BaseModule.getInputShape` ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md index f7119293b..9a1778e46 100644 --- a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -1,6 +1,6 @@ # Class: ImageSegmentationModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageS > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -48,13 +48,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http `BaseModule.delete` ---- +*** ### forward() > **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) #### Parameters @@ -74,13 +74,13 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageS `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> ---- +*** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -96,13 +96,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http `BaseModule.forwardET` ---- +*** ### getInputShape() > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -122,13 +122,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `BaseModule.getInputShape` ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md index 297065665..cac3cd483 100644 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -1,6 +1,6 @@ # Class: LLMModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L11) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L11) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **new LLMModule**(`__namedParameters`): `LLMModule` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **configure**(`__namedParameters`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L52) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L52) #### Parameters @@ -58,25 +58,25 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `void` ---- +*** ### delete() > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:92](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L92) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:92](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L92) #### Returns `void` ---- +*** ### deleteMessage() > **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:79](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L79) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:79](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L79) #### Parameters @@ -88,13 +88,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce [`Message`](../interfaces/Message.md)[] ---- +*** ### forward() > **forward**(`input`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L64) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L64) #### Parameters @@ -106,13 +106,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<`string`\> ---- +*** ### generate() > **generate**(`messages`, `tools?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L69) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L69) #### Parameters @@ -128,37 +128,37 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<`string`\> ---- +*** ### getGeneratedTokenCount() > **getGeneratedTokenCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) #### Returns `number` ---- +*** ### interrupt() > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:84](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L84) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:84](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L84) #### Returns `void` ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L30) #### Parameters @@ -184,13 +184,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<`void`\> ---- +*** ### sendMessage() > **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) #### Parameters @@ -202,13 +202,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<[`Message`](../interfaces/Message.md)[]\> ---- +*** ### setTokenCallback() > **setTokenCallback**(`__namedParameters`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L44) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L44) #### Parameters diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md index a31c51a4e..b120ced2c 100644 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -1,6 +1,6 @@ # Class: OCRModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRMod > **new OCRModule**(): `OCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) #### Returns @@ -20,19 +20,19 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRMod > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) #### Returns `void` ---- +*** ### forward() > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) #### Parameters @@ -44,13 +44,13 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRMod `Promise`\<`any`\> ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index 6cf8c8479..582321721 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -1,6 +1,6 @@ # Class: ObjectDetectionModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Object > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -48,13 +48,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http `BaseModule.delete` ---- +*** ### forward() > **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) #### Parameters @@ -70,13 +70,13 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Object `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> ---- +*** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -92,13 +92,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http `BaseModule.forwardET` ---- +*** ### getInputShape() > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -118,13 +118,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `BaseModule.getInputShape` ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md index 96f4bc582..b9c9b40fd 100644 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -1,6 +1,6 @@ # Class: ResourceFetcher -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](h > `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](h > `static` **cancelFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) #### Parameters @@ -38,13 +38,13 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251]( `Promise`\<`void`\> ---- +*** ### deleteResources() > `static` **deleteResources**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) #### Parameters @@ -56,13 +56,13 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278]( `Promise`\<`void`\> ---- +*** ### fetch() > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) #### Parameters @@ -78,13 +78,13 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](h `Promise`\<`string`[] \| `null`\> ---- +*** ### getFilesTotalSize() > `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) #### Parameters @@ -96,37 +96,37 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290]( `Promise`\<`number`\> ---- +*** ### listDownloadedFiles() > `static` **listDownloadedFiles**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) #### Returns `Promise`\<`string`[]\> ---- +*** ### listDownloadedModels() > `static` **listDownloadedModels**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) #### Returns `Promise`\<`string`[]\> ---- +*** ### pauseFetching() > `static` **pauseFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) #### Parameters @@ -138,13 +138,13 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241]( `Promise`\<`void`\> ---- +*** ### resumeFetching() > `static` **resumeFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) #### Parameters diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md index 498f943cc..d525c968c 100644 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -1,6 +1,6 @@ # Class: RnExecutorchError -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/errorUtils.ts#L3) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/errorUtils.ts#L3) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https: > **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/errorUtils.ts#L14) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/errorUtils.ts#L14) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https > `optional` **cause**: `unknown` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/errorUtils.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/errorUtils.ts#L12) The original cause of the error, if any. @@ -50,59 +50,59 @@ The original cause of the error, if any. `Error.cause` ---- +*** ### code > **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/errorUtils.ts#L7) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/errorUtils.ts#L7) The error code representing the type of error. ---- +*** ### message > **message**: `string` -Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077 +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 #### Inherited from `Error.message` ---- +*** ### name > **name**: `string` -Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from `Error.name` ---- +*** ### stack? > `optional` **stack**: `string` -Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078 +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 #### Inherited from `Error.stack` ---- +*** ### stackTraceLimit > `static` **stackTraceLimit**: `number` -Defined in: node_modules/@types/node/globals.d.ts:68 +Defined in: node\_modules/@types/node/globals.d.ts:68 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -124,7 +124,7 @@ not capture any frames. > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node_modules/@types/node/globals.d.ts:52 +Defined in: node\_modules/@types/node/globals.d.ts:52 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -133,7 +133,7 @@ a string representing the location in the code at which ```js const myObject = {}; Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` +myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with @@ -188,13 +188,13 @@ a(); `Error.captureStackTrace` ---- +*** ### isError() > `static` **isError**(`error`): `error is Error` -Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23 +Defined in: node\_modules/typescript/lib/lib.esnext.error.d.ts:23 Indicates whether the argument provided is a built-in Error instance or not. @@ -212,13 +212,13 @@ Indicates whether the argument provided is a built-in Error instance or not. `Error.isError` ---- +*** ### prepareStackTrace() > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` -Defined in: node_modules/@types/node/globals.d.ts:56 +Defined in: node\_modules/@types/node/globals.d.ts:56 #### Parameters diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md index ff834692d..202038361 100644 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -1,6 +1,6 @@ # Class: SpeechToTextModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L7) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L74) Runs the decoder of the model. Passing number[] is deprecated. @@ -42,25 +42,25 @@ The encoder output. Decoded output. ---- +*** ### delete() > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L51) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L51) #### Returns `void` ---- +*** ### encode() > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L55) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L55) #### Parameters @@ -72,13 +72,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L17) #### Parameters @@ -94,13 +94,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<`void`\> ---- +*** ### stream() > **stream**(`options`): `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:121](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L121) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:121](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L121) #### Parameters @@ -112,13 +112,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> ---- +*** ### streamInsert() > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:176](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L176) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:176](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L176) #### Parameters @@ -130,25 +130,25 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `void` ---- +*** ### streamStop() > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:186](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L186) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:186](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L186) #### Returns `void` ---- +*** ### transcribe() > **transcribe**(`waveform`, `options`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts:102](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L102) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:102](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L102) Transcribes audio using the Whisper model. diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index 4ac103def..d595a7bff 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,6 @@ # Class: StyleTransferModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleT > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -48,13 +48,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http `BaseModule.delete` ---- +*** ### forward() > **forward**(`imageSource`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) #### Parameters @@ -66,13 +66,13 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleT `Promise`\<`string`\> ---- +*** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -88,13 +88,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http `BaseModule.forwardET` ---- +*** ### getInputShape() > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -114,13 +114,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `BaseModule.getInputShape` ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index 505508afe..0457a196e 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: TextEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -48,13 +48,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http `BaseModule.delete` ---- +*** ### forward() > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L35) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L35) #### Parameters @@ -66,13 +66,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> ---- +*** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -88,13 +88,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http `BaseModule.forwardET` ---- +*** ### getInputShape() > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -114,13 +114,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `BaseModule.getInputShape` ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index 461441771..8e58e0f64 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -1,6 +1,6 @@ # Class: TextToImageModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextTo > **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) #### Parameters @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextTo > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -56,13 +56,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http `BaseModule.delete` ---- +*** ### forward() > **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) #### Parameters @@ -86,13 +86,13 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextTo `Promise`\<`string`\> ---- +*** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -108,13 +108,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http `BaseModule.forwardET` ---- +*** ### getInputShape() > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -134,25 +134,25 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `BaseModule.getInputShape` ---- +*** ### interrupt() > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) #### Returns `void` ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md index 807e131f5..c58a23835 100644 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -1,6 +1,6 @@ # Class: TokenizerModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **nativeModule**: `any` -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L7) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L31) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L31) #### Parameters @@ -42,13 +42,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<`any`\> ---- +*** ### encode() > **encode**(`s`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L27) #### Parameters @@ -60,25 +60,25 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<`any`\> ---- +*** ### getVocabSize() > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L38) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L38) #### Returns `Promise`\<`number`\> ---- +*** ### idToToken() > **idToToken**(`tokenId`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L42) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L42) #### Parameters @@ -90,13 +90,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<`string`\> ---- +*** ### load() > **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L9) #### Parameters @@ -114,13 +114,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<`void`\> ---- +*** ### tokenToId() > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L46) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L46) #### Parameters diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index 4410ad91f..c426e473d 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -1,6 +1,6 @@ # Class: VADModule -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -48,13 +48,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http `BaseModule.delete` ---- +*** ### forward() > **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L26) #### Parameters @@ -66,13 +66,13 @@ Defined in: [packages/react-native-executorch/src/modules/natural_language_proce `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> ---- +*** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -88,13 +88,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http `BaseModule.forwardET` ---- +*** ### getInputShape() > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -114,13 +114,13 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `BaseModule.getInputShape` ---- +*** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md index cf6c8de6a..ff4f81fb6 100644 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -1,6 +1,6 @@ # Class: VerticalOCRModule -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Vertic > **new VerticalOCRModule**(): `VerticalOCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) #### Returns @@ -20,19 +20,19 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Vertic > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) #### Returns `void` ---- +*** ### forward() > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) #### Parameters @@ -44,13 +44,13 @@ Defined in: [packages/react-native-executorch/src/modules/computer_vision/Vertic `Promise`\<`any`\> ---- +*** ### load() > **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md index 7b94664e3..4bb33004f 100644 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -1,6 +1,6 @@ # Enumeration: DeeplabLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L2) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L2) ## Enumeration Members @@ -8,172 +8,172 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2]( > **AEROPLANE**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L4) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L4) ---- +*** ### ARGMAX > **ARGMAX**: `21` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) ---- +*** ### BACKGROUND > **BACKGROUND**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L3) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L3) ---- +*** ### BICYCLE > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) ---- +*** ### BIRD > **BIRD**: `3` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) ---- +*** ### BOAT > **BOAT**: `4` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) ---- +*** ### BOTTLE > **BOTTLE**: `5` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) ---- +*** ### BUS > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) ---- +*** ### CAR > **CAR**: `7` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) ---- +*** ### CAT > **CAT**: `8` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) ---- +*** ### CHAIR > **CHAIR**: `9` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) ---- +*** ### COW > **COW**: `10` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) ---- +*** ### DININGTABLE > **DININGTABLE**: `11` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) ---- +*** ### DOG > **DOG**: `12` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) ---- +*** ### HORSE > **HORSE**: `13` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) ---- +*** ### MOTORBIKE > **MOTORBIKE**: `14` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) ---- +*** ### PERSON > **PERSON**: `15` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) ---- +*** ### POTTEDPLANT > **POTTEDPLANT**: `16` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) ---- +*** ### SHEEP > **SHEEP**: `17` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) ---- +*** ### SOFA > **SOFA**: `18` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) ---- +*** ### TRAIN > **TRAIN**: `19` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) ---- +*** ### TVMONITOR > **TVMONITOR**: `20` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md index 43d96983b..af468b85d 100644 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -1,6 +1,6 @@ # Enumeration: RnExecutorchErrorCode -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) ## Enumeration Members @@ -8,380 +8,380 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https: > **AccessFailed**: `34` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) ---- +*** ### DelegateInvalidCompatibility > **DelegateInvalidCompatibility**: `48` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) ---- +*** ### DelegateInvalidHandle > **DelegateInvalidHandle**: `50` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) ---- +*** ### DelegateMemoryAllocationFailed > **DelegateMemoryAllocationFailed**: `49` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) ---- +*** ### DownloadInterrupted > **DownloadInterrupted**: `118` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) Thrown when the number of downloaded files is unexpected, due to download interruptions. ---- +*** ### EndOfMethod > **EndOfMethod**: `3` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) ---- +*** ### FileReadFailed > **FileReadFailed**: `114` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. ---- +*** ### FileWriteFailed > **FileWriteFailed**: `103` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) An error ocurred when saving a file. This could be, for instance a result image from an image model. ---- +*** ### Internal > **Internal**: `1` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) ---- +*** ### InvalidArgument > **InvalidArgument**: `18` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) ---- +*** ### InvalidConfig > **InvalidConfig**: `112` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. ---- +*** ### InvalidExternalData > **InvalidExternalData**: `36` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) ---- +*** ### InvalidModelOutput > **InvalidModelOutput**: `115` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) Thrown when the size of model output is unexpected. ---- +*** ### InvalidModelSource > **InvalidModelSource**: `255` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) Thrown when the type of model source passed by the user is invalid. ---- +*** ### InvalidProgram > **InvalidProgram**: `35` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) ---- +*** ### InvalidState > **InvalidState**: `2` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) ---- +*** ### InvalidType > **InvalidType**: `19` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) ---- +*** ### InvalidUserInput > **InvalidUserInput**: `117` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). ---- +*** ### LanguageNotSupported > **LanguageNotSupported**: `105` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. ---- +*** ### MemoryAllocationFailed > **MemoryAllocationFailed**: `33` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) ---- +*** ### MissingDataChunk > **MissingDataChunk**: `161` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) Thrown when streaming transcription is attempted but audio data chunk is missing. ---- +*** ### ModelGenerating > **ModelGenerating**: `104` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. ---- +*** ### ModuleNotLoaded > **ModuleNotLoaded**: `102` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. ---- +*** ### MultilingualConfiguration > **MultilingualConfiguration**: `160` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. ---- +*** ### NotFound > **NotFound**: `32` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) ---- +*** ### NotImplemented > **NotImplemented**: `17` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) ---- +*** ### NotSupported > **NotSupported**: `16` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) ---- +*** ### Ok > **Ok**: `0` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) ---- +*** ### OperatorMissing > **OperatorMissing**: `20` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) ---- +*** ### OutOfResources > **OutOfResources**: `37` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) ---- +*** ### ResourceFetcherAlreadyOngoing > **ResourceFetcherAlreadyOngoing**: `183` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) Thrown when trying to resume a download that is already ongoing. ---- +*** ### ResourceFetcherAlreadyPaused > **ResourceFetcherAlreadyPaused**: `182` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) Thrown when trying to pause a download that is already paused. ---- +*** ### ResourceFetcherDownloadFailed > **ResourceFetcherDownloadFailed**: `180` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. ---- +*** ### ResourceFetcherDownloadInProgress > **ResourceFetcherDownloadInProgress**: `181` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) Thrown when a user tries to trigger a download that's already in progress. ---- +*** ### ResourceFetcherMissingUri > **ResourceFetcherMissingUri**: `185` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) Thrown when required URI information is missing for a download operation. ---- +*** ### ResourceFetcherNotActive > **ResourceFetcherNotActive**: `184` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) Thrown when trying to pause, resume, or cancel a download that is not active. ---- +*** ### StreamingInProgress > **StreamingInProgress**: `163` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) Thrown when trying to start a new streaming session while another is already in progress. ---- +*** ### StreamingNotStarted > **StreamingNotStarted**: `162` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) Thrown when trying to stop or insert data into a stream that hasn't been started. ---- +*** ### ThreadPoolError > **ThreadPoolError**: `113` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) Thrown when React Native ExecuTorch threadpool problem occurs. ---- +*** ### UnexpectedNumInputs > **UnexpectedNumInputs**: `97` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) Thrown when the number of passed inputs to the model is different than the model metadata specifies. ---- +*** ### UnknownError > **UnknownError**: `101` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. ---- +*** ### WrongDimensions > **WrongDimensions**: `116` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md index 8061a7e82..b6756109d 100644 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -1,6 +1,6 @@ # Enumeration: ScalarType -Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L13) +Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L13) Enum representing the scalar types of tensors. @@ -10,172 +10,172 @@ Enum representing the scalar types of tensors. > **BITS16**: `22` -Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L28) +Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L28) ---- +*** ### BOOL > **BOOL**: `11` -Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L22) +Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L22) ---- +*** ### BYTE > **BYTE**: `0` -Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L14) +Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L14) ---- +*** ### CHAR > **CHAR**: `1` -Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L15) +Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L15) ---- +*** ### DOUBLE > **DOUBLE**: `7` -Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L21) +Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L21) ---- +*** ### FLOAT > **FLOAT**: `6` -Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L20) +Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L20) ---- +*** ### FLOAT8E4M3FN > **FLOAT8E4M3FN**: `24` -Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L30) +Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L30) ---- +*** ### FLOAT8E4M3FNUZ > **FLOAT8E4M3FNUZ**: `26` -Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L32) +Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L32) ---- +*** ### FLOAT8E5M2 > **FLOAT8E5M2**: `23` -Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L29) +Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L29) ---- +*** ### FLOAT8E5M2FNUZ > **FLOAT8E5M2FNUZ**: `25` -Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L31) +Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L31) ---- +*** ### HALF > **HALF**: `5` -Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L19) +Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L19) ---- +*** ### INT > **INT**: `3` -Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L17) +Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L17) ---- +*** ### LONG > **LONG**: `4` -Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L18) +Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L18) ---- +*** ### QINT32 > **QINT32**: `14` -Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L25) +Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L25) ---- +*** ### QINT8 > **QINT8**: `12` -Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L23) +Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L23) ---- +*** ### QUINT2X4 > **QUINT2X4**: `17` -Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L27) +Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L27) ---- +*** ### QUINT4X2 > **QUINT4X2**: `16` -Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L26) +Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L26) ---- +*** ### QUINT8 > **QUINT8**: `13` -Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L24) +Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L24) ---- +*** ### SHORT > **SHORT**: `2` -Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L16) +Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L16) ---- +*** ### UINT16 > **UINT16**: `27` -Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L33) +Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L33) ---- +*** ### UINT32 > **UINT32**: `28` -Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L34) +Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L34) ---- +*** ### UINT64 > **UINT64**: `29` -Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L35) +Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L35) diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md index f1099868c..ccbef5de1 100644 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -1,8 +1,8 @@ -# Function: DEFAULT_STRUCTURED_OUTPUT_PROMPT() +# Function: DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT() -> **DEFAULT_STRUCTURED_OUTPUT_PROMPT**(`structuredOutputSchema`): `string` +> **DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT**(`structuredOutputSchema`): `string` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) ## Parameters diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md index 229f474f8..abc762c48 100644 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -2,13 +2,13 @@ > **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> -Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/llm.ts#L81) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/llm.ts#L81) ## Type Parameters ### T -`T` _extends_ `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> +`T` *extends* `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> ## Parameters diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md index c9b72f00a..2a2ff4903 100644 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -2,13 +2,13 @@ > **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` -Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/llm.ts#L50) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/llm.ts#L50) ## Type Parameters ### T -`T` _extends_ `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> +`T` *extends* `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> ## Parameters diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md index c216dab14..92efdf984 100644 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -2,7 +2,7 @@ > **useClassification**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L10) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md index cf4fa9c19..4e117fee4 100644 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -2,7 +2,7 @@ > **useExecutorchModule**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L10) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md index 34a5423f7..4b604041b 100644 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -2,7 +2,7 @@ > **useImageEmbeddings**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L10) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md index 41252d44c..6e5b227d3 100644 --- a/docs/docs/06-api-reference/functions/useImageSegmentation.md +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -2,7 +2,7 @@ > **useImageSegmentation**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L10) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md index 039804d9d..095563662 100644 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -2,7 +2,7 @@ > **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts:20](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L20) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L20) React hook for managing a Large Language Model (LLM) instance. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md index 1cae57bdd..210e2d717 100644 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -2,7 +2,7 @@ > **useOCR**(`__namedParameters`): `OCRModule` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L15) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md index f42855379..1266bbc23 100644 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -2,7 +2,7 @@ > **useObjectDetection**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L10) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md index fd28fd820..033434655 100644 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -1,8 +1,10 @@ # Function: useSpeechToText() -> **useSpeechToText**(`speechToTextConfiguration`): `object` +> **useSpeechToText**(`speechToTextConfiguration`): [`SpeechToTextType`](../interfaces/SpeechToTextType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts:12](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L12) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) + +React hook for managing a Speech to Text (STT) instance. ## Parameters @@ -32,138 +34,6 @@ Boolean that can prevent automatic model loading (and downloading the data if yo ## Returns -Ready to use Speech to Text model. - -### committedTranscription - -> **committedTranscription**: `string` - -Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. - -### decode() - -> **decode**: (...`args`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -Runs the decoder of the model. Passing `number[]` is deprecated. - -#### Parameters - -##### args - -...\[`number`[] \| `Int32Array`\<`ArrayBufferLike`\>, `number`[] \| `Float32Array`\<`ArrayBufferLike`\>\] - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -### downloadProgress - -> **downloadProgress**: `number` - -Tracks the progress of the model download process. - -### encode() - -> **encode**: (...`args`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. - -#### Parameters - -##### args - -...\[`number`[] \| `Float32Array`\<`ArrayBufferLike`\>\] - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -Contains the error message if the model failed to load. - -### isGenerating - -> **isGenerating**: `boolean` - -Indicates whether the model is currently processing an inference. - -### isReady - -> **isReady**: `boolean` - -Indicates whether the model has successfully loaded and is ready for inference. - -### nonCommittedTranscription - -> **nonCommittedTranscription**: `string` +[`SpeechToTextType`](../interfaces/SpeechToTextType.md) -Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. - -### stream() - -> **stream**: (`options?`) => `Promise`\<`string`\> - -Starts a streaming transcription process. Use in combination with `streamInsert` to feed audio chunks and `streamStop` to end the stream. The argument is an options object, e.g. `{ language: 'es' }` for multilingual models. Updates `committedTranscription` and `nonCommittedTranscription` as transcription progresses. - -#### Parameters - -##### options? - -[`DecodingOptions`](../interfaces/DecodingOptions.md) - -Decoding options including language. - -#### Returns - -`Promise`\<`string`\> - -### streamInsert() - -> **streamInsert**: (...`args`) => `void` - -Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Call this repeatedly as new audio data becomes available. Passing `number[]` is deprecated. - -#### Parameters - -##### args - -...\[`number`[] \| `Float32Array`\<`ArrayBufferLike`\>\] - -#### Returns - -`void` - -### streamStop() - -> **streamStop**: (...`args`) => `void` - -Stops the ongoing streaming transcription process. - -#### Parameters - -##### args - -...\[\] - -#### Returns - -`void` - -### transcribe() - -> **transcribe**: (...`args`) => `Promise`\<`string`\> - -Starts a transcription process for a given input array, which should be a waveform at 16kHz. The second argument is an options object, e.g. `{ language: 'es' }` for multilingual models. Resolves a promise with the output transcription when the model is finished. Passing `number[]` is deprecated. - -#### Parameters - -##### args - -...\[`number`[] \| `Float32Array`\<`ArrayBufferLike`\>, [`DecodingOptions`](../interfaces/DecodingOptions.md)\] - -#### Returns - -`Promise`\<`string`\> +Ready to use Speech to Text model. diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md index d0b6a6f48..d389774fe 100644 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -2,7 +2,7 @@ > **useStyleTransfer**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L10) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md index 2d2dd0f91..3bd623fc8 100644 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -1,8 +1,10 @@ # Function: useTextEmbeddings() -> **useTextEmbeddings**(`TextEmbeddingsConfiguration`): `object` +> **useTextEmbeddings**(`TextEmbeddingsConfiguration`): [`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:32](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L32) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) + +React hook for managing a Text Embeddings model instance. ## Parameters @@ -14,48 +16,6 @@ Configuration object containing `model` source and optional `preventLoad` flag. ## Returns -- Ready to use Text Embeddings model. - -### downloadProgress - -> **downloadProgress**: `number` - -Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -Contains the error message if the model failed to load. - -### forward() - -> **forward**: (...`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -This function runs the model's forward method with the provided input arguments. - -#### Parameters - -##### input - -...\[`string`\] - -Input arguments for the model's forward method. - -#### Returns - -`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> - -The output from the model's forward method. - -### isGenerating - -> **isGenerating**: `boolean` - -Indicates whether the model is currently generating a response. - -### isReady - -> **isReady**: `boolean` +[`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) -Indicates whether the model is ready. +Ready to use Text Embeddings model. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md index 4af61c6b7..1fe651b94 100644 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -2,7 +2,7 @@ > **useTextToImage**(`__namedParameters`): `TextToImageType` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L21) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L21) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md index 8f278a32b..34f452c58 100644 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -2,7 +2,7 @@ > **useTextToSpeech**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L15) ## Parameters @@ -30,7 +30,7 @@ Defined in: [packages/react-native-executorch/src/hooks/natural_language_process ##### input -`TextToSpeechInput` +[`TextToSpeechInput`](../interfaces/TextToSpeechInput.md) #### Returns @@ -52,7 +52,7 @@ Defined in: [packages/react-native-executorch/src/hooks/natural_language_process ##### input -`TextToSpeechStreamingInput` +[`TextToSpeechStreamingInput`](../interfaces/TextToSpeechStreamingInput.md) #### Returns diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md index 2581c282b..e82d5aa19 100644 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -1,111 +1,35 @@ # Function: useTokenizer() -> **useTokenizer**(`__namedParameters`): `object` +> **useTokenizer**(`tokenizerConfiguration`): [`TokenizerType`](../interfaces/TokenizerType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts:7](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L7) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L13) ## Parameters -### \_\_namedParameters +### tokenizerConfiguration + +Configuration object containing `tokenizer` source and optional `preventLoad` flag. #### preventLoad? `boolean` = `false` +Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. + #### tokenizer \{ `tokenizerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); \} +Object containing: + +`tokenizerSource` - A `ResourceSource` that specifies the location of the tokenizer. + #### tokenizer.tokenizerSource [`ResourceSource`](../type-aliases/ResourceSource.md) ## Returns -`object` - -### decode() - -> **decode**: (...`args`) => `Promise`\<`Promise`\<`any`\>\> - -#### Parameters - -##### args - -...\[`number`[], `boolean`\] - -#### Returns - -`Promise`\<`Promise`\<`any`\>\> - -### downloadProgress - -> **downloadProgress**: `number` - -### encode() - -> **encode**: (...`args`) => `Promise`\<`Promise`\<`any`\>\> - -#### Parameters - -##### args - -...\[`string`\] - -#### Returns - -`Promise`\<`Promise`\<`any`\>\> - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -### getVocabSize() - -> **getVocabSize**: (...`args`) => `Promise`\<`Promise`\<`number`\>\> - -#### Parameters - -##### args - -...\[\] - -#### Returns - -`Promise`\<`Promise`\<`number`\>\> - -### idToToken() - -> **idToToken**: (...`args`) => `Promise`\<`Promise`\<`string`\>\> - -#### Parameters - -##### args - -...\[`number`\] - -#### Returns - -`Promise`\<`Promise`\<`string`\>\> - -### isGenerating - -> **isGenerating**: `boolean` - -### isReady - -> **isReady**: `boolean` - -### tokenToId() - -> **tokenToId**: (...`args`) => `Promise`\<`Promise`\<`number`\>\> - -#### Parameters - -##### args - -...\[`string`\] - -#### Returns +[`TokenizerType`](../interfaces/TokenizerType.md) -`Promise`\<`Promise`\<`number`\>\> +Ready to use Tokenizer model. diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md index ad00ea6e8..cc9c3d2cb 100644 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -2,7 +2,7 @@ > **useVAD**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L10) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md index ceff29cb2..2cbcbd37f 100644 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -2,7 +2,7 @@ > **useVerticalOCR**(`__namedParameters`): `OCRModule` -Defined in: [packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L15) ## Parameters diff --git a/docs/docs/06-api-reference/index.md b/docs/docs/06-api-reference/index.md index 0377f3166..b7c7015ac 100644 --- a/docs/docs/06-api-reference/index.md +++ b/docs/docs/06-api-reference/index.md @@ -32,6 +32,9 @@ - [DecodingOptions](interfaces/DecodingOptions.md) - [Detection](interfaces/Detection.md) - [GenerationConfig](interfaces/GenerationConfig.md) +- [KokoroConfig](interfaces/KokoroConfig.md) +- [KokoroOptions](interfaces/KokoroOptions.md) +- [KokoroVoiceExtras](interfaces/KokoroVoiceExtras.md) - [LLMType](interfaces/LLMType.md) - [Message](interfaces/Message.md) - [OCRBbox](interfaces/OCRBbox.md) @@ -39,9 +42,16 @@ - [Props](interfaces/Props.md) - [Segment](interfaces/Segment.md) - [SpeechToTextModelConfig](interfaces/SpeechToTextModelConfig.md) +- [SpeechToTextType](interfaces/SpeechToTextType.md) - [TensorPtr](interfaces/TensorPtr.md) +- [TextEmbeddingsType](interfaces/TextEmbeddingsType.md) +- [TextToSpeechConfig](interfaces/TextToSpeechConfig.md) +- [TextToSpeechInput](interfaces/TextToSpeechInput.md) +- [TextToSpeechStreamingInput](interfaces/TextToSpeechStreamingInput.md) +- [TokenizerType](interfaces/TokenizerType.md) - [ToolCall](interfaces/ToolCall.md) - [ToolsConfig](interfaces/ToolsConfig.md) +- [VoiceConfig](interfaces/VoiceConfig.md) ## Type Aliases @@ -51,209 +61,210 @@ - [ResourceSource](type-aliases/ResourceSource.md) - [SpeechToTextLanguage](type-aliases/SpeechToTextLanguage.md) - [TensorBuffer](type-aliases/TensorBuffer.md) +- [TextToSpeechLanguage](type-aliases/TextToSpeechLanguage.md) ## Variables -- [ALL_MINILM_L6_V2](variables/ALL_MINILM_L6_V2.md) -- [ALL_MPNET_BASE_V2](variables/ALL_MPNET_BASE_V2.md) -- [BK_SDM_TINY_VPRED_256](variables/BK_SDM_TINY_VPRED_256.md) -- [BK_SDM_TINY_VPRED_512](variables/BK_SDM_TINY_VPRED_512.md) -- [CLIP_VIT_BASE_PATCH32_IMAGE](variables/CLIP_VIT_BASE_PATCH32_IMAGE.md) -- [CLIP_VIT_BASE_PATCH32_TEXT](variables/CLIP_VIT_BASE_PATCH32_TEXT.md) -- [DEEPLAB_V3_RESNET50](variables/DEEPLAB_V3_RESNET50.md) -- [DEFAULT_CHAT_CONFIG](variables/DEFAULT_CHAT_CONFIG.md) -- [DEFAULT_CONTEXT_WINDOW_LENGTH](variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md) -- [DEFAULT_MESSAGE_HISTORY](variables/DEFAULT_MESSAGE_HISTORY.md) -- [DEFAULT_SYSTEM_PROMPT](variables/DEFAULT_SYSTEM_PROMPT.md) -- [EFFICIENTNET_V2_S](variables/EFFICIENTNET_V2_S.md) -- [FSMN_VAD](variables/FSMN_VAD.md) -- [HAMMER2_1_0_5B](variables/HAMMER2_1_0_5B.md) -- [HAMMER2_1_0_5B_QUANTIZED](variables/HAMMER2_1_0_5B_QUANTIZED.md) -- [HAMMER2_1_1_5B](variables/HAMMER2_1_1_5B.md) -- [HAMMER2_1_1_5B_QUANTIZED](variables/HAMMER2_1_1_5B_QUANTIZED.md) -- [HAMMER2_1_3B](variables/HAMMER2_1_3B.md) -- [HAMMER2_1_3B_QUANTIZED](variables/HAMMER2_1_3B_QUANTIZED.md) -- [KOKORO_EN](variables/KOKORO_EN.md) -- [KOKORO_VOICE_AF_HEART](variables/KOKORO_VOICE_AF_HEART.md) -- [KOKORO_VOICE_AF_RIVER](variables/KOKORO_VOICE_AF_RIVER.md) -- [KOKORO_VOICE_AF_SARAH](variables/KOKORO_VOICE_AF_SARAH.md) -- [KOKORO_VOICE_AM_ADAM](variables/KOKORO_VOICE_AM_ADAM.md) -- [KOKORO_VOICE_AM_MICHAEL](variables/KOKORO_VOICE_AM_MICHAEL.md) -- [KOKORO_VOICE_AM_SANTA](variables/KOKORO_VOICE_AM_SANTA.md) -- [KOKORO_VOICE_BF_EMMA](variables/KOKORO_VOICE_BF_EMMA.md) -- [KOKORO_VOICE_BM_DANIEL](variables/KOKORO_VOICE_BM_DANIEL.md) -- [LLAMA3_2_1B](variables/LLAMA3_2_1B.md) -- [LLAMA3_2_1B_QLORA](variables/LLAMA3_2_1B_QLORA.md) -- [LLAMA3_2_1B_SPINQUANT](variables/LLAMA3_2_1B_SPINQUANT.md) -- [LLAMA3_2_3B](variables/LLAMA3_2_3B.md) -- [LLAMA3_2_3B_QLORA](variables/LLAMA3_2_3B_QLORA.md) -- [LLAMA3_2_3B_SPINQUANT](variables/LLAMA3_2_3B_SPINQUANT.md) -- [MULTI_QA_MINILM_L6_COS_V1](variables/MULTI_QA_MINILM_L6_COS_V1.md) -- [MULTI_QA_MPNET_BASE_DOT_V1](variables/MULTI_QA_MPNET_BASE_DOT_V1.md) -- [OCR_ABAZA](variables/OCR_ABAZA.md) -- [OCR_ADYGHE](variables/OCR_ADYGHE.md) -- [OCR_AFRIKAANS](variables/OCR_AFRIKAANS.md) -- [OCR_ALBANIAN](variables/OCR_ALBANIAN.md) -- [OCR_AVAR](variables/OCR_AVAR.md) -- [OCR_AZERBAIJANI](variables/OCR_AZERBAIJANI.md) -- [OCR_BELARUSIAN](variables/OCR_BELARUSIAN.md) -- [OCR_BOSNIAN](variables/OCR_BOSNIAN.md) -- [OCR_BULGARIAN](variables/OCR_BULGARIAN.md) -- [OCR_CHECHEN](variables/OCR_CHECHEN.md) -- [OCR_CROATIAN](variables/OCR_CROATIAN.md) -- [OCR_CZECH](variables/OCR_CZECH.md) -- [OCR_DANISH](variables/OCR_DANISH.md) -- [OCR_DARGWA](variables/OCR_DARGWA.md) -- [OCR_DUTCH](variables/OCR_DUTCH.md) -- [OCR_ENGLISH](variables/OCR_ENGLISH.md) -- [OCR_ESTONIAN](variables/OCR_ESTONIAN.md) -- [OCR_FRENCH](variables/OCR_FRENCH.md) -- [OCR_GERMAN](variables/OCR_GERMAN.md) -- [OCR_HUNGARIAN](variables/OCR_HUNGARIAN.md) -- [OCR_ICELANDIC](variables/OCR_ICELANDIC.md) -- [OCR_INDONESIAN](variables/OCR_INDONESIAN.md) -- [OCR_INGUSH](variables/OCR_INGUSH.md) -- [OCR_IRISH](variables/OCR_IRISH.md) -- [OCR_ITALIAN](variables/OCR_ITALIAN.md) -- [OCR_JAPANESE](variables/OCR_JAPANESE.md) -- [OCR_KANNADA](variables/OCR_KANNADA.md) -- [OCR_KARBADIAN](variables/OCR_KARBADIAN.md) -- [OCR_KOREAN](variables/OCR_KOREAN.md) -- [OCR_KURDISH](variables/OCR_KURDISH.md) -- [OCR_LAK](variables/OCR_LAK.md) -- [OCR_LATIN](variables/OCR_LATIN.md) -- [OCR_LATVIAN](variables/OCR_LATVIAN.md) -- [OCR_LEZGHIAN](variables/OCR_LEZGHIAN.md) -- [OCR_LITHUANIAN](variables/OCR_LITHUANIAN.md) -- [OCR_MALAY](variables/OCR_MALAY.md) -- [OCR_MALTESE](variables/OCR_MALTESE.md) -- [OCR_MAORI](variables/OCR_MAORI.md) -- [OCR_MONGOLIAN](variables/OCR_MONGOLIAN.md) -- [OCR_NORWEGIAN](variables/OCR_NORWEGIAN.md) -- [OCR_OCCITAN](variables/OCR_OCCITAN.md) -- [OCR_PALI](variables/OCR_PALI.md) -- [OCR_POLISH](variables/OCR_POLISH.md) -- [OCR_PORTUGUESE](variables/OCR_PORTUGUESE.md) -- [OCR_ROMANIAN](variables/OCR_ROMANIAN.md) -- [OCR_RUSSIAN](variables/OCR_RUSSIAN.md) -- [OCR_SERBIAN_CYRILLIC](variables/OCR_SERBIAN_CYRILLIC.md) -- [OCR_SERBIAN_LATIN](variables/OCR_SERBIAN_LATIN.md) -- [OCR_SIMPLIFIED_CHINESE](variables/OCR_SIMPLIFIED_CHINESE.md) -- [OCR_SLOVAK](variables/OCR_SLOVAK.md) -- [OCR_SLOVENIAN](variables/OCR_SLOVENIAN.md) -- [OCR_SPANISH](variables/OCR_SPANISH.md) -- [OCR_SWAHILI](variables/OCR_SWAHILI.md) -- [OCR_SWEDISH](variables/OCR_SWEDISH.md) -- [OCR_TABASSARAN](variables/OCR_TABASSARAN.md) -- [OCR_TAGALOG](variables/OCR_TAGALOG.md) -- [OCR_TAJIK](variables/OCR_TAJIK.md) -- [OCR_TELUGU](variables/OCR_TELUGU.md) -- [OCR_TURKISH](variables/OCR_TURKISH.md) -- [OCR_UKRAINIAN](variables/OCR_UKRAINIAN.md) -- [OCR_UZBEK](variables/OCR_UZBEK.md) -- [OCR_VIETNAMESE](variables/OCR_VIETNAMESE.md) -- [OCR_WELSH](variables/OCR_WELSH.md) +- [ALL\_MINILM\_L6\_V2](variables/ALL_MINILM_L6_V2.md) +- [ALL\_MPNET\_BASE\_V2](variables/ALL_MPNET_BASE_V2.md) +- [BK\_SDM\_TINY\_VPRED\_256](variables/BK_SDM_TINY_VPRED_256.md) +- [BK\_SDM\_TINY\_VPRED\_512](variables/BK_SDM_TINY_VPRED_512.md) +- [CLIP\_VIT\_BASE\_PATCH32\_IMAGE](variables/CLIP_VIT_BASE_PATCH32_IMAGE.md) +- [CLIP\_VIT\_BASE\_PATCH32\_TEXT](variables/CLIP_VIT_BASE_PATCH32_TEXT.md) +- [DEEPLAB\_V3\_RESNET50](variables/DEEPLAB_V3_RESNET50.md) +- [DEFAULT\_CHAT\_CONFIG](variables/DEFAULT_CHAT_CONFIG.md) +- [DEFAULT\_CONTEXT\_WINDOW\_LENGTH](variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md) +- [DEFAULT\_MESSAGE\_HISTORY](variables/DEFAULT_MESSAGE_HISTORY.md) +- [DEFAULT\_SYSTEM\_PROMPT](variables/DEFAULT_SYSTEM_PROMPT.md) +- [EFFICIENTNET\_V2\_S](variables/EFFICIENTNET_V2_S.md) +- [FSMN\_VAD](variables/FSMN_VAD.md) +- [HAMMER2\_1\_0\_5B](variables/HAMMER2_1_0_5B.md) +- [HAMMER2\_1\_0\_5B\_QUANTIZED](variables/HAMMER2_1_0_5B_QUANTIZED.md) +- [HAMMER2\_1\_1\_5B](variables/HAMMER2_1_1_5B.md) +- [HAMMER2\_1\_1\_5B\_QUANTIZED](variables/HAMMER2_1_1_5B_QUANTIZED.md) +- [HAMMER2\_1\_3B](variables/HAMMER2_1_3B.md) +- [HAMMER2\_1\_3B\_QUANTIZED](variables/HAMMER2_1_3B_QUANTIZED.md) +- [KOKORO\_EN](variables/KOKORO_EN.md) +- [KOKORO\_VOICE\_AF\_HEART](variables/KOKORO_VOICE_AF_HEART.md) +- [KOKORO\_VOICE\_AF\_RIVER](variables/KOKORO_VOICE_AF_RIVER.md) +- [KOKORO\_VOICE\_AF\_SARAH](variables/KOKORO_VOICE_AF_SARAH.md) +- [KOKORO\_VOICE\_AM\_ADAM](variables/KOKORO_VOICE_AM_ADAM.md) +- [KOKORO\_VOICE\_AM\_MICHAEL](variables/KOKORO_VOICE_AM_MICHAEL.md) +- [KOKORO\_VOICE\_AM\_SANTA](variables/KOKORO_VOICE_AM_SANTA.md) +- [KOKORO\_VOICE\_BF\_EMMA](variables/KOKORO_VOICE_BF_EMMA.md) +- [KOKORO\_VOICE\_BM\_DANIEL](variables/KOKORO_VOICE_BM_DANIEL.md) +- [LLAMA3\_2\_1B](variables/LLAMA3_2_1B.md) +- [LLAMA3\_2\_1B\_QLORA](variables/LLAMA3_2_1B_QLORA.md) +- [LLAMA3\_2\_1B\_SPINQUANT](variables/LLAMA3_2_1B_SPINQUANT.md) +- [LLAMA3\_2\_3B](variables/LLAMA3_2_3B.md) +- [LLAMA3\_2\_3B\_QLORA](variables/LLAMA3_2_3B_QLORA.md) +- [LLAMA3\_2\_3B\_SPINQUANT](variables/LLAMA3_2_3B_SPINQUANT.md) +- [MULTI\_QA\_MINILM\_L6\_COS\_V1](variables/MULTI_QA_MINILM_L6_COS_V1.md) +- [MULTI\_QA\_MPNET\_BASE\_DOT\_V1](variables/MULTI_QA_MPNET_BASE_DOT_V1.md) +- [OCR\_ABAZA](variables/OCR_ABAZA.md) +- [OCR\_ADYGHE](variables/OCR_ADYGHE.md) +- [OCR\_AFRIKAANS](variables/OCR_AFRIKAANS.md) +- [OCR\_ALBANIAN](variables/OCR_ALBANIAN.md) +- [OCR\_AVAR](variables/OCR_AVAR.md) +- [OCR\_AZERBAIJANI](variables/OCR_AZERBAIJANI.md) +- [OCR\_BELARUSIAN](variables/OCR_BELARUSIAN.md) +- [OCR\_BOSNIAN](variables/OCR_BOSNIAN.md) +- [OCR\_BULGARIAN](variables/OCR_BULGARIAN.md) +- [OCR\_CHECHEN](variables/OCR_CHECHEN.md) +- [OCR\_CROATIAN](variables/OCR_CROATIAN.md) +- [OCR\_CZECH](variables/OCR_CZECH.md) +- [OCR\_DANISH](variables/OCR_DANISH.md) +- [OCR\_DARGWA](variables/OCR_DARGWA.md) +- [OCR\_DUTCH](variables/OCR_DUTCH.md) +- [OCR\_ENGLISH](variables/OCR_ENGLISH.md) +- [OCR\_ESTONIAN](variables/OCR_ESTONIAN.md) +- [OCR\_FRENCH](variables/OCR_FRENCH.md) +- [OCR\_GERMAN](variables/OCR_GERMAN.md) +- [OCR\_HUNGARIAN](variables/OCR_HUNGARIAN.md) +- [OCR\_ICELANDIC](variables/OCR_ICELANDIC.md) +- [OCR\_INDONESIAN](variables/OCR_INDONESIAN.md) +- [OCR\_INGUSH](variables/OCR_INGUSH.md) +- [OCR\_IRISH](variables/OCR_IRISH.md) +- [OCR\_ITALIAN](variables/OCR_ITALIAN.md) +- [OCR\_JAPANESE](variables/OCR_JAPANESE.md) +- [OCR\_KANNADA](variables/OCR_KANNADA.md) +- [OCR\_KARBADIAN](variables/OCR_KARBADIAN.md) +- [OCR\_KOREAN](variables/OCR_KOREAN.md) +- [OCR\_KURDISH](variables/OCR_KURDISH.md) +- [OCR\_LAK](variables/OCR_LAK.md) +- [OCR\_LATIN](variables/OCR_LATIN.md) +- [OCR\_LATVIAN](variables/OCR_LATVIAN.md) +- [OCR\_LEZGHIAN](variables/OCR_LEZGHIAN.md) +- [OCR\_LITHUANIAN](variables/OCR_LITHUANIAN.md) +- [OCR\_MALAY](variables/OCR_MALAY.md) +- [OCR\_MALTESE](variables/OCR_MALTESE.md) +- [OCR\_MAORI](variables/OCR_MAORI.md) +- [OCR\_MONGOLIAN](variables/OCR_MONGOLIAN.md) +- [OCR\_NORWEGIAN](variables/OCR_NORWEGIAN.md) +- [OCR\_OCCITAN](variables/OCR_OCCITAN.md) +- [OCR\_PALI](variables/OCR_PALI.md) +- [OCR\_POLISH](variables/OCR_POLISH.md) +- [OCR\_PORTUGUESE](variables/OCR_PORTUGUESE.md) +- [OCR\_ROMANIAN](variables/OCR_ROMANIAN.md) +- [OCR\_RUSSIAN](variables/OCR_RUSSIAN.md) +- [OCR\_SERBIAN\_CYRILLIC](variables/OCR_SERBIAN_CYRILLIC.md) +- [OCR\_SERBIAN\_LATIN](variables/OCR_SERBIAN_LATIN.md) +- [OCR\_SIMPLIFIED\_CHINESE](variables/OCR_SIMPLIFIED_CHINESE.md) +- [OCR\_SLOVAK](variables/OCR_SLOVAK.md) +- [OCR\_SLOVENIAN](variables/OCR_SLOVENIAN.md) +- [OCR\_SPANISH](variables/OCR_SPANISH.md) +- [OCR\_SWAHILI](variables/OCR_SWAHILI.md) +- [OCR\_SWEDISH](variables/OCR_SWEDISH.md) +- [OCR\_TABASSARAN](variables/OCR_TABASSARAN.md) +- [OCR\_TAGALOG](variables/OCR_TAGALOG.md) +- [OCR\_TAJIK](variables/OCR_TAJIK.md) +- [OCR\_TELUGU](variables/OCR_TELUGU.md) +- [OCR\_TURKISH](variables/OCR_TURKISH.md) +- [OCR\_UKRAINIAN](variables/OCR_UKRAINIAN.md) +- [OCR\_UZBEK](variables/OCR_UZBEK.md) +- [OCR\_VIETNAMESE](variables/OCR_VIETNAMESE.md) +- [OCR\_WELSH](variables/OCR_WELSH.md) - [parseToolCall](variables/parseToolCall.md) -- [PHI_4_MINI_4B](variables/PHI_4_MINI_4B.md) -- [PHI_4_MINI_4B_QUANTIZED](variables/PHI_4_MINI_4B_QUANTIZED.md) -- [QWEN2_5_0_5B](variables/QWEN2_5_0_5B.md) -- [QWEN2_5_0_5B_QUANTIZED](variables/QWEN2_5_0_5B_QUANTIZED.md) -- [QWEN2_5_1_5B](variables/QWEN2_5_1_5B.md) -- [QWEN2_5_1_5B_QUANTIZED](variables/QWEN2_5_1_5B_QUANTIZED.md) -- [QWEN2_5_3B](variables/QWEN2_5_3B.md) -- [QWEN2_5_3B_QUANTIZED](variables/QWEN2_5_3B_QUANTIZED.md) -- [QWEN3_0_6B](variables/QWEN3_0_6B.md) -- [QWEN3_0_6B_QUANTIZED](variables/QWEN3_0_6B_QUANTIZED.md) -- [QWEN3_1_7B](variables/QWEN3_1_7B.md) -- [QWEN3_1_7B_QUANTIZED](variables/QWEN3_1_7B_QUANTIZED.md) -- [QWEN3_4B](variables/QWEN3_4B.md) -- [QWEN3_4B_QUANTIZED](variables/QWEN3_4B_QUANTIZED.md) -- [SMOLLM2_1_1_7B](variables/SMOLLM2_1_1_7B.md) -- [SMOLLM2_1_1_7B_QUANTIZED](variables/SMOLLM2_1_1_7B_QUANTIZED.md) -- [SMOLLM2_1_135M](variables/SMOLLM2_1_135M.md) -- [SMOLLM2_1_135M_QUANTIZED](variables/SMOLLM2_1_135M_QUANTIZED.md) -- [SMOLLM2_1_360M](variables/SMOLLM2_1_360M.md) -- [SMOLLM2_1_360M_QUANTIZED](variables/SMOLLM2_1_360M_QUANTIZED.md) -- [SPECIAL_TOKENS](variables/SPECIAL_TOKENS.md) -- [SSDLITE_320_MOBILENET_V3_LARGE](variables/SSDLITE_320_MOBILENET_V3_LARGE.md) -- [STYLE_TRANSFER_CANDY](variables/STYLE_TRANSFER_CANDY.md) -- [STYLE_TRANSFER_MOSAIC](variables/STYLE_TRANSFER_MOSAIC.md) -- [STYLE_TRANSFER_RAIN_PRINCESS](variables/STYLE_TRANSFER_RAIN_PRINCESS.md) -- [STYLE_TRANSFER_UDNIE](variables/STYLE_TRANSFER_UDNIE.md) -- [VERTICAL_OCR_ABAZA](variables/VERTICAL_OCR_ABAZA.md) -- [VERTICAL_OCR_ADYGHE](variables/VERTICAL_OCR_ADYGHE.md) -- [VERTICAL_OCR_AFRIKAANS](variables/VERTICAL_OCR_AFRIKAANS.md) -- [VERTICAL_OCR_ALBANIAN](variables/VERTICAL_OCR_ALBANIAN.md) -- [VERTICAL_OCR_AVAR](variables/VERTICAL_OCR_AVAR.md) -- [VERTICAL_OCR_AZERBAIJANI](variables/VERTICAL_OCR_AZERBAIJANI.md) -- [VERTICAL_OCR_BELARUSIAN](variables/VERTICAL_OCR_BELARUSIAN.md) -- [VERTICAL_OCR_BOSNIAN](variables/VERTICAL_OCR_BOSNIAN.md) -- [VERTICAL_OCR_BULGARIAN](variables/VERTICAL_OCR_BULGARIAN.md) -- [VERTICAL_OCR_CHECHEN](variables/VERTICAL_OCR_CHECHEN.md) -- [VERTICAL_OCR_CROATIAN](variables/VERTICAL_OCR_CROATIAN.md) -- [VERTICAL_OCR_CZECH](variables/VERTICAL_OCR_CZECH.md) -- [VERTICAL_OCR_DANISH](variables/VERTICAL_OCR_DANISH.md) -- [VERTICAL_OCR_DARGWA](variables/VERTICAL_OCR_DARGWA.md) -- [VERTICAL_OCR_DUTCH](variables/VERTICAL_OCR_DUTCH.md) -- [VERTICAL_OCR_ENGLISH](variables/VERTICAL_OCR_ENGLISH.md) -- [VERTICAL_OCR_ESTONIAN](variables/VERTICAL_OCR_ESTONIAN.md) -- [VERTICAL_OCR_FRENCH](variables/VERTICAL_OCR_FRENCH.md) -- [VERTICAL_OCR_GERMAN](variables/VERTICAL_OCR_GERMAN.md) -- [VERTICAL_OCR_HUNGARIAN](variables/VERTICAL_OCR_HUNGARIAN.md) -- [VERTICAL_OCR_ICELANDIC](variables/VERTICAL_OCR_ICELANDIC.md) -- [VERTICAL_OCR_INDONESIAN](variables/VERTICAL_OCR_INDONESIAN.md) -- [VERTICAL_OCR_INGUSH](variables/VERTICAL_OCR_INGUSH.md) -- [VERTICAL_OCR_IRISH](variables/VERTICAL_OCR_IRISH.md) -- [VERTICAL_OCR_ITALIAN](variables/VERTICAL_OCR_ITALIAN.md) -- [VERTICAL_OCR_JAPANESE](variables/VERTICAL_OCR_JAPANESE.md) -- [VERTICAL_OCR_KANNADA](variables/VERTICAL_OCR_KANNADA.md) -- [VERTICAL_OCR_KARBADIAN](variables/VERTICAL_OCR_KARBADIAN.md) -- [VERTICAL_OCR_KOREAN](variables/VERTICAL_OCR_KOREAN.md) -- [VERTICAL_OCR_KURDISH](variables/VERTICAL_OCR_KURDISH.md) -- [VERTICAL_OCR_LAK](variables/VERTICAL_OCR_LAK.md) -- [VERTICAL_OCR_LATIN](variables/VERTICAL_OCR_LATIN.md) -- [VERTICAL_OCR_LATVIAN](variables/VERTICAL_OCR_LATVIAN.md) -- [VERTICAL_OCR_LEZGHIAN](variables/VERTICAL_OCR_LEZGHIAN.md) -- [VERTICAL_OCR_LITHUANIAN](variables/VERTICAL_OCR_LITHUANIAN.md) -- [VERTICAL_OCR_MALAY](variables/VERTICAL_OCR_MALAY.md) -- [VERTICAL_OCR_MALTESE](variables/VERTICAL_OCR_MALTESE.md) -- [VERTICAL_OCR_MAORI](variables/VERTICAL_OCR_MAORI.md) -- [VERTICAL_OCR_MONGOLIAN](variables/VERTICAL_OCR_MONGOLIAN.md) -- [VERTICAL_OCR_NORWEGIAN](variables/VERTICAL_OCR_NORWEGIAN.md) -- [VERTICAL_OCR_OCCITAN](variables/VERTICAL_OCR_OCCITAN.md) -- [VERTICAL_OCR_PALI](variables/VERTICAL_OCR_PALI.md) -- [VERTICAL_OCR_POLISH](variables/VERTICAL_OCR_POLISH.md) -- [VERTICAL_OCR_PORTUGUESE](variables/VERTICAL_OCR_PORTUGUESE.md) -- [VERTICAL_OCR_ROMANIAN](variables/VERTICAL_OCR_ROMANIAN.md) -- [VERTICAL_OCR_RUSSIAN](variables/VERTICAL_OCR_RUSSIAN.md) -- [VERTICAL_OCR_SERBIAN_CYRILLIC](variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md) -- [VERTICAL_OCR_SERBIAN_LATIN](variables/VERTICAL_OCR_SERBIAN_LATIN.md) -- [VERTICAL_OCR_SIMPLIFIED_CHINESE](variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md) -- [VERTICAL_OCR_SLOVAK](variables/VERTICAL_OCR_SLOVAK.md) -- [VERTICAL_OCR_SLOVENIAN](variables/VERTICAL_OCR_SLOVENIAN.md) -- [VERTICAL_OCR_SPANISH](variables/VERTICAL_OCR_SPANISH.md) -- [VERTICAL_OCR_SWAHILI](variables/VERTICAL_OCR_SWAHILI.md) -- [VERTICAL_OCR_SWEDISH](variables/VERTICAL_OCR_SWEDISH.md) -- [VERTICAL_OCR_TABASSARAN](variables/VERTICAL_OCR_TABASSARAN.md) -- [VERTICAL_OCR_TAGALOG](variables/VERTICAL_OCR_TAGALOG.md) -- [VERTICAL_OCR_TAJIK](variables/VERTICAL_OCR_TAJIK.md) -- [VERTICAL_OCR_TELUGU](variables/VERTICAL_OCR_TELUGU.md) -- [VERTICAL_OCR_TURKISH](variables/VERTICAL_OCR_TURKISH.md) -- [VERTICAL_OCR_UKRAINIAN](variables/VERTICAL_OCR_UKRAINIAN.md) -- [VERTICAL_OCR_UZBEK](variables/VERTICAL_OCR_UZBEK.md) -- [VERTICAL_OCR_VIETNAMESE](variables/VERTICAL_OCR_VIETNAMESE.md) -- [VERTICAL_OCR_WELSH](variables/VERTICAL_OCR_WELSH.md) -- [WHISPER_BASE](variables/WHISPER_BASE.md) -- [WHISPER_BASE_EN](variables/WHISPER_BASE_EN.md) -- [WHISPER_SMALL](variables/WHISPER_SMALL.md) -- [WHISPER_SMALL_EN](variables/WHISPER_SMALL_EN.md) -- [WHISPER_TINY](variables/WHISPER_TINY.md) -- [WHISPER_TINY_EN](variables/WHISPER_TINY_EN.md) -- [WHISPER_TINY_EN_QUANTIZED](variables/WHISPER_TINY_EN_QUANTIZED.md) +- [PHI\_4\_MINI\_4B](variables/PHI_4_MINI_4B.md) +- [PHI\_4\_MINI\_4B\_QUANTIZED](variables/PHI_4_MINI_4B_QUANTIZED.md) +- [QWEN2\_5\_0\_5B](variables/QWEN2_5_0_5B.md) +- [QWEN2\_5\_0\_5B\_QUANTIZED](variables/QWEN2_5_0_5B_QUANTIZED.md) +- [QWEN2\_5\_1\_5B](variables/QWEN2_5_1_5B.md) +- [QWEN2\_5\_1\_5B\_QUANTIZED](variables/QWEN2_5_1_5B_QUANTIZED.md) +- [QWEN2\_5\_3B](variables/QWEN2_5_3B.md) +- [QWEN2\_5\_3B\_QUANTIZED](variables/QWEN2_5_3B_QUANTIZED.md) +- [QWEN3\_0\_6B](variables/QWEN3_0_6B.md) +- [QWEN3\_0\_6B\_QUANTIZED](variables/QWEN3_0_6B_QUANTIZED.md) +- [QWEN3\_1\_7B](variables/QWEN3_1_7B.md) +- [QWEN3\_1\_7B\_QUANTIZED](variables/QWEN3_1_7B_QUANTIZED.md) +- [QWEN3\_4B](variables/QWEN3_4B.md) +- [QWEN3\_4B\_QUANTIZED](variables/QWEN3_4B_QUANTIZED.md) +- [SMOLLM2\_1\_1\_7B](variables/SMOLLM2_1_1_7B.md) +- [SMOLLM2\_1\_1\_7B\_QUANTIZED](variables/SMOLLM2_1_1_7B_QUANTIZED.md) +- [SMOLLM2\_1\_135M](variables/SMOLLM2_1_135M.md) +- [SMOLLM2\_1\_135M\_QUANTIZED](variables/SMOLLM2_1_135M_QUANTIZED.md) +- [SMOLLM2\_1\_360M](variables/SMOLLM2_1_360M.md) +- [SMOLLM2\_1\_360M\_QUANTIZED](variables/SMOLLM2_1_360M_QUANTIZED.md) +- [SPECIAL\_TOKENS](variables/SPECIAL_TOKENS.md) +- [SSDLITE\_320\_MOBILENET\_V3\_LARGE](variables/SSDLITE_320_MOBILENET_V3_LARGE.md) +- [STYLE\_TRANSFER\_CANDY](variables/STYLE_TRANSFER_CANDY.md) +- [STYLE\_TRANSFER\_MOSAIC](variables/STYLE_TRANSFER_MOSAIC.md) +- [STYLE\_TRANSFER\_RAIN\_PRINCESS](variables/STYLE_TRANSFER_RAIN_PRINCESS.md) +- [STYLE\_TRANSFER\_UDNIE](variables/STYLE_TRANSFER_UDNIE.md) +- [VERTICAL\_OCR\_ABAZA](variables/VERTICAL_OCR_ABAZA.md) +- [VERTICAL\_OCR\_ADYGHE](variables/VERTICAL_OCR_ADYGHE.md) +- [VERTICAL\_OCR\_AFRIKAANS](variables/VERTICAL_OCR_AFRIKAANS.md) +- [VERTICAL\_OCR\_ALBANIAN](variables/VERTICAL_OCR_ALBANIAN.md) +- [VERTICAL\_OCR\_AVAR](variables/VERTICAL_OCR_AVAR.md) +- [VERTICAL\_OCR\_AZERBAIJANI](variables/VERTICAL_OCR_AZERBAIJANI.md) +- [VERTICAL\_OCR\_BELARUSIAN](variables/VERTICAL_OCR_BELARUSIAN.md) +- [VERTICAL\_OCR\_BOSNIAN](variables/VERTICAL_OCR_BOSNIAN.md) +- [VERTICAL\_OCR\_BULGARIAN](variables/VERTICAL_OCR_BULGARIAN.md) +- [VERTICAL\_OCR\_CHECHEN](variables/VERTICAL_OCR_CHECHEN.md) +- [VERTICAL\_OCR\_CROATIAN](variables/VERTICAL_OCR_CROATIAN.md) +- [VERTICAL\_OCR\_CZECH](variables/VERTICAL_OCR_CZECH.md) +- [VERTICAL\_OCR\_DANISH](variables/VERTICAL_OCR_DANISH.md) +- [VERTICAL\_OCR\_DARGWA](variables/VERTICAL_OCR_DARGWA.md) +- [VERTICAL\_OCR\_DUTCH](variables/VERTICAL_OCR_DUTCH.md) +- [VERTICAL\_OCR\_ENGLISH](variables/VERTICAL_OCR_ENGLISH.md) +- [VERTICAL\_OCR\_ESTONIAN](variables/VERTICAL_OCR_ESTONIAN.md) +- [VERTICAL\_OCR\_FRENCH](variables/VERTICAL_OCR_FRENCH.md) +- [VERTICAL\_OCR\_GERMAN](variables/VERTICAL_OCR_GERMAN.md) +- [VERTICAL\_OCR\_HUNGARIAN](variables/VERTICAL_OCR_HUNGARIAN.md) +- [VERTICAL\_OCR\_ICELANDIC](variables/VERTICAL_OCR_ICELANDIC.md) +- [VERTICAL\_OCR\_INDONESIAN](variables/VERTICAL_OCR_INDONESIAN.md) +- [VERTICAL\_OCR\_INGUSH](variables/VERTICAL_OCR_INGUSH.md) +- [VERTICAL\_OCR\_IRISH](variables/VERTICAL_OCR_IRISH.md) +- [VERTICAL\_OCR\_ITALIAN](variables/VERTICAL_OCR_ITALIAN.md) +- [VERTICAL\_OCR\_JAPANESE](variables/VERTICAL_OCR_JAPANESE.md) +- [VERTICAL\_OCR\_KANNADA](variables/VERTICAL_OCR_KANNADA.md) +- [VERTICAL\_OCR\_KARBADIAN](variables/VERTICAL_OCR_KARBADIAN.md) +- [VERTICAL\_OCR\_KOREAN](variables/VERTICAL_OCR_KOREAN.md) +- [VERTICAL\_OCR\_KURDISH](variables/VERTICAL_OCR_KURDISH.md) +- [VERTICAL\_OCR\_LAK](variables/VERTICAL_OCR_LAK.md) +- [VERTICAL\_OCR\_LATIN](variables/VERTICAL_OCR_LATIN.md) +- [VERTICAL\_OCR\_LATVIAN](variables/VERTICAL_OCR_LATVIAN.md) +- [VERTICAL\_OCR\_LEZGHIAN](variables/VERTICAL_OCR_LEZGHIAN.md) +- [VERTICAL\_OCR\_LITHUANIAN](variables/VERTICAL_OCR_LITHUANIAN.md) +- [VERTICAL\_OCR\_MALAY](variables/VERTICAL_OCR_MALAY.md) +- [VERTICAL\_OCR\_MALTESE](variables/VERTICAL_OCR_MALTESE.md) +- [VERTICAL\_OCR\_MAORI](variables/VERTICAL_OCR_MAORI.md) +- [VERTICAL\_OCR\_MONGOLIAN](variables/VERTICAL_OCR_MONGOLIAN.md) +- [VERTICAL\_OCR\_NORWEGIAN](variables/VERTICAL_OCR_NORWEGIAN.md) +- [VERTICAL\_OCR\_OCCITAN](variables/VERTICAL_OCR_OCCITAN.md) +- [VERTICAL\_OCR\_PALI](variables/VERTICAL_OCR_PALI.md) +- [VERTICAL\_OCR\_POLISH](variables/VERTICAL_OCR_POLISH.md) +- [VERTICAL\_OCR\_PORTUGUESE](variables/VERTICAL_OCR_PORTUGUESE.md) +- [VERTICAL\_OCR\_ROMANIAN](variables/VERTICAL_OCR_ROMANIAN.md) +- [VERTICAL\_OCR\_RUSSIAN](variables/VERTICAL_OCR_RUSSIAN.md) +- [VERTICAL\_OCR\_SERBIAN\_CYRILLIC](variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md) +- [VERTICAL\_OCR\_SERBIAN\_LATIN](variables/VERTICAL_OCR_SERBIAN_LATIN.md) +- [VERTICAL\_OCR\_SIMPLIFIED\_CHINESE](variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md) +- [VERTICAL\_OCR\_SLOVAK](variables/VERTICAL_OCR_SLOVAK.md) +- [VERTICAL\_OCR\_SLOVENIAN](variables/VERTICAL_OCR_SLOVENIAN.md) +- [VERTICAL\_OCR\_SPANISH](variables/VERTICAL_OCR_SPANISH.md) +- [VERTICAL\_OCR\_SWAHILI](variables/VERTICAL_OCR_SWAHILI.md) +- [VERTICAL\_OCR\_SWEDISH](variables/VERTICAL_OCR_SWEDISH.md) +- [VERTICAL\_OCR\_TABASSARAN](variables/VERTICAL_OCR_TABASSARAN.md) +- [VERTICAL\_OCR\_TAGALOG](variables/VERTICAL_OCR_TAGALOG.md) +- [VERTICAL\_OCR\_TAJIK](variables/VERTICAL_OCR_TAJIK.md) +- [VERTICAL\_OCR\_TELUGU](variables/VERTICAL_OCR_TELUGU.md) +- [VERTICAL\_OCR\_TURKISH](variables/VERTICAL_OCR_TURKISH.md) +- [VERTICAL\_OCR\_UKRAINIAN](variables/VERTICAL_OCR_UKRAINIAN.md) +- [VERTICAL\_OCR\_UZBEK](variables/VERTICAL_OCR_UZBEK.md) +- [VERTICAL\_OCR\_VIETNAMESE](variables/VERTICAL_OCR_VIETNAMESE.md) +- [VERTICAL\_OCR\_WELSH](variables/VERTICAL_OCR_WELSH.md) +- [WHISPER\_BASE](variables/WHISPER_BASE.md) +- [WHISPER\_BASE\_EN](variables/WHISPER_BASE_EN.md) +- [WHISPER\_SMALL](variables/WHISPER_SMALL.md) +- [WHISPER\_SMALL\_EN](variables/WHISPER_SMALL_EN.md) +- [WHISPER\_TINY](variables/WHISPER_TINY.md) +- [WHISPER\_TINY\_EN](variables/WHISPER_TINY_EN.md) +- [WHISPER\_TINY\_EN\_QUANTIZED](variables/WHISPER_TINY_EN_QUANTIZED.md) ## Functions -- [DEFAULT_STRUCTURED_OUTPUT_PROMPT](functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md) +- [DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT](functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md) - [fixAndValidateStructuredOutput](functions/fixAndValidateStructuredOutput.md) - [getStructuredOutputPrompt](functions/getStructuredOutputPrompt.md) - [useClassification](functions/useClassification.md) diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md index fcea8fbe1..43cb93273 100644 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -1,6 +1,6 @@ # Interface: Bbox -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L1) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L1) ## Properties @@ -8,28 +8,28 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](ht > **x1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L2) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L2) ---- +*** ### x2 > **x2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L3) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L3) ---- +*** ### y1 > **y1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L4) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L4) ---- +*** ### y2 > **y2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L5) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L5) diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md index 982443c8b..cdbb50a69 100644 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -1,6 +1,6 @@ # Interface: ChatConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:155](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L155) +Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L154) Object configuring chat management. @@ -10,26 +10,26 @@ Object configuring chat management. > **contextWindowLength**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:164](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L164) +Defined in: [packages/react-native-executorch/src/types/llm.ts:163](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L163) The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. ---- +*** ### initialMessageHistory > **initialMessageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:159](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L159) +Defined in: [packages/react-native-executorch/src/types/llm.ts:158](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L158) An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. ---- +*** ### systemPrompt > **systemPrompt**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:169](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L169) +Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L168) Often used to tell the model what is its purpose, for example - "Be a helpful translator". diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md index 22a903ae0..ab2406b50 100644 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -1,6 +1,8 @@ # Interface: DecodingOptions -Defined in: [packages/react-native-executorch/src/types/stt.ts:81](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L81) +Defined in: [packages/react-native-executorch/src/types/stt.ts:167](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L167) + +Options for decoding speech to text. ## Properties @@ -8,4 +10,6 @@ Defined in: [packages/react-native-executorch/src/types/stt.ts:81](https://githu > `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:82](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L82) +Defined in: [packages/react-native-executorch/src/types/stt.ts:171](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L171) + +Optional language code to guide the transcription. diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md index 89e00bbf9..fbf904d04 100644 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -1,6 +1,6 @@ # Interface: Detection -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L8) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L8) ## Properties @@ -8,20 +8,20 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](ht > **bbox**: [`Bbox`](Bbox.md) -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L9) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L9) ---- +*** ### label > **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L10) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L10) ---- +*** ### score > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/objectDetection.ts#L11) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L11) diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md index 838e4d762..e37f8c01b 100644 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -1,6 +1,6 @@ # Interface: GenerationConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:195](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L195) +Defined in: [packages/react-native-executorch/src/types/llm.ts:194](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L194) Object configuring generation settings. @@ -10,36 +10,36 @@ Object configuring generation settings. > `optional` **batchTimeInterval**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:214](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L214) +Defined in: [packages/react-native-executorch/src/types/llm.ts:213](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L213) Upper limit on the time interval between consecutive token batches. ---- +*** ### outputTokenBatchSize? > `optional` **outputTokenBatchSize**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:209](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L209) +Defined in: [packages/react-native-executorch/src/types/llm.ts:208](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L208) Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). ---- +*** ### temperature? > `optional` **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L199) +Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L198) Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. ---- +*** ### topp? > `optional` **topp**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:204](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L204) +Defined in: [packages/react-native-executorch/src/types/llm.ts:203](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L203) Only samples from the smallest set of tokens whose cumulative probability exceeds topp. diff --git a/docs/docs/06-api-reference/interfaces/KokoroConfig.md b/docs/docs/06-api-reference/interfaces/KokoroConfig.md new file mode 100644 index 000000000..0b13895e6 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/KokoroConfig.md @@ -0,0 +1,46 @@ +# Interface: KokoroConfig + +Defined in: [packages/react-native-executorch/src/types/tts.ts:33](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L33) + +Kokoro model configuration. +Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. + +## Properties + +### durationPredictorSource + +> **durationPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:35](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L35) + +*** + +### f0nPredictorSource + +> **f0nPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:36](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L36) + +*** + +### textDecoderSource + +> **textDecoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:38](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L38) + +*** + +### textEncoderSource + +> **textEncoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:37](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L37) + +*** + +### type + +> **type**: `"kokoro"` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:34](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L34) diff --git a/docs/docs/06-api-reference/interfaces/KokoroOptions.md b/docs/docs/06-api-reference/interfaces/KokoroOptions.md new file mode 100644 index 000000000..2b4d7b5cb --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/KokoroOptions.md @@ -0,0 +1,17 @@ +# Interface: KokoroOptions + +Defined in: [packages/react-native-executorch/src/types/tts.ts:48](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L48) + +Extra options associated with the Kokoro model + +## Properties + +### fixedModel? + +> `optional` **fixedModel**: `"small"` \| `"medium"` \| `"large"` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:49](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L49) + +if set, forces Kokoro to use only one if it's 3 models + with static input shapes. Reduces the memory usage and + inference time variance, but could affect the result quality a little bit. diff --git a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md new file mode 100644 index 000000000..8d74ceea9 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md @@ -0,0 +1,19 @@ +# Interface: KokoroVoiceExtras + +Defined in: [packages/react-native-executorch/src/types/tts.ts:24](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L24) + +## Properties + +### lexiconSource + +> **lexiconSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L26) + +*** + +### taggerSource + +> **taggerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L25) diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md index 508bb2f0a..a01ff1f46 100644 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -1,6 +1,6 @@ # Interface: LLMType -Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L6) +Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L6) React hook for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ React hook for managing a Large Language Model (LLM) instance. > **configure**: (`configuration`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L48) +Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L48) Configures chat and tool calling. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -63,13 +63,13 @@ Object configuring options for enabling and managing tool use. **It will only ha `void` ---- +*** ### deleteMessage() > **deleteMessage**: (`index`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L114) +Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L114) Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. @@ -85,33 +85,33 @@ The index of the message to delete from history. `void` ---- +*** ### downloadProgress > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L35) +Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L35) Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. ---- +*** ### error > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L40) +Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L40) Contains the error message if the model failed to load. ---- +*** ### generate() > **generate**: (`messages`, `tools?`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:100](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L100) +Defined in: [packages/react-native-executorch/src/types/llm.ts:100](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L100) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -133,13 +133,13 @@ Optional array of tools that can be used during generation. `Promise`\<`void`\> ---- +*** ### getGeneratedTokenCount() > **getGeneratedTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L93) +Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L93) Returns the number of tokens generated so far in the current generation. @@ -149,13 +149,13 @@ Returns the number of tokens generated so far in the current generation. The count of generated tokens. ---- +*** ### interrupt() > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:119](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L119) +Defined in: [packages/react-native-executorch/src/types/llm.ts:119](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L119) Function to interrupt the current inference. @@ -163,53 +163,53 @@ Function to interrupt the current inference. `void` ---- +*** ### isGenerating > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L30) +Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L30) Indicates whether the model is currently generating a response. ---- +*** ### isReady > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L25) +Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L25) Indicates whether the model is ready. ---- +*** ### messageHistory > **messageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L10) +Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L10) History containing all messages in conversation. This field is updated after model responds to sendMessage. ---- +*** ### response > **response**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L15) +Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L15) State of the generated response. This field is updated with each token generated by the model. ---- +*** ### sendMessage() > **sendMessage**: (`message`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:107](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L107) +Defined in: [packages/react-native-executorch/src/types/llm.ts:107](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L107) Function to add user message to conversation. After model responds, `messageHistory` will be updated with both user message and model response. @@ -226,12 +226,12 @@ The message string to send. `Promise`\<`void`\> ---- +*** ### token > **token**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L20) +Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L20) The most recently generated token. diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md index 9a69921bf..f7900ba1e 100644 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -1,6 +1,6 @@ # Interface: Message -Defined in: [packages/react-native-executorch/src/types/llm.ts:130](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L130) +Defined in: [packages/react-native-executorch/src/types/llm.ts:130](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L130) Represents a message in the conversation. @@ -10,16 +10,16 @@ Represents a message in the conversation. > **content**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:139](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L139) +Defined in: [packages/react-native-executorch/src/types/llm.ts:139](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L139) Content of the message. ---- +*** ### role > **role**: [`MessageRole`](../type-aliases/MessageRole.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:134](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L134) +Defined in: [packages/react-native-executorch/src/types/llm.ts:134](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L134) Role of the message sender of type `MessageRole`. diff --git a/docs/docs/06-api-reference/interfaces/OCRBbox.md b/docs/docs/06-api-reference/interfaces/OCRBbox.md index dd93374bb..5c0d58bf5 100644 --- a/docs/docs/06-api-reference/interfaces/OCRBbox.md +++ b/docs/docs/06-api-reference/interfaces/OCRBbox.md @@ -1,6 +1,6 @@ # Interface: OCRBbox -Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L9) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L9) ## Properties @@ -8,12 +8,12 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github > **x**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L10) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L10) ---- +*** ### y > **y**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:11](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L11) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L11) diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md index e944ecc5d..52f4f8b1e 100644 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -1,6 +1,6 @@ # Interface: OCRDetection -Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L3) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L3) ## Properties @@ -8,20 +8,20 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github > **bbox**: [`OCRBbox`](OCRBbox.md)[] -Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L4) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L4) ---- +*** ### score > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L6) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L6) ---- +*** ### text > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:5](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L5) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L5) diff --git a/docs/docs/06-api-reference/interfaces/Props.md b/docs/docs/06-api-reference/interfaces/Props.md index 2218ef04b..00fff3899 100644 --- a/docs/docs/06-api-reference/interfaces/Props.md +++ b/docs/docs/06-api-reference/interfaces/Props.md @@ -1,6 +1,6 @@ # Interface: Props -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L8) +Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:39 Props for the useTextEmbeddings hook. @@ -10,7 +10,7 @@ Props for the useTextEmbeddings hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L9) +Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:40 #### modelSource @@ -24,12 +24,12 @@ Defined in: [packages/react-native-executorch/src/hooks/natural_language_process `ResourceSource` pointing to the JSON file which contains the tokenizer. ---- +*** ### preventLoad? > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts:24](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L24) +Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:55 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/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index fd655c0cb..b43f9c44b 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,6 @@ # Interface: Segment -Defined in: [packages/react-native-executorch/src/types/vad.ts:1](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/vad.ts#L1) +Defined in: [packages/react-native-executorch/src/types/vad.ts:1](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/vad.ts#L1) ## Properties @@ -8,12 +8,12 @@ Defined in: [packages/react-native-executorch/src/types/vad.ts:1](https://github > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/vad.ts#L3) +Defined in: [packages/react-native-executorch/src/types/vad.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/vad.ts#L3) ---- +*** ### start > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:2](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/vad.ts#L2) +Defined in: [packages/react-native-executorch/src/types/vad.ts:2](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/vad.ts#L2) diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md index dda579dd3..778de1883 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -1,6 +1,8 @@ # Interface: SpeechToTextModelConfig -Defined in: [packages/react-native-executorch/src/types/stt.ts:85](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L85) +Defined in: [packages/react-native-executorch/src/types/stt.ts:177](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L177) + +Configuration for Speech to Text model. ## Properties @@ -8,28 +10,36 @@ Defined in: [packages/react-native-executorch/src/types/stt.ts:85](https://githu > **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:88](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L88) +Defined in: [packages/react-native-executorch/src/types/stt.ts:191](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L191) + +A string that specifies the location of a `.pte` file for the decoder. ---- +*** ### encoderSource > **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L87) +Defined in: [packages/react-native-executorch/src/types/stt.ts:186](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L186) + +A string that specifies the location of a `.pte` file for the encoder. ---- +*** ### isMultilingual > **isMultilingual**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:86](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L86) +Defined in: [packages/react-native-executorch/src/types/stt.ts:181](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L181) ---- +A boolean flag indicating whether the model supports multiple languages. + +*** ### tokenizerSource > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:89](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L89) +Defined in: [packages/react-native-executorch/src/types/stt.ts:196](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L196) + +A string that specifies the location to the tokenizer for the model. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md new file mode 100644 index 000000000..43e62d020 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md @@ -0,0 +1,215 @@ +# Interface: SpeechToTextType + +Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L7) + +React hook for managing Speech to Text (STT) instance. + +## Properties + +### committedTranscription + +> **committedTranscription**: `string` + +Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L32) + +Contains the part of the transcription that is finalized and will not change. +Useful for displaying stable results during streaming. + +*** + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L26) + +Tracks the progress of the model download process. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L11) + +Contains the error message if the model failed to load. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L21) + +Indicates whether the model is currently processing an inference. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L16) + +Indicates whether the model has successfully loaded and is ready for inference. + +*** + +### nonCommittedTranscription + +> **nonCommittedTranscription**: `string` + +Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L38) + +Contains the part of the transcription that is still being processed and may change. +Useful for displaying live, partial results during streaming. + +## Methods + +### decode() + +> **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L53) + +Runs the decoder of the model. Passing `number[]` is deprecated. + +#### Parameters + +##### tokens + +The encoded audio data. + +`number`[] | `Int32Array`\<`ArrayBufferLike`\> + +##### encoderOutput + +The output from the encoder. + +`number`[] | `Float32Array`\<`ArrayBufferLike`\> + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +A promise resolving to the decoded text. + +*** + +### encode() + +> **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L45) + +Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. + +#### Parameters + +##### waveform + +The input audio waveform array. + +`number`[] | `Float32Array`\<`ArrayBufferLike`\> + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +A promise resolving to the encoded data. + +*** + +### stream() + +> **stream**(`options?`): `Promise`\<`string`\> + +Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L71) + +Starts a streaming transcription process. +Use in combination with streamInsert to feed audio chunks and streamStop to end the stream. +Updates `committedTranscription` and `nonCommittedTranscription` as transcription progresses. + +#### Parameters + +##### options? + +[`DecodingOptions`](DecodingOptions.md) + +Decoding options including language. + +#### Returns + +`Promise`\<`string`\> + +The final transcription string. + +*** + +### streamInsert() + +> **streamInsert**(`waveform`): `void` + +Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L78) + +Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. +Passing `number[]` is deprecated. + +#### Parameters + +##### waveform + +The audio chunk to insert. + +`number`[] | `Float32Array`\<`ArrayBufferLike`\> + +#### Returns + +`void` + +*** + +### streamStop() + +> **streamStop**(): `void` + +Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L83) + +Stops the ongoing streaming transcription process. + +#### Returns + +`void` + +*** + +### transcribe() + +> **transcribe**(`waveform`, `options?`): `Promise`\<`string`\> + +Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L62) + +Starts a transcription process for a given input array, which should be a waveform at 16kHz. +Passing `number[]` is deprecated. + +#### Parameters + +##### waveform + +The input audio waveform. + +`number`[] | `Float32Array`\<`ArrayBufferLike`\> + +##### options? + +[`DecodingOptions`](DecodingOptions.md) + +Decoding options, e.g. `{ language: 'es' }` for multilingual models. + +#### Returns + +`Promise`\<`string`\> + +Resolves a promise with the output transcription when the model is finished. diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md index 43258582a..6b21550a8 100644 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -1,6 +1,6 @@ # Interface: TensorPtr -Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L51) +Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L51) ## Properties @@ -8,20 +8,20 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://gi > **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L52) +Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L52) ---- +*** ### scalarType > **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L54) +Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L54) ---- +*** ### sizes > **sizes**: `number`[] -Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L53) +Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L53) diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md new file mode 100644 index 000000000..849716e11 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md @@ -0,0 +1,70 @@ +# Interface: TextEmbeddingsType + +Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:7 + +React hook state and methods for managing a Text Embeddings model instance. + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:26 + +Tracks the progress of the model download process (value between 0 and 1). + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:11 + +Contains the error message if the model failed to load or during inference. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:21 + +Indicates whether the model is currently generating embeddings. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:16 + +Indicates whether the embeddings model has successfully loaded and is ready for inference. + +## Methods + +### forward() + +> **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:33 + +Runs the text embeddings model on the provided input string. +* + +#### Parameters + +##### input + +`string` + +The text string to embed. + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +A promise resolving to a Float32Array containing the vector embeddings. diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md new file mode 100644 index 000000000..b138c414b --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md @@ -0,0 +1,35 @@ +# Interface: TextToSpeechConfig + +Defined in: [packages/react-native-executorch/src/types/tts.ts:59](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L59) + +General Text to Speech module configuration + +## Properties + +### model + +> **model**: [`KokoroConfig`](KokoroConfig.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:60](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L60) + +a selected T2S model + +*** + +### options? + +> `optional` **options**: [`KokoroOptions`](KokoroOptions.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:62](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L62) + +a completely optional model-specific configuration + +*** + +### voice + +> **voice**: [`VoiceConfig`](VoiceConfig.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:61](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L61) + +a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md new file mode 100644 index 000000000..6524acb87 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md @@ -0,0 +1,29 @@ +# Interface: TextToSpeechInput + +Defined in: [packages/react-native-executorch/src/types/tts.ts:71](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L71) + +Text to Speech module input definition + +## Extended by + +- [`TextToSpeechStreamingInput`](TextToSpeechStreamingInput.md) + +## Properties + +### speed? + +> `optional` **speed**: `number` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:73](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L73) + +optional speed argument - the higher it is, the faster the speech becomes + +*** + +### text + +> **text**: `string` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:72](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L72) + +a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md new file mode 100644 index 000000000..b3f721a12 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md @@ -0,0 +1,90 @@ +# Interface: TextToSpeechStreamingInput + +Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L87) + +Text to Speech streaming input definition + +Streaming mode in T2S is synchronized by passing specific callbacks +executed at given moments of the streaming. +Actions such as playing the audio should happen within the onNext callback. +Callbacks can be both synchronous or asynchronous. + +## Extends + +- [`TextToSpeechInput`](TextToSpeechInput.md) + +## Properties + +### onBegin()? + +> `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/types/tts.ts:88](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L88) + +Called when streaming begins + +#### Returns + +`void` \| `Promise`\<`void`\> + +*** + +### onEnd()? + +> `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/types/tts.ts:90](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L90) + +Called when streaming ends + +#### Returns + +`void` \| `Promise`\<`void`\> + +*** + +### onNext()? + +> `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/types/tts.ts:89](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L89) + +Called after each audio chunk gets calculated. + +#### Parameters + +##### audio + +`Float32Array` + +#### Returns + +`void` \| `Promise`\<`void`\> + +*** + +### speed? + +> `optional` **speed**: `number` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:73](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L73) + +optional speed argument - the higher it is, the faster the speech becomes + +#### Inherited from + +[`TextToSpeechInput`](TextToSpeechInput.md).[`speed`](TextToSpeechInput.md#speed) + +*** + +### text + +> **text**: `string` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:72](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L72) + +a text to be spoken + +#### Inherited from + +[`TextToSpeechInput`](TextToSpeechInput.md).[`text`](TextToSpeechInput.md#text) diff --git a/docs/docs/06-api-reference/interfaces/TokenizerType.md b/docs/docs/06-api-reference/interfaces/TokenizerType.md new file mode 100644 index 000000000..fe27735d5 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TokenizerType.md @@ -0,0 +1,161 @@ +# Interface: TokenizerType + +Defined in: packages/react-native-executorch/src/types/tokenizer.ts:6 + +React hook state and methods for managing a Tokenizer instance. + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: packages/react-native-executorch/src/types/tokenizer.ts:25 + +Tracks the progress of the tokenizer download process (value between 0 and 1). + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: packages/react-native-executorch/src/types/tokenizer.ts:10 + +Contains the error message if the tokenizer failed to load or during processing. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: packages/react-native-executorch/src/types/tokenizer.ts:20 + +Indicates whether the tokenizer is currently processing data. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: packages/react-native-executorch/src/types/tokenizer.ts:15 + +Indicates whether the tokenizer has successfully loaded and is ready for use. + +## Methods + +### decode() + +> **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> + +Defined in: packages/react-native-executorch/src/types/tokenizer.ts:32 + +Converts an array of token IDs into a string. + +#### Parameters + +##### tokens + +`number`[] + +An array or `number[]` of token IDs to decode. + +##### skipSpecialTokens + +`boolean` | `undefined` + +#### Returns + +`Promise`\<`string`\> + +A promise resolving to the decoded text string. + +*** + +### encode() + +> **encode**(`text`): `Promise`\<`number`[]\> + +Defined in: packages/react-native-executorch/src/types/tokenizer.ts:39 + +Converts a string into an array of token IDs. + +#### Parameters + +##### text + +`string` + +The input text string to tokenize. + +#### Returns + +`Promise`\<`number`[]\> + +A promise resolving to an array `number[]` containing the encoded token IDs. + +*** + +### getVocabSize() + +> **getVocabSize**(): `Promise`\<`number`\> + +Defined in: packages/react-native-executorch/src/types/tokenizer.ts:45 + +Returns the size of the tokenizer's vocabulary. + +#### Returns + +`Promise`\<`number`\> + +A promise resolving to the vocabulary size. + +*** + +### idToToken() + +> **idToToken**(`id`): `Promise`\<`string`\> + +Defined in: packages/react-native-executorch/src/types/tokenizer.ts:52 + +Returns the token associated to the ID. + +#### Parameters + +##### id + +`number` + +The numeric token ID. + +#### Returns + +`Promise`\<`string`\> + +A promise resolving to the token string representation. + +*** + +### tokenToId() + +> **tokenToId**(`token`): `Promise`\<`number`\> + +Defined in: packages/react-native-executorch/src/types/tokenizer.ts:59 + +Returns the ID associated to the token. + +#### Parameters + +##### token + +`string` + +The token string. + +#### Returns + +`Promise`\<`number`\> + +A promise resolving to the token ID. diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md index da6675be9..e88229b22 100644 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -1,6 +1,6 @@ # Interface: ToolCall -Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L142) +Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L142) ## Properties @@ -8,12 +8,12 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://gith > **arguments**: `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L144) +Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L144) ---- +*** ### toolName > **toolName**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L143) +Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L143) diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md index c6bc91c96..a8a853e12 100644 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -1,6 +1,6 @@ # Interface: ToolsConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:175](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L175) +Defined in: [packages/react-native-executorch/src/types/llm.ts:174](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L174) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. @@ -10,17 +10,17 @@ Object configuring options for enabling and managing tool use. **It will only ha > `optional` **displayToolCalls**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:189](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L189) +Defined in: [packages/react-native-executorch/src/types/llm.ts:188](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L188) If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. ---- +*** ### executeToolCallback() > **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L184) +Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L183) Function that accepts `ToolCall`, executes tool and returns the string to model. @@ -34,12 +34,12 @@ Function that accepts `ToolCall`, executes tool and returns the string to model. `Promise`\<`string` \| `null`\> ---- +*** ### tools > **tools**: `Object`[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:179](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L179) +Defined in: [packages/react-native-executorch/src/types/llm.ts:178](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L178) List of objects defining tools. diff --git a/docs/docs/06-api-reference/interfaces/VoiceConfig.md b/docs/docs/06-api-reference/interfaces/VoiceConfig.md new file mode 100644 index 000000000..59a785e9c --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/VoiceConfig.md @@ -0,0 +1,37 @@ +# Interface: VoiceConfig + +Defined in: [packages/react-native-executorch/src/types/tts.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L17) + +Voice configuration + +So far in Kokoro, each voice is directly associated with a language. + +## Properties + +### extra? + +> `optional` **extra**: [`KokoroVoiceExtras`](KokoroVoiceExtras.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L20) + +an optional extra sources or properties related to specific voice + +*** + +### lang + +> **lang**: [`TextToSpeechLanguage`](../type-aliases/TextToSpeechLanguage.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L18) + +speaker's language + +*** + +### voiceSource + +> **voiceSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L19) + +a source to a binary file with voice embedding diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md index e68c6da20..38d76aba5 100644 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -2,4 +2,4 @@ > **LLMTool** = `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:149](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L149) +Defined in: [packages/react-native-executorch/src/types/llm.ts:149](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L149) diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md index bbca55926..e985336aa 100644 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -2,6 +2,6 @@ > **MessageRole** = `"user"` \| `"assistant"` \| `"system"` -Defined in: [packages/react-native-executorch/src/types/llm.ts:125](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L125) +Defined in: [packages/react-native-executorch/src/types/llm.ts:125](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L125) Roles that a message sender can have. diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md index e1a641609..05f753d11 100644 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -1,5 +1,5 @@ # Type Alias: OCRLanguage -> **OCRLanguage** = keyof _typeof_ `symbols` +> **OCRLanguage** = keyof *typeof* `symbols` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/ocr.ts#L14) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L14) diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md index c2bc85101..85eb2edfb 100644 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -2,6 +2,6 @@ > **ResourceSource** = `string` \| `number` \| `object` -Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L8) +Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L8) Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md index de49dadfb..493dec186 100644 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -2,4 +2,4 @@ > **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:4](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/stt.ts#L4) +Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L87) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md index 817a275e6..ddbda14f5 100644 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -2,4 +2,4 @@ > **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` -Defined in: [packages/react-native-executorch/src/types/common.ts:38](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/common.ts#L38) +Defined in: [packages/react-native-executorch/src/types/common.ts:38](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L38) diff --git a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md new file mode 100644 index 000000000..c6dbba5ef --- /dev/null +++ b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md @@ -0,0 +1,5 @@ +# Type Alias: TextToSpeechLanguage + +> **TextToSpeechLanguage** = `"en-us"` \| `"en-gb"` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:4](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L4) diff --git a/docs/docs/06-api-reference/typedoc-sidebar.cjs b/docs/docs/06-api-reference/typedoc-sidebar.cjs index fd7b328c4..5032ac327 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:"Enumerations",items:[{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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/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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{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/OCRBbox",label:"OCRBbox"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/Props",label:"Props"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/TensorPtr",label:"TensorPtr"},{type:"doc",id:"06-api-reference/interfaces/ToolCall",label:"ToolCall"},{type:"doc",id:"06-api-reference/interfaces/ToolsConfig",label:"ToolsConfig"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_EN",label:"KOKORO_EN"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; +const typedocSidebar = {items:[{type:"category",label:"Enumerations",items:[{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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/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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroConfig",label:"KokoroConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroOptions",label:"KokoroOptions"},{type:"doc",id:"06-api-reference/interfaces/KokoroVoiceExtras",label:"KokoroVoiceExtras"},{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/OCRBbox",label:"OCRBbox"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/Props",label:"Props"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextType",label:"SpeechToTextType"},{type:"doc",id:"06-api-reference/interfaces/TensorPtr",label:"TensorPtr"},{type:"doc",id:"06-api-reference/interfaces/TextEmbeddingsType",label:"TextEmbeddingsType"},{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/TextToSpeechStreamingInput",label:"TextToSpeechStreamingInput"},{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/VoiceConfig",label:"VoiceConfig"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_EN",label:"KOKORO_EN"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; 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 eadcff5e8..68f49e605 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 @@ -1,8 +1,8 @@ -# Variable: ALL_MINILM_L6_V2 +# Variable: ALL\_MINILM\_L6\_V2 -> `const` **ALL_MINILM_L6_V2**: `object` +> `const` **ALL\_MINILM\_L6\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L408) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L408) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md index d0fbfdad8..da63ed261 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 @@ -1,8 +1,8 @@ -# Variable: ALL_MPNET_BASE_V2 +# Variable: ALL\_MPNET\_BASE\_V2 -> `const` **ALL_MPNET_BASE_V2**: `object` +> `const` **ALL\_MPNET\_BASE\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L413) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L413) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md index dc25ef44a..dcab30090 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 @@ -1,8 +1,8 @@ -# Variable: BK_SDM_TINY_VPRED_256 +# Variable: BK\_SDM\_TINY\_VPRED\_256 -> `const` **BK_SDM_TINY_VPRED_256**: `object` +> `const` **BK\_SDM\_TINY\_VPRED\_256**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L442) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L442) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index e925bc62e..9be37f923 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 @@ -1,8 +1,8 @@ -# Variable: BK_SDM_TINY_VPRED_512 +# Variable: BK\_SDM\_TINY\_VPRED\_512 -> `const` **BK_SDM_TINY_VPRED_512**: `object` +> `const` **BK\_SDM\_TINY\_VPRED\_512**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L434) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L434) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index 092aa8292..0908e5d11 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 @@ -1,8 +1,8 @@ -# Variable: CLIP_VIT_BASE_PATCH32_IMAGE +# Variable: CLIP\_VIT\_BASE\_PATCH32\_IMAGE -> `const` **CLIP_VIT_BASE_PATCH32_IMAGE**: `object` +> `const` **CLIP\_VIT\_BASE\_PATCH32\_IMAGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md index 0af3b32bc..bf2bce137 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 @@ -1,8 +1,8 @@ -# Variable: CLIP_VIT_BASE_PATCH32_TEXT +# Variable: CLIP\_VIT\_BASE\_PATCH32\_TEXT -> `const` **CLIP_VIT_BASE_PATCH32_TEXT**: `object` +> `const` **CLIP\_VIT\_BASE\_PATCH32\_TEXT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L428) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L428) ## 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 e274ae6c6..e217e99ca 100644 --- a/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md +++ b/docs/docs/06-api-reference/variables/DEEPLAB_V3_RESNET50.md @@ -1,8 +1,8 @@ -# Variable: DEEPLAB_V3_RESNET50 +# Variable: DEEPLAB\_V3\_RESNET50 -> `const` **DEEPLAB_V3_RESNET50**: `object` +> `const` **DEEPLAB\_V3\_RESNET50**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L385) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L385) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md index ea7b77d95..55778439d 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -1,5 +1,5 @@ -# Variable: DEFAULT_CHAT_CONFIG +# Variable: DEFAULT\_CHAT\_CONFIG -> `const` **DEFAULT_CHAT_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) +> `const` **DEFAULT\_CHAT\_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md index 7377b47a7..532658af0 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md @@ -1,5 +1,5 @@ -# Variable: DEFAULT_CONTEXT_WINDOW_LENGTH +# Variable: DEFAULT\_CONTEXT\_WINDOW\_LENGTH -> `const` **DEFAULT_CONTEXT_WINDOW_LENGTH**: `5` = `5` +> `const` **DEFAULT\_CONTEXT\_WINDOW\_LENGTH**: `5` = `5` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md index b3d2807d6..0b87a33d5 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -1,5 +1,5 @@ -# Variable: DEFAULT_MESSAGE_HISTORY +# Variable: DEFAULT\_MESSAGE\_HISTORY -> `const` **DEFAULT_MESSAGE_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` +> `const` **DEFAULT\_MESSAGE\_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md index a15c3a0d3..ed87ff56a 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -1,5 +1,5 @@ -# Variable: DEFAULT_SYSTEM_PROMPT +# Variable: DEFAULT\_SYSTEM\_PROMPT -> `const` **DEFAULT_SYSTEM_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` +> `const` **DEFAULT\_SYSTEM\_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) 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 3cc2c73ba..134ef9b9f 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -1,8 +1,8 @@ -# Variable: EFFICIENTNET_V2_S +# Variable: EFFICIENTNET\_V2\_S -> `const` **EFFICIENTNET_V2_S**: `object` +> `const` **EFFICIENTNET\_V2\_S**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L260) ## 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 af0f649fa..e0be45348 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -1,8 +1,8 @@ -# Variable: FSMN_VAD +# Variable: FSMN\_VAD -> `const` **FSMN_VAD**: `object` +> `const` **FSMN\_VAD**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L453) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L453) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md index e032eb8ff..360e46a96 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 @@ -1,8 +1,8 @@ -# Variable: HAMMER2_1_0_5B +# Variable: HAMMER2\_1\_0\_5B -> `const` **HAMMER2_1_0_5B**: `object` +> `const` **HAMMER2\_1\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L108) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L108) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md index 4167ac5a2..98c154672 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 @@ -1,8 +1,8 @@ -# Variable: HAMMER2_1_0_5B_QUANTIZED +# Variable: HAMMER2\_1\_0\_5B\_QUANTIZED -> `const` **HAMMER2_1_0_5B_QUANTIZED**: `object` +> `const` **HAMMER2\_1\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L114) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L114) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md index f609379e9..631a1c5f7 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 @@ -1,8 +1,8 @@ -# Variable: HAMMER2_1_1_5B +# Variable: HAMMER2\_1\_1\_5B -> `const` **HAMMER2_1_1_5B**: `object` +> `const` **HAMMER2\_1\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L120) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L120) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md index 42e14c72f..4369aa8c2 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 @@ -1,8 +1,8 @@ -# Variable: HAMMER2_1_1_5B_QUANTIZED +# Variable: HAMMER2\_1\_1\_5B\_QUANTIZED -> `const` **HAMMER2_1_1_5B_QUANTIZED**: `object` +> `const` **HAMMER2\_1\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L126) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L126) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md index 7c3211163..676433803 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -1,8 +1,8 @@ -# Variable: HAMMER2_1_3B +# Variable: HAMMER2\_1\_3B -> `const` **HAMMER2_1_3B**: `object` +> `const` **HAMMER2\_1\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L132) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L132) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md index 2bc729f9c..4e39d5305 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 @@ -1,8 +1,8 @@ -# Variable: HAMMER2_1_3B_QUANTIZED +# Variable: HAMMER2\_1\_3B\_QUANTIZED -> `const` **HAMMER2_1_3B_QUANTIZED**: `object` +> `const` **HAMMER2\_1\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L138) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L138) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_EN.md b/docs/docs/06-api-reference/variables/KOKORO_EN.md index 4b2a2d7a3..0852fd700 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_EN.md +++ b/docs/docs/06-api-reference/variables/KOKORO_EN.md @@ -1,8 +1,8 @@ -# Variable: KOKORO_EN +# Variable: KOKORO\_EN -> `const` **KOKORO_EN**: `object` +> `const` **KOKORO\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/models.ts#L9) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/models.ts#L9) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md index c8ea641f6..beb6d7cd9 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -1,5 +1,5 @@ -# Variable: KOKORO_VOICE_AF_HEART +# Variable: KOKORO\_VOICE\_AF\_HEART -> `const` **KOKORO_VOICE_AF_HEART**: `VoiceConfig` +> `const` **KOKORO\_VOICE\_AF\_HEART**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L21) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md index 684f95a39..01511285b 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -1,5 +1,5 @@ -# Variable: KOKORO_VOICE_AF_RIVER +# Variable: KOKORO\_VOICE\_AF\_RIVER -> `const` **KOKORO_VOICE_AF_RIVER**: `VoiceConfig` +> `const` **KOKORO\_VOICE\_AF\_RIVER**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L26) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L26) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md index 7e15c5308..2f467da4f 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -1,5 +1,5 @@ -# Variable: KOKORO_VOICE_AF_SARAH +# Variable: KOKORO\_VOICE\_AF\_SARAH -> `const` **KOKORO_VOICE_AF_SARAH**: `VoiceConfig` +> `const` **KOKORO\_VOICE\_AF\_SARAH**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L31) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L31) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md index 38beab25c..c40b60617 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -1,5 +1,5 @@ -# Variable: KOKORO_VOICE_AM_ADAM +# Variable: KOKORO\_VOICE\_AM\_ADAM -> `const` **KOKORO_VOICE_AM_ADAM**: `VoiceConfig` +> `const` **KOKORO\_VOICE\_AM\_ADAM**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L36) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L36) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md index 89f43b98d..8d78c3af6 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -1,5 +1,5 @@ -# Variable: KOKORO_VOICE_AM_MICHAEL +# Variable: KOKORO\_VOICE\_AM\_MICHAEL -> `const` **KOKORO_VOICE_AM_MICHAEL**: `VoiceConfig` +> `const` **KOKORO\_VOICE\_AM\_MICHAEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L41) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md index 3f366276f..ee624a8fc 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -1,5 +1,5 @@ -# Variable: KOKORO_VOICE_AM_SANTA +# Variable: KOKORO\_VOICE\_AM\_SANTA -> `const` **KOKORO_VOICE_AM_SANTA**: `VoiceConfig` +> `const` **KOKORO\_VOICE\_AM\_SANTA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L46) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md index 817b7565b..ddbbb96a6 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -1,5 +1,5 @@ -# Variable: KOKORO_VOICE_BF_EMMA +# Variable: KOKORO\_VOICE\_BF\_EMMA -> `const` **KOKORO_VOICE_BF_EMMA**: `VoiceConfig` +> `const` **KOKORO\_VOICE\_BF\_EMMA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L51) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L51) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md index a152389df..b41380fd4 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -1,5 +1,5 @@ -# Variable: KOKORO_VOICE_BM_DANIEL +# Variable: KOKORO\_VOICE\_BM\_DANIEL -> `const` **KOKORO_VOICE_BM_DANIEL**: `VoiceConfig` +> `const` **KOKORO\_VOICE\_BM\_DANIEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/tts/voices.ts#L56) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L56) 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 7fa696a99..4279417b8 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -1,8 +1,8 @@ -# Variable: LLAMA3_2_1B +# Variable: LLAMA3\_2\_1B -> `const` **LLAMA3_2_1B**: `object` +> `const` **LLAMA3\_2\_1B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L34) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L34) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md index 4eafaf042..3ebf0add9 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 @@ -1,8 +1,8 @@ -# Variable: LLAMA3_2_1B_QLORA +# Variable: LLAMA3\_2\_1B\_QLORA -> `const` **LLAMA3_2_1B_QLORA**: `object` +> `const` **LLAMA3\_2\_1B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L40) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L40) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md index 41d91225d..ad6079d2b 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 @@ -1,8 +1,8 @@ -# Variable: LLAMA3_2_1B_SPINQUANT +# Variable: LLAMA3\_2\_1B\_SPINQUANT -> `const` **LLAMA3_2_1B_SPINQUANT**: `object` +> `const` **LLAMA3\_2\_1B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L46) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md index 4a0c028ac..82682e321 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -1,8 +1,8 @@ -# Variable: LLAMA3_2_3B +# Variable: LLAMA3\_2\_3B -> `const` **LLAMA3_2_3B**: `object` +> `const` **LLAMA3\_2\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L16) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L16) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md index 1b1a28d99..756fc2457 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 @@ -1,8 +1,8 @@ -# Variable: LLAMA3_2_3B_QLORA +# Variable: LLAMA3\_2\_3B\_QLORA -> `const` **LLAMA3_2_3B_QLORA**: `object` +> `const` **LLAMA3\_2\_3B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L22) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md index bcad89ac9..b05cebefe 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 @@ -1,8 +1,8 @@ -# Variable: LLAMA3_2_3B_SPINQUANT +# Variable: LLAMA3\_2\_3B\_SPINQUANT -> `const` **LLAMA3_2_3B_SPINQUANT**: `object` +> `const` **LLAMA3\_2\_3B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L28) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L28) ## 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 8802514ef..be26e55cb 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 @@ -1,8 +1,8 @@ -# Variable: MULTI_QA_MINILM_L6_COS_V1 +# Variable: MULTI\_QA\_MINILM\_L6\_COS\_V1 -> `const` **MULTI_QA_MINILM_L6_COS_V1**: `object` +> `const` **MULTI\_QA\_MINILM\_L6\_COS\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L418) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L418) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md index f60a3ad7c..f67a5065d 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 @@ -1,8 +1,8 @@ -# Variable: MULTI_QA_MPNET_BASE_DOT_V1 +# Variable: MULTI\_QA\_MPNET\_BASE\_DOT\_V1 -> `const` **MULTI_QA_MPNET_BASE_DOT_V1**: `object` +> `const` **MULTI\_QA\_MPNET\_BASE\_DOT\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md index 1ead9a99e..5f6d0c4b5 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -1,8 +1,8 @@ -# Variable: OCR_ABAZA +# Variable: OCR\_ABAZA -> `const` **OCR_ABAZA**: `object` +> `const` **OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L41) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md index 1b29e12e6..eb3d24f3b 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -1,8 +1,8 @@ -# Variable: OCR_ADYGHE +# Variable: OCR\_ADYGHE -> `const` **OCR_ADYGHE**: `object` +> `const` **OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L47) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L47) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md index 88864c53b..a183cd01d 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -1,8 +1,8 @@ -# Variable: OCR_AFRIKAANS +# Variable: OCR\_AFRIKAANS -> `const` **OCR_AFRIKAANS**: `object` +> `const` **OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L53) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L53) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md index 988daa042..b3e882936 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_ALBANIAN +# Variable: OCR\_ALBANIAN -> `const` **OCR_ALBANIAN**: `object` +> `const` **OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L362) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L362) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md index 2e7a31989..c921c6baf 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -1,8 +1,8 @@ -# Variable: OCR_AVAR +# Variable: OCR\_AVAR -> `const` **OCR_AVAR**: `object` +> `const` **OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L59) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L59) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md index b9f30da49..4988914f0 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -1,8 +1,8 @@ -# Variable: OCR_AZERBAIJANI +# Variable: OCR\_AZERBAIJANI -> `const` **OCR_AZERBAIJANI**: `object` +> `const` **OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L65) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L65) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md index ff49d8899..4e00e31af 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_BELARUSIAN +# Variable: OCR\_BELARUSIAN -> `const` **OCR_BELARUSIAN**: `object` +> `const` **OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L71) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L71) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md index 88a899010..c499b5b04 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_BOSNIAN +# Variable: OCR\_BOSNIAN -> `const` **OCR_BOSNIAN**: `object` +> `const` **OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L83) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L83) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md index 96980a160..5fef0e3dd 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_BULGARIAN +# Variable: OCR\_BULGARIAN -> `const` **OCR_BULGARIAN**: `object` +> `const` **OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L77) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L77) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md index 743dd8baf..dd4d0f063 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -1,8 +1,8 @@ -# Variable: OCR_CHECHEN +# Variable: OCR\_CHECHEN -> `const` **OCR_CHECHEN**: `object` +> `const` **OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L98) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L98) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md index 616700fc5..6867c7c00 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_CROATIAN +# Variable: OCR\_CROATIAN -> `const` **OCR_CROATIAN**: `object` +> `const` **OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L164) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L164) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md index 98a7bf367..b1ae7d970 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -1,8 +1,8 @@ -# Variable: OCR_CZECH +# Variable: OCR\_CZECH -> `const` **OCR_CZECH**: `object` +> `const` **OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L104) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L104) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md index 618234dc0..e22875eab 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -1,8 +1,8 @@ -# Variable: OCR_DANISH +# Variable: OCR\_DANISH -> `const` **OCR_DANISH**: `object` +> `const` **OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L116) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L116) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md index 4e5af610f..d73b10d65 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -1,8 +1,8 @@ -# Variable: OCR_DARGWA +# Variable: OCR\_DARGWA -> `const` **OCR_DARGWA**: `object` +> `const` **OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L122) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L122) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md index 2bfc5c667..f5b75b820 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -1,8 +1,8 @@ -# Variable: OCR_DUTCH +# Variable: OCR\_DUTCH -> `const` **OCR_DUTCH**: `object` +> `const` **OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L284) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md index b6ebe3880..8819ac5a1 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -1,8 +1,8 @@ -# Variable: OCR_ENGLISH +# Variable: OCR\_ENGLISH -> `const` **OCR_ENGLISH**: `object` +> `const` **OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L134) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L134) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md index 31877ae32..214729225 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_ESTONIAN +# Variable: OCR\_ESTONIAN -> `const` **OCR_ESTONIAN**: `object` +> `const` **OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L146) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L146) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md index f007c43c0..f5cea7f26 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -1,8 +1,8 @@ -# Variable: OCR_FRENCH +# Variable: OCR\_FRENCH -> `const` **OCR_FRENCH**: `object` +> `const` **OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L152) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L152) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md index dc2e382f9..8d6a731bf 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_GERMAN +# Variable: OCR\_GERMAN -> `const` **OCR_GERMAN**: `object` +> `const` **OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L128) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L128) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md index 5ea41f175..34a287a10 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_HUNGARIAN +# Variable: OCR\_HUNGARIAN -> `const` **OCR_HUNGARIAN**: `object` +> `const` **OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L170) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L170) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md index 91e1d1d25..9a5a51291 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -1,8 +1,8 @@ -# Variable: OCR_ICELANDIC +# Variable: OCR\_ICELANDIC -> `const` **OCR_ICELANDIC**: `object` +> `const` **OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L188) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L188) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md index 0d40e4250..50b3d5a79 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_INDONESIAN +# Variable: OCR\_INDONESIAN -> `const` **OCR_INDONESIAN**: `object` +> `const` **OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L176) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L176) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md index 907f0f820..968e8c622 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -1,8 +1,8 @@ -# Variable: OCR_INGUSH +# Variable: OCR\_INGUSH -> `const` **OCR_INGUSH**: `object` +> `const` **OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L182) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L182) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md index a2e788efc..8ae3b6b7d 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -1,8 +1,8 @@ -# Variable: OCR_IRISH +# Variable: OCR\_IRISH -> `const` **OCR_IRISH**: `object` +> `const` **OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L158) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L158) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md index 019c2fba5..53eab4633 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_ITALIAN +# Variable: OCR\_ITALIAN -> `const` **OCR_ITALIAN**: `object` +> `const` **OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L194) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L194) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md index a5dd9e1da..192be0161 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -1,8 +1,8 @@ -# Variable: OCR_JAPANESE +# Variable: OCR\_JAPANESE -> `const` **OCR_JAPANESE**: `object` +> `const` **OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md index 8dbe27eb9..7e07decbe 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -1,8 +1,8 @@ -# Variable: OCR_KANNADA +# Variable: OCR\_KANNADA -> `const` **OCR_KANNADA**: `object` +> `const` **OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md index 71396d447..e8ebf56ff 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_KARBADIAN +# Variable: OCR\_KARBADIAN -> `const` **OCR_KARBADIAN**: `object` +> `const` **OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md index 2bc5e5c3a..6b7c925e9 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_KOREAN +# Variable: OCR\_KOREAN -> `const` **OCR_KOREAN**: `object` +> `const` **OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md index bf342cea1..da94ee29b 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -1,8 +1,8 @@ -# Variable: OCR_KURDISH +# Variable: OCR\_KURDISH -> `const` **OCR_KURDISH**: `object` +> `const` **OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md index 8b9000086..904d78db8 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -1,8 +1,8 @@ -# Variable: OCR_LAK +# Variable: OCR\_LAK -> `const` **OCR_LAK**: `object` +> `const` **OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L236) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L236) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md index caa27edb4..4e622edd0 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -1,8 +1,8 @@ -# Variable: OCR_LATIN +# Variable: OCR\_LATIN -> `const` **OCR_LATIN**: `object` +> `const` **OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md index 21b1e305a..983921edb 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_LATVIAN +# Variable: OCR\_LATVIAN -> `const` **OCR_LATVIAN**: `object` +> `const` **OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L254) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L254) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md index 1d78fb116..94820a459 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_LEZGHIAN +# Variable: OCR\_LEZGHIAN -> `const` **OCR_LEZGHIAN**: `object` +> `const` **OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md index d657dbba8..474561067 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_LITHUANIAN +# Variable: OCR\_LITHUANIAN -> `const` **OCR_LITHUANIAN**: `object` +> `const` **OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md index 1cab7b152..b19a32e7d 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -1,8 +1,8 @@ -# Variable: OCR_MALAY +# Variable: OCR\_MALAY -> `const` **OCR_MALAY**: `object` +> `const` **OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L272) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L272) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md index 8b425bbb7..564f6b7e9 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -1,8 +1,8 @@ -# Variable: OCR_MALTESE +# Variable: OCR\_MALTESE -> `const` **OCR_MALTESE**: `object` +> `const` **OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L278) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L278) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md index 24ffebdf5..270a62bae 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -1,8 +1,8 @@ -# Variable: OCR_MAORI +# Variable: OCR\_MAORI -> `const` **OCR_MAORI**: `object` +> `const` **OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L260) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md index 86e521871..07f90bcb0 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_MONGOLIAN +# Variable: OCR\_MONGOLIAN -> `const` **OCR_MONGOLIAN**: `object` +> `const` **OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L266) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L266) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md index 67b9ec398..07384c1f5 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_NORWEGIAN +# Variable: OCR\_NORWEGIAN -> `const` **OCR_NORWEGIAN**: `object` +> `const` **OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L290) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L290) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md index 01a80516a..65e4cbaae 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_OCCITAN +# Variable: OCR\_OCCITAN -> `const` **OCR_OCCITAN**: `object` +> `const` **OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L296) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L296) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md index a581dcb71..cf2ba9262 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -1,8 +1,8 @@ -# Variable: OCR_PALI +# Variable: OCR\_PALI -> `const` **OCR_PALI**: `object` +> `const` **OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L302) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md index 27b3343e7..c1db60c14 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -1,8 +1,8 @@ -# Variable: OCR_POLISH +# Variable: OCR\_POLISH -> `const` **OCR_POLISH**: `object` +> `const` **OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L308) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L308) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md index d5588ecda..349c73995 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -1,8 +1,8 @@ -# Variable: OCR_PORTUGUESE +# Variable: OCR\_PORTUGUESE -> `const` **OCR_PORTUGUESE**: `object` +> `const` **OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L314) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L314) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md index dd389d7d8..8c45d5bfb 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_ROMANIAN +# Variable: OCR\_ROMANIAN -> `const` **OCR_ROMANIAN**: `object` +> `const` **OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L320) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L320) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md index b5859d4fd..c06293b70 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_RUSSIAN +# Variable: OCR\_RUSSIAN -> `const` **OCR_RUSSIAN**: `object` +> `const` **OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L326) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L326) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md index 2bd961a6c..1d739773c 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -1,8 +1,8 @@ -# Variable: OCR_SERBIAN_CYRILLIC +# Variable: OCR\_SERBIAN\_CYRILLIC -> `const` **OCR_SERBIAN_CYRILLIC**: `object` +> `const` **OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L332) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L332) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md index 2fcd4f40e..da57e75c8 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -1,8 +1,8 @@ -# Variable: OCR_SERBIAN_LATIN +# Variable: OCR\_SERBIAN\_LATIN -> `const` **OCR_SERBIAN_LATIN**: `object` +> `const` **OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L341) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L341) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md index af47b90c2..49773fbef 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -1,8 +1,8 @@ -# Variable: OCR_SIMPLIFIED_CHINESE +# Variable: OCR\_SIMPLIFIED\_CHINESE -> `const` **OCR_SIMPLIFIED_CHINESE**: `object` +> `const` **OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L89) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L89) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md index ac87adcfb..cd6288eac 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -1,8 +1,8 @@ -# Variable: OCR_SLOVAK +# Variable: OCR\_SLOVAK -> `const` **OCR_SLOVAK**: `object` +> `const` **OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L350) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L350) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md index edfc63169..358136883 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_SLOVENIAN +# Variable: OCR\_SLOVENIAN -> `const` **OCR_SLOVENIAN**: `object` +> `const` **OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L356) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L356) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md index 1bc9616dd..4f3bf12d3 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -1,8 +1,8 @@ -# Variable: OCR_SPANISH +# Variable: OCR\_SPANISH -> `const` **OCR_SPANISH**: `object` +> `const` **OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L140) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L140) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md index 4c87a7a68..d290f3b37 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -1,8 +1,8 @@ -# Variable: OCR_SWAHILI +# Variable: OCR\_SWAHILI -> `const` **OCR_SWAHILI**: `object` +> `const` **OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L374) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L374) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md index dd1d5ee22..253770fb9 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -1,8 +1,8 @@ -# Variable: OCR_SWEDISH +# Variable: OCR\_SWEDISH -> `const` **OCR_SWEDISH**: `object` +> `const` **OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md index ca24d5d07..be43b02ad 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_TABASSARAN +# Variable: OCR\_TABASSARAN -> `const` **OCR_TABASSARAN**: `object` +> `const` **OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L380) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L380) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md index 46462a629..76439b0ec 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -1,8 +1,8 @@ -# Variable: OCR_TAGALOG +# Variable: OCR\_TAGALOG -> `const` **OCR_TAGALOG**: `object` +> `const` **OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L398) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L398) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md index 3ec48531a..175cc8125 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -1,8 +1,8 @@ -# Variable: OCR_TAJIK +# Variable: OCR\_TAJIK -> `const` **OCR_TAJIK**: `object` +> `const` **OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md index d5e3e73d6..bb7335d83 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -1,8 +1,8 @@ -# Variable: OCR_TELUGU +# Variable: OCR\_TELUGU -> `const` **OCR_TELUGU**: `object` +> `const` **OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L386) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L386) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md index e8ce416b6..96524c1c6 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -1,8 +1,8 @@ -# Variable: OCR_TURKISH +# Variable: OCR\_TURKISH -> `const` **OCR_TURKISH**: `object` +> `const` **OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L404) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L404) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md index e78d09ebf..82deaacdd 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -1,8 +1,8 @@ -# Variable: OCR_UKRAINIAN +# Variable: OCR\_UKRAINIAN -> `const` **OCR_UKRAINIAN**: `object` +> `const` **OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L410) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L410) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md index afa5a149b..06c254a2c 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -1,8 +1,8 @@ -# Variable: OCR_UZBEK +# Variable: OCR\_UZBEK -> `const` **OCR_UZBEK**: `object` +> `const` **OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L416) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L416) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md index b54874ece..20c7f0f0b 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -1,8 +1,8 @@ -# Variable: OCR_VIETNAMESE +# Variable: OCR\_VIETNAMESE -> `const` **OCR_VIETNAMESE**: `object` +> `const` **OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L422) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L422) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md index 705e896d7..ed9009963 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -1,8 +1,8 @@ -# Variable: OCR_WELSH +# Variable: OCR\_WELSH -> `const` **OCR_WELSH**: `object` +> `const` **OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L110) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L110) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md index 38a027ade..f03c566fb 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 @@ -1,8 +1,8 @@ -# Variable: PHI_4_MINI_4B +# Variable: PHI\_4\_MINI\_4B -> `const` **PHI_4_MINI_4B**: `object` +> `const` **PHI\_4\_MINI\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md index be1e4d139..4e7e404d8 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 @@ -1,8 +1,8 @@ -# Variable: PHI_4_MINI_4B_QUANTIZED +# Variable: PHI\_4\_MINI\_4B\_QUANTIZED -> `const` **PHI_4_MINI_4B_QUANTIZED**: `object` +> `const` **PHI\_4\_MINI\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md index 933962cff..dc8d3ad39 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 @@ -1,8 +1,8 @@ -# Variable: QWEN2_5_0_5B +# Variable: QWEN2\_5\_0\_5B -> `const` **QWEN2_5_0_5B**: `object` +> `const` **QWEN2\_5\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md index 8f27b79ff..20b8b5cad 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 @@ -1,8 +1,8 @@ -# Variable: QWEN2_5_0_5B_QUANTIZED +# Variable: QWEN2\_5\_0\_5B\_QUANTIZED -> `const` **QWEN2_5_0_5B_QUANTIZED**: `object` +> `const` **QWEN2\_5\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md index a3e7b189a..9fca9e80c 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 @@ -1,8 +1,8 @@ -# Variable: QWEN2_5_1_5B +# Variable: QWEN2\_5\_1\_5B -> `const` **QWEN2_5_1_5B**: `object` +> `const` **QWEN2\_5\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md index 130911e87..7f39cc260 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 @@ -1,8 +1,8 @@ -# Variable: QWEN2_5_1_5B_QUANTIZED +# Variable: QWEN2\_5\_1\_5B\_QUANTIZED -> `const` **QWEN2_5_1_5B_QUANTIZED**: `object` +> `const` **QWEN2\_5\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md index 03716b914..f3c72a583 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -1,8 +1,8 @@ -# Variable: QWEN2_5_3B +# Variable: QWEN2\_5\_3B -> `const` **QWEN2_5_3B**: `object` +> `const` **QWEN2\_5\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md index 9b8543039..c33496f9d 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 @@ -1,8 +1,8 @@ -# Variable: QWEN2_5_3B_QUANTIZED +# Variable: QWEN2\_5\_3B\_QUANTIZED -> `const` **QWEN2_5_3B_QUANTIZED**: `object` +> `const` **QWEN2\_5\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md index c87cb1569..2702799ea 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -1,8 +1,8 @@ -# Variable: QWEN3_0_6B +# Variable: QWEN3\_0\_6B -> `const` **QWEN3_0_6B**: `object` +> `const` **QWEN3\_0\_6B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L62) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L62) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md index 204ba8822..79d5de810 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 @@ -1,8 +1,8 @@ -# Variable: QWEN3_0_6B_QUANTIZED +# Variable: QWEN3\_0\_6B\_QUANTIZED -> `const` **QWEN3_0_6B_QUANTIZED**: `object` +> `const` **QWEN3\_0\_6B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L68) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L68) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md index c895c9926..dab6a8ca8 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -1,8 +1,8 @@ -# Variable: QWEN3_1_7B +# Variable: QWEN3\_1\_7B -> `const` **QWEN3_1_7B**: `object` +> `const` **QWEN3\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L74) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L74) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md index 56b58b1ff..21c0b656d 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 @@ -1,8 +1,8 @@ -# Variable: QWEN3_1_7B_QUANTIZED +# Variable: QWEN3\_1\_7B\_QUANTIZED -> `const` **QWEN3_1_7B_QUANTIZED**: `object` +> `const` **QWEN3\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L80) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L80) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index 02d7c1537..b90dd4bb6 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -1,8 +1,8 @@ -# Variable: QWEN3_4B +# Variable: QWEN3\_4B -> `const` **QWEN3_4B**: `object` +> `const` **QWEN3\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L86) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L86) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md index b329b4dcb..c51ada492 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -1,8 +1,8 @@ -# Variable: QWEN3_4B_QUANTIZED +# Variable: QWEN3\_4B\_QUANTIZED -> `const` **QWEN3_4B_QUANTIZED**: `object` +> `const` **QWEN3\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L92) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L92) ## 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 97f8d3615..c92414218 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -1,8 +1,8 @@ -# Variable: SMOLLM2_1_135M +# Variable: SMOLLM2\_1\_135M -> `const` **SMOLLM2_1_135M**: `object` +> `const` **SMOLLM2\_1\_135M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L154) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L154) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md index 35419a82e..2acc2602b 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 @@ -1,8 +1,8 @@ -# Variable: SMOLLM2_1_135M_QUANTIZED +# Variable: SMOLLM2\_1\_135M\_QUANTIZED -> `const` **SMOLLM2_1_135M_QUANTIZED**: `object` +> `const` **SMOLLM2\_1\_135M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L160) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L160) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md index 0c8f1b63f..0766dbcb0 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 @@ -1,8 +1,8 @@ -# Variable: SMOLLM2_1_1_7B +# Variable: SMOLLM2\_1\_1\_7B -> `const` **SMOLLM2_1_1_7B**: `object` +> `const` **SMOLLM2\_1\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L178) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L178) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md index 851c909b5..b77f9923b 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 @@ -1,8 +1,8 @@ -# Variable: SMOLLM2_1_1_7B_QUANTIZED +# Variable: SMOLLM2\_1\_1\_7B\_QUANTIZED -> `const` **SMOLLM2_1_1_7B_QUANTIZED**: `object` +> `const` **SMOLLM2\_1\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L184) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L184) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md index 4c3c5846b..22eff8120 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -1,8 +1,8 @@ -# Variable: SMOLLM2_1_360M +# Variable: SMOLLM2\_1\_360M -> `const` **SMOLLM2_1_360M**: `object` +> `const` **SMOLLM2\_1\_360M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L166) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L166) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md index 51824d209..f39084fed 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 @@ -1,8 +1,8 @@ -# Variable: SMOLLM2_1_360M_QUANTIZED +# Variable: SMOLLM2\_1\_360M\_QUANTIZED -> `const` **SMOLLM2_1_360M_QUANTIZED**: `object` +> `const` **SMOLLM2\_1\_360M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L172) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L172) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md index 5bc68627f..f78cf2c53 100644 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -1,35 +1,35 @@ -# Variable: SPECIAL_TOKENS +# Variable: SPECIAL\_TOKENS -> `const` **SPECIAL_TOKENS**: `object` +> `const` **SPECIAL\_TOKENS**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:217](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/types/llm.ts#L217) +Defined in: [packages/react-native-executorch/src/types/llm.ts:216](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L216) ## Type Declaration -### BOS_TOKEN +### BOS\_TOKEN -> **BOS_TOKEN**: `string` = `'bos_token'` +> **BOS\_TOKEN**: `string` = `'bos_token'` -### CLS_TOKEN +### CLS\_TOKEN -> **CLS_TOKEN**: `string` = `'cls_token'` +> **CLS\_TOKEN**: `string` = `'cls_token'` -### EOS_TOKEN +### EOS\_TOKEN -> **EOS_TOKEN**: `string` = `'eos_token'` +> **EOS\_TOKEN**: `string` = `'eos_token'` -### MASK_TOKEN +### MASK\_TOKEN -> **MASK_TOKEN**: `string` = `'mask_token'` +> **MASK\_TOKEN**: `string` = `'mask_token'` -### PAD_TOKEN +### PAD\_TOKEN -> **PAD_TOKEN**: `string` = `'pad_token'` +> **PAD\_TOKEN**: `string` = `'pad_token'` -### SEP_TOKEN +### SEP\_TOKEN -> **SEP_TOKEN**: `string` = `'sep_token'` +> **SEP\_TOKEN**: `string` = `'sep_token'` -### UNK_TOKEN +### UNK\_TOKEN -> **UNK_TOKEN**: `string` = `'unk_token'` +> **UNK\_TOKEN**: `string` = `'unk_token'` diff --git a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md index 5e387c0cd..d6866cd6c 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 @@ -1,8 +1,8 @@ -# Variable: SSDLITE_320_MOBILENET_V3_LARGE +# Variable: SSDLITE\_320\_MOBILENET\_V3\_LARGE -> `const` **SSDLITE_320_MOBILENET_V3_LARGE**: `object` +> `const` **SSDLITE\_320\_MOBILENET\_V3\_LARGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L267) ## 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 2ae14a488..ec3706d25 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -1,8 +1,8 @@ -# Variable: STYLE_TRANSFER_CANDY +# Variable: STYLE\_TRANSFER\_CANDY -> `const` **STYLE_TRANSFER_CANDY**: `object` +> `const` **STYLE\_TRANSFER\_CANDY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L289) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L289) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md index 7f6de7860..5dbca5d17 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -1,8 +1,8 @@ -# Variable: STYLE_TRANSFER_MOSAIC +# Variable: STYLE\_TRANSFER\_MOSAIC -> `const` **STYLE_TRANSFER_MOSAIC**: `object` +> `const` **STYLE\_TRANSFER\_MOSAIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L293) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L293) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md index ed5e479ef..2faf5ba97 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 @@ -1,8 +1,8 @@ -# Variable: STYLE_TRANSFER_RAIN_PRINCESS +# Variable: STYLE\_TRANSFER\_RAIN\_PRINCESS -> `const` **STYLE_TRANSFER_RAIN_PRINCESS**: `object` +> `const` **STYLE\_TRANSFER\_RAIN\_PRINCESS**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md index a9c1fde9b..af441464f 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -1,8 +1,8 @@ -# Variable: STYLE_TRANSFER_UDNIE +# Variable: STYLE\_TRANSFER\_UDNIE -> `const` **STYLE_TRANSFER_UDNIE**: `object` +> `const` **STYLE\_TRANSFER\_UDNIE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L301) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L301) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md index 2aaa64a93..509d9bce7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_ABAZA +# Variable: VERTICAL\_OCR\_ABAZA -> `const` **VERTICAL_OCR_ABAZA**: `object` +> `const` **VERTICAL\_OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L42) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L42) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md index 9090b19d3..978d6fbe2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_ADYGHE +# Variable: VERTICAL\_OCR\_ADYGHE -> `const` **VERTICAL_OCR_ADYGHE**: `object` +> `const` **VERTICAL\_OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L48) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L48) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md index ff2972c3a..2216be767 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_AFRIKAANS +# Variable: VERTICAL\_OCR\_AFRIKAANS -> `const` **VERTICAL_OCR_AFRIKAANS**: `object` +> `const` **VERTICAL\_OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L54) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L54) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md index 4eb7ad342..5ff5864db 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_ALBANIAN +# Variable: VERTICAL\_OCR\_ALBANIAN -> `const` **VERTICAL_OCR_ALBANIAN**: `object` +> `const` **VERTICAL\_OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L363) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L363) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md index 1513f17f8..b9f1110aa 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_AVAR +# Variable: VERTICAL\_OCR\_AVAR -> `const` **VERTICAL_OCR_AVAR**: `object` +> `const` **VERTICAL\_OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L60) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L60) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md index a0116b64a..cd27e95de 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_AZERBAIJANI +# Variable: VERTICAL\_OCR\_AZERBAIJANI -> `const` **VERTICAL_OCR_AZERBAIJANI**: `object` +> `const` **VERTICAL\_OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L66) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L66) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md index 035908210..cf7c07cd7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_BELARUSIAN +# Variable: VERTICAL\_OCR\_BELARUSIAN -> `const` **VERTICAL_OCR_BELARUSIAN**: `object` +> `const` **VERTICAL\_OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L72) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L72) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md index 198120d5b..79d7ca97e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_BOSNIAN +# Variable: VERTICAL\_OCR\_BOSNIAN -> `const` **VERTICAL_OCR_BOSNIAN**: `object` +> `const` **VERTICAL\_OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L84) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L84) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md index 919ee820a..cde882385 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_BULGARIAN +# Variable: VERTICAL\_OCR\_BULGARIAN -> `const` **VERTICAL_OCR_BULGARIAN**: `object` +> `const` **VERTICAL\_OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L78) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L78) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md index 46f2259d8..f1646af72 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_CHECHEN +# Variable: VERTICAL\_OCR\_CHECHEN -> `const` **VERTICAL_OCR_CHECHEN**: `object` +> `const` **VERTICAL\_OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L99) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L99) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md index 899d802b6..aecf7c806 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_CROATIAN +# Variable: VERTICAL\_OCR\_CROATIAN -> `const` **VERTICAL_OCR_CROATIAN**: `object` +> `const` **VERTICAL\_OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L165) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L165) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md index a579ed59c..fff770de1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_CZECH +# Variable: VERTICAL\_OCR\_CZECH -> `const` **VERTICAL_OCR_CZECH**: `object` +> `const` **VERTICAL\_OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L105) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L105) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md index 5401ee13a..caf4aae6e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_DANISH +# Variable: VERTICAL\_OCR\_DANISH -> `const` **VERTICAL_OCR_DANISH**: `object` +> `const` **VERTICAL\_OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L117) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L117) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md index cef614a86..960ae16a0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_DARGWA +# Variable: VERTICAL\_OCR\_DARGWA -> `const` **VERTICAL_OCR_DARGWA**: `object` +> `const` **VERTICAL\_OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L123) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L123) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md index d65907046..6d76d5ff1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_DUTCH +# Variable: VERTICAL\_OCR\_DUTCH -> `const` **VERTICAL_OCR_DUTCH**: `object` +> `const` **VERTICAL\_OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L285) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L285) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md index 0d9695a72..683c0847d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_ENGLISH +# Variable: VERTICAL\_OCR\_ENGLISH -> `const` **VERTICAL_OCR_ENGLISH**: `object` +> `const` **VERTICAL\_OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L135) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L135) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md index 5bc55d1a8..bd23ea097 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_ESTONIAN +# Variable: VERTICAL\_OCR\_ESTONIAN -> `const` **VERTICAL_OCR_ESTONIAN**: `object` +> `const` **VERTICAL\_OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L147) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L147) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md index bcac00e8f..01b46b3a1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_FRENCH +# Variable: VERTICAL\_OCR\_FRENCH -> `const` **VERTICAL_OCR_FRENCH**: `object` +> `const` **VERTICAL\_OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L153) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L153) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md index 80679a77c..e540239bb 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_GERMAN +# Variable: VERTICAL\_OCR\_GERMAN -> `const` **VERTICAL_OCR_GERMAN**: `object` +> `const` **VERTICAL\_OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L129) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L129) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md index 501581274..822074683 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_HUNGARIAN +# Variable: VERTICAL\_OCR\_HUNGARIAN -> `const` **VERTICAL_OCR_HUNGARIAN**: `object` +> `const` **VERTICAL\_OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L171) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L171) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md index 9dcc08905..d032ecd4a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_ICELANDIC +# Variable: VERTICAL\_OCR\_ICELANDIC -> `const` **VERTICAL_OCR_ICELANDIC**: `object` +> `const` **VERTICAL\_OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L189) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L189) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md index 1edb7425d..53227441e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_INDONESIAN +# Variable: VERTICAL\_OCR\_INDONESIAN -> `const` **VERTICAL_OCR_INDONESIAN**: `object` +> `const` **VERTICAL\_OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L177) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L177) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md index f3474bf01..01c7d4936 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_INGUSH +# Variable: VERTICAL\_OCR\_INGUSH -> `const` **VERTICAL_OCR_INGUSH**: `object` +> `const` **VERTICAL\_OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L183) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L183) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md index e1d320202..08a2b5d57 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_IRISH +# Variable: VERTICAL\_OCR\_IRISH -> `const` **VERTICAL_OCR_IRISH**: `object` +> `const` **VERTICAL\_OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L159) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L159) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md index a5ccc4b04..414a9b455 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_ITALIAN +# Variable: VERTICAL\_OCR\_ITALIAN -> `const` **VERTICAL_OCR_ITALIAN**: `object` +> `const` **VERTICAL\_OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L195) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L195) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md index d0ef95787..8703fd6a7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_JAPANESE +# Variable: VERTICAL\_OCR\_JAPANESE -> `const` **VERTICAL_OCR_JAPANESE**: `object` +> `const` **VERTICAL\_OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L201) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L201) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md index 63bfb2089..d6803ad91 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_KANNADA +# Variable: VERTICAL\_OCR\_KANNADA -> `const` **VERTICAL_OCR_KANNADA**: `object` +> `const` **VERTICAL\_OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L213) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L213) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md index 62a5aedca..a7aafa5e4 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_KARBADIAN +# Variable: VERTICAL\_OCR\_KARBADIAN -> `const` **VERTICAL_OCR_KARBADIAN**: `object` +> `const` **VERTICAL\_OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L207) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L207) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md index 4a297545a..3ec71f642 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_KOREAN +# Variable: VERTICAL\_OCR\_KOREAN -> `const` **VERTICAL_OCR_KOREAN**: `object` +> `const` **VERTICAL\_OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L219) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L219) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md index fa1e1d58b..cc628a13e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_KURDISH +# Variable: VERTICAL\_OCR\_KURDISH -> `const` **VERTICAL_OCR_KURDISH**: `object` +> `const` **VERTICAL\_OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L225) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L225) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md index 14663480d..937326ad7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_LAK +# Variable: VERTICAL\_OCR\_LAK -> `const` **VERTICAL_OCR_LAK**: `object` +> `const` **VERTICAL\_OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L237) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L237) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md index 6800b38ce..8e71a3ac0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_LATIN +# Variable: VERTICAL\_OCR\_LATIN -> `const` **VERTICAL_OCR_LATIN**: `object` +> `const` **VERTICAL\_OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L231) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L231) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md index 29ffec97b..517b8071c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_LATVIAN +# Variable: VERTICAL\_OCR\_LATVIAN -> `const` **VERTICAL_OCR_LATVIAN**: `object` +> `const` **VERTICAL\_OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L255) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L255) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md index a1f3d7dd8..d96d2074c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_LEZGHIAN +# Variable: VERTICAL\_OCR\_LEZGHIAN -> `const` **VERTICAL_OCR_LEZGHIAN**: `object` +> `const` **VERTICAL\_OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L243) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L243) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md index 0f947e8f9..022db80b6 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_LITHUANIAN +# Variable: VERTICAL\_OCR\_LITHUANIAN -> `const` **VERTICAL_OCR_LITHUANIAN**: `object` +> `const` **VERTICAL\_OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L249) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L249) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md index c77f85e96..8046c0ebc 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_MALAY +# Variable: VERTICAL\_OCR\_MALAY -> `const` **VERTICAL_OCR_MALAY**: `object` +> `const` **VERTICAL\_OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L273) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L273) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md index cb1c6586f..1604b9b65 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_MALTESE +# Variable: VERTICAL\_OCR\_MALTESE -> `const` **VERTICAL_OCR_MALTESE**: `object` +> `const` **VERTICAL\_OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L279) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L279) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md index b5a78965f..c99bc1c40 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_MAORI +# Variable: VERTICAL\_OCR\_MAORI -> `const` **VERTICAL_OCR_MAORI**: `object` +> `const` **VERTICAL\_OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L261) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L261) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md index 686c5d537..0b7ee04b1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_MONGOLIAN +# Variable: VERTICAL\_OCR\_MONGOLIAN -> `const` **VERTICAL_OCR_MONGOLIAN**: `object` +> `const` **VERTICAL\_OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L267) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md index 8c2e4616d..a18488508 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_NORWEGIAN +# Variable: VERTICAL\_OCR\_NORWEGIAN -> `const` **VERTICAL_OCR_NORWEGIAN**: `object` +> `const` **VERTICAL\_OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L291) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L291) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md index d19321937..8a32df7ef 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_OCCITAN +# Variable: VERTICAL\_OCR\_OCCITAN -> `const` **VERTICAL_OCR_OCCITAN**: `object` +> `const` **VERTICAL\_OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md index 6977aed2d..45b2a4429 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_PALI +# Variable: VERTICAL\_OCR\_PALI -> `const` **VERTICAL_OCR_PALI**: `object` +> `const` **VERTICAL\_OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L303) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L303) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md index c96a451ab..41f23570e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_POLISH +# Variable: VERTICAL\_OCR\_POLISH -> `const` **VERTICAL_OCR_POLISH**: `object` +> `const` **VERTICAL\_OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L309) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L309) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md index 171e876df..678593c04 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_PORTUGUESE +# Variable: VERTICAL\_OCR\_PORTUGUESE -> `const` **VERTICAL_OCR_PORTUGUESE**: `object` +> `const` **VERTICAL\_OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L315) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L315) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md index 3a2900a15..a01ddcaa7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_ROMANIAN +# Variable: VERTICAL\_OCR\_ROMANIAN -> `const` **VERTICAL_OCR_ROMANIAN**: `object` +> `const` **VERTICAL\_OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L321) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L321) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md index 2a3a02750..6dd5c784c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_RUSSIAN +# Variable: VERTICAL\_OCR\_RUSSIAN -> `const` **VERTICAL_OCR_RUSSIAN**: `object` +> `const` **VERTICAL\_OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L327) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L327) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md index ee6ee80d1..d2a68b9e2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_SERBIAN_CYRILLIC +# Variable: VERTICAL\_OCR\_SERBIAN\_CYRILLIC -> `const` **VERTICAL_OCR_SERBIAN_CYRILLIC**: `object` +> `const` **VERTICAL\_OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L336) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L336) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md index 3890fefd3..5644f4dbe 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_SERBIAN_LATIN +# Variable: VERTICAL\_OCR\_SERBIAN\_LATIN -> `const` **VERTICAL_OCR_SERBIAN_LATIN**: `object` +> `const` **VERTICAL\_OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L345) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L345) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md index 12d8d4ff5..44eb7c455 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_SIMPLIFIED_CHINESE +# Variable: VERTICAL\_OCR\_SIMPLIFIED\_CHINESE -> `const` **VERTICAL_OCR_SIMPLIFIED_CHINESE**: `object` +> `const` **VERTICAL\_OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L93) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L93) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md index 12ab56c31..6a974e4ad 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_SLOVAK +# Variable: VERTICAL\_OCR\_SLOVAK -> `const` **VERTICAL_OCR_SLOVAK**: `object` +> `const` **VERTICAL\_OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L351) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L351) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md index 9917dd0d5..69e654129 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_SLOVENIAN +# Variable: VERTICAL\_OCR\_SLOVENIAN -> `const` **VERTICAL_OCR_SLOVENIAN**: `object` +> `const` **VERTICAL\_OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L357) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L357) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md index 94787947c..daa67a2eb 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_SPANISH +# Variable: VERTICAL\_OCR\_SPANISH -> `const` **VERTICAL_OCR_SPANISH**: `object` +> `const` **VERTICAL\_OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L141) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L141) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md index 50c0de77b..fd0ac5027 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_SWAHILI +# Variable: VERTICAL\_OCR\_SWAHILI -> `const` **VERTICAL_OCR_SWAHILI**: `object` +> `const` **VERTICAL\_OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md index 82516a3fd..a96eb788b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_SWEDISH +# Variable: VERTICAL\_OCR\_SWEDISH -> `const` **VERTICAL_OCR_SWEDISH**: `object` +> `const` **VERTICAL\_OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L369) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L369) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md index 9659482b8..fecab3d86 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_TABASSARAN +# Variable: VERTICAL\_OCR\_TABASSARAN -> `const` **VERTICAL_OCR_TABASSARAN**: `object` +> `const` **VERTICAL\_OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L381) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L381) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md index ce9faddf1..d65b992f9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_TAGALOG +# Variable: VERTICAL\_OCR\_TAGALOG -> `const` **VERTICAL_OCR_TAGALOG**: `object` +> `const` **VERTICAL\_OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L399) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L399) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md index e504df9a4..68a8e2aa7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_TAJIK +# Variable: VERTICAL\_OCR\_TAJIK -> `const` **VERTICAL_OCR_TAJIK**: `object` +> `const` **VERTICAL\_OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L393) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L393) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md index 7ca2210b2..7b6dceebb 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_TELUGU +# Variable: VERTICAL\_OCR\_TELUGU -> `const` **VERTICAL_OCR_TELUGU**: `object` +> `const` **VERTICAL\_OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L387) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L387) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md index 7ab47b448..a1a699978 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_TURKISH +# Variable: VERTICAL\_OCR\_TURKISH -> `const` **VERTICAL_OCR_TURKISH**: `object` +> `const` **VERTICAL\_OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L405) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L405) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md index 9a8ef1418..0eab58cca 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_UKRAINIAN +# Variable: VERTICAL\_OCR\_UKRAINIAN -> `const` **VERTICAL_OCR_UKRAINIAN**: `object` +> `const` **VERTICAL\_OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L411) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L411) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md index 320fe7383..c97b8f7e0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_UZBEK +# Variable: VERTICAL\_OCR\_UZBEK -> `const` **VERTICAL_OCR_UZBEK**: `object` +> `const` **VERTICAL\_OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L417) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L417) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md index 92b61958d..0efd33c92 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_VIETNAMESE +# Variable: VERTICAL\_OCR\_VIETNAMESE -> `const` **VERTICAL_OCR_VIETNAMESE**: `object` +> `const` **VERTICAL\_OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md index ab0053ed1..b11ebb4e8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md @@ -1,8 +1,8 @@ -# Variable: VERTICAL_OCR_WELSH +# Variable: VERTICAL\_OCR\_WELSH -> `const` **VERTICAL_OCR_WELSH**: `object` +> `const` **VERTICAL\_OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/ocr/models.ts#L111) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L111) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md index f3e0eceed..76e1cad3f 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -1,8 +1,8 @@ -# Variable: WHISPER_BASE +# Variable: WHISPER\_BASE -> `const` **WHISPER_BASE**: `object` +> `const` **WHISPER\_BASE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md index 996453f8c..f3b61eb15 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -1,8 +1,8 @@ -# Variable: WHISPER_BASE_EN +# Variable: WHISPER\_BASE\_EN -> `const` **WHISPER_BASE_EN**: `object` +> `const` **WHISPER\_BASE\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L347) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L347) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md index 0aa2764c9..32ede15ee 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -1,8 +1,8 @@ -# Variable: WHISPER_SMALL +# Variable: WHISPER\_SMALL -> `const` **WHISPER_SMALL**: `object` +> `const` **WHISPER\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md index dc0ef20a3..11a3e7cff 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -1,8 +1,8 @@ -# Variable: WHISPER_SMALL_EN +# Variable: WHISPER\_SMALL\_EN -> `const` **WHISPER_SMALL_EN**: `object` +> `const` **WHISPER\_SMALL\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L354) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L354) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md index e2406f07c..9198c48fa 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -1,8 +1,8 @@ -# Variable: WHISPER_TINY +# Variable: WHISPER\_TINY -> `const` **WHISPER_TINY**: `object` +> `const` **WHISPER\_TINY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L361) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L361) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md index 5ab1c059e..5c083c981 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -1,8 +1,8 @@ -# Variable: WHISPER_TINY_EN +# Variable: WHISPER\_TINY\_EN -> `const` **WHISPER_TINY_EN**: `object` +> `const` **WHISPER\_TINY\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L333) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L333) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md index 9b5d6e5f9..31dc4f48d 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 @@ -1,8 +1,8 @@ -# Variable: WHISPER_TINY_EN_QUANTIZED +# Variable: WHISPER\_TINY\_EN\_QUANTIZED -> `const` **WHISPER_TINY_EN_QUANTIZED**: `object` +> `const` **WHISPER\_TINY\_EN\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/constants/modelUrls.ts#L340) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L340) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md index 3f049951a..830072040 100644 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -2,7 +2,7 @@ > `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] -Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/cf09248d1b9fa5a88d8413f22ade5e99a246be08/packages/react-native-executorch/src/utils/llm.ts#L9) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/llm.ts#L9) ## Parameters diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts index cb5157860..c15bc7572 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts @@ -1,11 +1,12 @@ import { useEffect, useCallback, useState } from 'react'; import { SpeechToTextModule } from '../../modules/natural_language_processing/SpeechToTextModule'; -import { DecodingOptions, SpeechToTextModelConfig } from '../../types/stt'; +import { DecodingOptions, SpeechToTextModelConfig, SpeechToTextType } from '../../types/stt'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; /** - * + * React hook for managing a Speech to Text (STT) instance. + * * @param speechToTextConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use Speech to Text model. */ @@ -30,7 +31,7 @@ export const useSpeechToText = ({ * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. */ preventLoad?: boolean; -}) => { +}): SpeechToTextType => { const [error, setError] = useState(null); const [isReady, setIsReady] = useState(false); const [isGenerating, setIsGenerating] = useState(false); @@ -141,66 +142,17 @@ export const useSpeechToText = ({ ); return { - /** - * Contains the error message if the model failed to load. - */ error, - - /** - * Indicates whether the model has successfully loaded and is ready for inference. - */ isReady, - - /** - * Indicates whether the model is currently processing an inference. - */ isGenerating, - - /** - * Tracks the progress of the model download process. - */ downloadProgress, - - /** - * Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. - */ committedTranscription, - - /** - * Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. - */ nonCommittedTranscription, - - /** - * Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. - */ encode: stateWrapper(SpeechToTextModule.prototype.encode), - - /** - * Runs the decoder of the model. Passing `number[]` is deprecated. - * @param waveform - The encoded audio data. - */ decode: stateWrapper(SpeechToTextModule.prototype.decode), - - /** - * Starts a transcription process for a given input array, which should be a waveform at 16kHz. The second argument is an options object, e.g. `{ language: 'es' }` for multilingual models. Resolves a promise with the output transcription when the model is finished. Passing `number[]` is deprecated. - */ transcribe: stateWrapper(SpeechToTextModule.prototype.transcribe), - - /** - * Starts a streaming transcription process. Use in combination with `streamInsert` to feed audio chunks and `streamStop` to end the stream. The argument is an options object, e.g. `{ language: 'es' }` for multilingual models. Updates `committedTranscription` and `nonCommittedTranscription` as transcription progresses. - * @param options - Decoding options including language. - */ stream, - - /** - * Stops the ongoing streaming transcription process. - */ streamStop: wrapper(SpeechToTextModule.prototype.streamStop), - - /** - * Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Call this repeatedly as new audio data becomes available. Passing `number[]` is deprecated. - */ streamInsert: wrapper(SpeechToTextModule.prototype.streamInsert), }; }; 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 562aa456b..6b1b86d91 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,35 +1,14 @@ import { TextEmbeddingsModule } from '../../modules/natural_language_processing/TextEmbeddingsModule'; -import { ResourceSource } from '../../types/common'; import { useModule } from '../useModule'; +import { TextEmbeddingsType, Props } from '../../types/textEmbeddings'; /** - * Props for the useTextEmbeddings hook. - */ -export interface Props { - model: { - /** - * `ResourceSource` that specifies the location of the model binary. - */ - modelSource: ResourceSource; - - /** - * `ResourceSource` pointing to the JSON file which contains the tokenizer. - */ - tokenizerSource: ResourceSource; - }; - - /** - * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. - */ - preventLoad?: boolean; -} - -/** - * + * React hook for managing a Text Embeddings model instance. + * * @param TextEmbeddingsConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. - * @returns - Ready to use Text Embeddings model. + * @returns Ready to use Text Embeddings model. */ -export const useTextEmbeddings = ({ model, preventLoad = false }: Props) => +export const useTextEmbeddings = ({ model, preventLoad = false }: Props): TextEmbeddingsType => useModule({ module: TextEmbeddingsModule, model, diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts index 34e33067e..6b7ba2d23 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts @@ -3,14 +3,29 @@ import { TokenizerModule } from '../../modules/natural_language_processing/Token import { ResourceSource } from '../../types/common'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; +import { TokenizerType } from '../../types/tokenizer'; +/** + * + * @param tokenizerConfiguration - Configuration object containing `tokenizer` source and optional `preventLoad` flag. + * @returns Ready to use Tokenizer model. + */ export const useTokenizer = ({ tokenizer, preventLoad = false, }: { + /** + * Object containing: + * + * `tokenizerSource` - A `ResourceSource` that specifies the location of the tokenizer. + */ tokenizer: { tokenizerSource: ResourceSource }; + + /** + * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. + */ preventLoad?: boolean; -}) => { +}): TokenizerType => { const [error, setError] = useState(null); const [isReady, setIsReady] = useState(false); const [isGenerating, setIsGenerating] = useState(false); @@ -36,7 +51,7 @@ export const useTokenizer = ({ }, [tokenizerInstance, tokenizer.tokenizerSource, preventLoad]); const stateWrapper = Promise>(fn: T) => { - return (...args: Parameters): Promise> => { + return (...args: Parameters): Promise>> => { if (!isReady) throw new RnExecutorchError( RnExecutorchErrorCode.ModuleNotLoaded, diff --git a/packages/react-native-executorch/src/index.ts b/packages/react-native-executorch/src/index.ts index 3b8b3e8e4..81236510b 100644 --- a/packages/react-native-executorch/src/index.ts +++ b/packages/react-native-executorch/src/index.ts @@ -121,11 +121,10 @@ export * from './types/imageSegmentation'; export * from './types/llm'; export * from './types/vad'; export * from './types/common'; -export { - SpeechToTextLanguage, - SpeechToTextModelConfig, - DecodingOptions, -} from './types/stt'; +export * from './types/stt'; +export * from './types/textEmbeddings'; +export * from './types/tts'; +export * from './types/tokenizer'; // constants export * from './constants/modelUrls'; diff --git a/packages/react-native-executorch/src/types/stt.ts b/packages/react-native-executorch/src/types/stt.ts index 20627ca11..3b2dc7da4 100644 --- a/packages/react-native-executorch/src/types/stt.ts +++ b/packages/react-native-executorch/src/types/stt.ts @@ -1,4 +1,87 @@ import { ResourceSource } from './common'; +import { RnExecutorchError } from '../errors/errorUtils'; + +/** + * React hook for managing Speech to Text (STT) instance. + */ +export interface SpeechToTextType { + /** + * Contains the error message if the model failed to load. + */ + error: null | RnExecutorchError; + + /** + * Indicates whether the model has successfully loaded and is ready for inference. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently processing an inference. + */ + isGenerating: boolean; + + /** + * Tracks the progress of the model download process. + */ + downloadProgress: number; + + /** + * Contains the part of the transcription that is finalized and will not change. + * Useful for displaying stable results during streaming. + */ + committedTranscription: string; + + /** + * Contains the part of the transcription that is still being processed and may change. + * Useful for displaying live, partial results during streaming. + */ + nonCommittedTranscription: string; + + /** + * Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. + * @param waveform - The input audio waveform array. + * @returns A promise resolving to the encoded data. + */ + encode(waveform: Float32Array | number[]): Promise; + + /** + * Runs the decoder of the model. Passing `number[]` is deprecated. + * @param tokens - The encoded audio data. + * @param encoderOutput - The output from the encoder. + * @returns A promise resolving to the decoded text. + */ + decode(tokens: number[] | Int32Array, encoderOutput: Float32Array | number[]): Promise; + + /** + * Starts a transcription process for a given input array, which should be a waveform at 16kHz. + * Passing `number[]` is deprecated. + * @param waveform - The input audio waveform. + * @param options - Decoding options, e.g. `{ language: 'es' }` for multilingual models. + * @returns Resolves a promise with the output transcription when the model is finished. + */ + transcribe(waveform: Float32Array | number[], options?: DecodingOptions | undefined): Promise; + + /** + * Starts a streaming transcription process. + * Use in combination with streamInsert to feed audio chunks and streamStop to end the stream. + * Updates `committedTranscription` and `nonCommittedTranscription` as transcription progresses. + * @param options - Decoding options including language. + * @returns The final transcription string. + */ + stream(options?: DecodingOptions | undefined): Promise; + + /** + * Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. + * Passing `number[]` is deprecated. + * @param waveform - The audio chunk to insert. + */ + streamInsert(waveform: Float32Array | number[]): void; + + /** + * Stops the ongoing streaming transcription process. + */ + streamStop(): void; +} // Languages supported by whisper (not whisper.en) export type SpeechToTextLanguage = @@ -78,13 +161,37 @@ export type SpeechToTextLanguage = | 'cy' | 'yi'; +/** + * Options for decoding speech to text. + */ export interface DecodingOptions { + /** + * Optional language code to guide the transcription. + */ language?: SpeechToTextLanguage; } +/** + * Configuration for Speech to Text model. + */ export interface SpeechToTextModelConfig { + /** + * A boolean flag indicating whether the model supports multiple languages. + */ isMultilingual: boolean; + + /** + * A string that specifies the location of a `.pte` file for the encoder. + */ encoderSource: ResourceSource; + + /** + * A string that specifies the location of a `.pte` file for the decoder. + */ decoderSource: ResourceSource; + + /** + * A string that specifies the location to the tokenizer for the model. + */ tokenizerSource: ResourceSource; } diff --git a/packages/react-native-executorch/src/types/textEmbeddings.ts b/packages/react-native-executorch/src/types/textEmbeddings.ts new file mode 100644 index 000000000..8471b9604 --- /dev/null +++ b/packages/react-native-executorch/src/types/textEmbeddings.ts @@ -0,0 +1,56 @@ +import { RnExecutorchError } from '../errors/errorUtils'; +import { ResourceSource } from '../types/common'; + +/** + * React hook state and methods for managing a Text Embeddings model instance. + */ +export interface TextEmbeddingsType { + /** + * Contains the error message if the model failed to load or during inference. + */ + error: null | RnExecutorchError; + + /** + * Indicates whether the embeddings model has successfully loaded and is ready for inference. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently generating embeddings. + */ + isGenerating: boolean; + + /** + * Tracks the progress of the model download process (value between 0 and 1). + */ + downloadProgress: number; + + /** + * Runs the text embeddings model on the provided input string. + * * @param input - The text string to embed. + * @returns A promise resolving to a Float32Array containing the vector embeddings. + */ + forward(input: string): Promise; +} + +/** + * Props for the useTextEmbeddings hook. + */ +export interface Props { + model: { + /** + * `ResourceSource` that specifies the location of the model binary. + */ + modelSource: ResourceSource; + + /** + * `ResourceSource` pointing to the JSON file which contains the tokenizer. + */ + tokenizerSource: ResourceSource; + }; + + /** + * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. + */ + preventLoad?: boolean; +} \ No newline at end of file diff --git a/packages/react-native-executorch/src/types/tokenizer.ts b/packages/react-native-executorch/src/types/tokenizer.ts new file mode 100644 index 000000000..64798ec5b --- /dev/null +++ b/packages/react-native-executorch/src/types/tokenizer.ts @@ -0,0 +1,60 @@ +import { RnExecutorchError } from '../errors/errorUtils'; + +/** + * React hook state and methods for managing a Tokenizer instance. + */ +export interface TokenizerType { + /** + * Contains the error message if the tokenizer failed to load or during processing. + */ + error: null | RnExecutorchError; + + /** + * Indicates whether the tokenizer has successfully loaded and is ready for use. + */ + isReady: boolean; + + /** + * Indicates whether the tokenizer is currently processing data. + */ + isGenerating: boolean; + + /** + * Tracks the progress of the tokenizer download process (value between 0 and 1). + */ + downloadProgress: number; + + /** + * Converts an array of token IDs into a string. + * @param tokens - An array or `number[]` of token IDs to decode. + * @returns A promise resolving to the decoded text string. + */ + decode(tokens: number[], skipSpecialTokens: boolean | undefined): Promise; + + /** + * Converts a string into an array of token IDs. + * @param text - The input text string to tokenize. + * @returns A promise resolving to an array `number[]` containing the encoded token IDs. + */ + encode(text: string): Promise; + + /** + * Returns the size of the tokenizer's vocabulary. + * @returns A promise resolving to the vocabulary size. + */ + getVocabSize(): Promise; + + /** + * Returns the token associated to the ID. + * @param id - The numeric token ID. + * @returns A promise resolving to the token string representation. + */ + idToToken(id: number): Promise; + + /** + * Returns the ID associated to the token. + * @param token - The token string. + * @returns A promise resolving to the token ID. + */ + tokenToId(token: string): Promise; +} \ No newline at end of file From 2188c617e9a18df679d3c3ae0e6b3733afe77570 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Fri, 23 Jan 2026 18:03:45 +0100 Subject: [PATCH 05/15] Update yarn.lock with docusaurus plugin for typedoc --- docs/yarn.lock | 189 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 188 insertions(+), 1 deletion(-) diff --git a/docs/yarn.lock b/docs/yarn.lock index 8fe7ad114..351fd3330 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -2938,6 +2938,19 @@ __metadata: languageName: node linkType: hard +"@gerrit0/mini-shiki@npm:^3.17.0": + version: 3.21.0 + resolution: "@gerrit0/mini-shiki@npm:3.21.0" + dependencies: + "@shikijs/engine-oniguruma": "npm:^3.21.0" + "@shikijs/langs": "npm:^3.21.0" + "@shikijs/themes": "npm:^3.21.0" + "@shikijs/types": "npm:^3.21.0" + "@shikijs/vscode-textmate": "npm:^10.0.2" + checksum: 10/e3f997e18ff3e0654a951f3be2c8fa1deba02afa77865861fbedd62775ef06d38333c76b67ecab4cc38b07d4fe39720f8fe2170ac685323991b4ed7500079b11 + languageName: node + linkType: hard + "@hapi/hoek@npm:^9.0.0, @hapi/hoek@npm:^9.3.0": version: 9.3.0 resolution: "@hapi/hoek@npm:9.3.0" @@ -3734,6 +3747,51 @@ __metadata: languageName: node linkType: hard +"@shikijs/engine-oniguruma@npm:^3.21.0": + version: 3.21.0 + resolution: "@shikijs/engine-oniguruma@npm:3.21.0" + dependencies: + "@shikijs/types": "npm:3.21.0" + "@shikijs/vscode-textmate": "npm:^10.0.2" + checksum: 10/670dcb10195b7aabe7965921e7ff5e315182ca15287a61867f16df3046d8bb81b53416803f2fe6b12b5656be61e7a9990da3a5caf4d7d75b1386884b0e9568d1 + languageName: node + linkType: hard + +"@shikijs/langs@npm:^3.21.0": + version: 3.21.0 + resolution: "@shikijs/langs@npm:3.21.0" + dependencies: + "@shikijs/types": "npm:3.21.0" + checksum: 10/37c56fbfdacd3b74a4943cb8d481e3c3288eba72e55c76e34b1a56dd528f728d636c1691433d8bdc96cc5c0b63789754b9515995f28943580b6ef72abc5fd8d9 + languageName: node + linkType: hard + +"@shikijs/themes@npm:^3.21.0": + version: 3.21.0 + resolution: "@shikijs/themes@npm:3.21.0" + dependencies: + "@shikijs/types": "npm:3.21.0" + checksum: 10/dd3d333f85da79b0904f0ca33e66fc6b01984d161c3ac0e8373df865dabb73f4a7fe5bb7425475aa041082d364c657a756b246d85de4735557902be408e079d4 + languageName: node + linkType: hard + +"@shikijs/types@npm:3.21.0, @shikijs/types@npm:^3.21.0": + version: 3.21.0 + resolution: "@shikijs/types@npm:3.21.0" + dependencies: + "@shikijs/vscode-textmate": "npm:^10.0.2" + "@types/hast": "npm:^3.0.4" + checksum: 10/814dfbbaae55b9d1d86874ed870e80da0cba521a96fb799c73c8439f88b2218fb9e84f64485a50258508d0f912bdd19d0fb8494c2717a9eed2a809e243a81a49 + languageName: node + linkType: hard + +"@shikijs/vscode-textmate@npm:^10.0.2": + version: 10.0.2 + resolution: "@shikijs/vscode-textmate@npm:10.0.2" + checksum: 10/d924cba8a01cd9ca12f56ba097d628fdb81455abb85884c8d8a5ae85b628a37dd5907e7691019b97107bd6608c866adf91ba04a1c3bba391281c88e386c044ea + languageName: node + linkType: hard + "@sideway/address@npm:^4.1.5": version: 4.1.5 resolution: "@sideway/address@npm:4.1.5" @@ -4144,7 +4202,7 @@ __metadata: languageName: node linkType: hard -"@types/hast@npm:^3.0.0": +"@types/hast@npm:^3.0.0, @types/hast@npm:^3.0.4": version: 3.0.4 resolution: "@types/hast@npm:3.0.4" dependencies: @@ -5154,6 +5212,15 @@ __metadata: languageName: node linkType: hard +"brace-expansion@npm:^2.0.1": + version: 2.0.2 + resolution: "brace-expansion@npm:2.0.2" + dependencies: + balanced-match: "npm:^1.0.0" + checksum: 10/01dff195e3646bc4b0d27b63d9bab84d2ebc06121ff5013ad6e5356daa5a9d6b60fa26cf73c74797f2dc3fbec112af13578d51f75228c1112b26c790a87b0488 + languageName: node + linkType: hard + "braces@npm:^3.0.3, braces@npm:~3.0.2": version: 3.0.3 resolution: "braces@npm:3.0.3" @@ -6331,13 +6398,27 @@ __metadata: "@swmansion/t-rex-ui": "npm:^1.2.1" clsx: "npm:^2.1.0" copy-text-to-clipboard: "npm:^3.2.2" + docusaurus-plugin-typedoc: "npm:^1.4.2" prism-react-renderer: "npm:^2.1.0" react: "npm:^19.2.3" react-dom: "npm:^19.2.3" swiper: "npm:^11.2.10" + typedoc: "npm:^0.28.16" + typedoc-plugin-markdown: "npm:^4.9.0" languageName: unknown linkType: soft +"docusaurus-plugin-typedoc@npm:^1.4.2": + version: 1.4.2 + resolution: "docusaurus-plugin-typedoc@npm:1.4.2" + dependencies: + typedoc-docusaurus-theme: "npm:^1.4.0" + peerDependencies: + typedoc-plugin-markdown: ">=4.8.0" + checksum: 10/1d66505021efca3546c3457619932b2ad4d754a96103f3b2685c1772cf6a54311a83f686979c0bfde68f79a0f7960bad331f6315065e42b62373b5539319477a + languageName: node + linkType: hard + "dom-converter@npm:^0.2.0": version: 0.2.0 resolution: "dom-converter@npm:0.2.0" @@ -8652,6 +8733,15 @@ __metadata: languageName: node linkType: hard +"linkify-it@npm:^5.0.0": + version: 5.0.0 + resolution: "linkify-it@npm:5.0.0" + dependencies: + uc.micro: "npm:^2.0.0" + checksum: 10/ef3b7609dda6ec0c0be8a7b879cea195f0d36387b0011660cd6711bba0ad82137f59b458b7e703ec74f11d88e7c1328e2ad9b855a8500c0ded67461a8c4519e6 + languageName: node + linkType: hard + "loader-runner@npm:^4.3.1": version: 4.3.1 resolution: "loader-runner@npm:4.3.1" @@ -8757,6 +8847,13 @@ __metadata: languageName: node linkType: hard +"lunr@npm:^2.3.9": + version: 2.3.9 + resolution: "lunr@npm:2.3.9" + checksum: 10/f2f6db34c046f5a767782fe2454e6dd69c75ba3c5cf5c1cb9cacca2313a99c2ba78ff8fa67dac866fb7c4ffd5f22e06684793f5f15ba14bddb598b94513d54bf + languageName: node + linkType: hard + "make-fetch-happen@npm:^15.0.0": version: 15.0.3 resolution: "make-fetch-happen@npm:15.0.3" @@ -8783,6 +8880,22 @@ __metadata: languageName: node linkType: hard +"markdown-it@npm:^14.1.0": + version: 14.1.0 + resolution: "markdown-it@npm:14.1.0" + dependencies: + argparse: "npm:^2.0.1" + entities: "npm:^4.4.0" + linkify-it: "npm:^5.0.0" + mdurl: "npm:^2.0.0" + punycode.js: "npm:^2.3.1" + uc.micro: "npm:^2.1.0" + bin: + markdown-it: bin/markdown-it.mjs + checksum: 10/f34f921be178ed0607ba9e3e27c733642be445e9bb6b1dba88da7aafe8ba1bc5d2f1c3aa8f3fc33b49a902da4e4c08c2feadfafb290b8c7dda766208bb6483a9 + languageName: node + linkType: hard + "markdown-table@npm:^2.0.0": version: 2.0.0 resolution: "markdown-table@npm:2.0.0" @@ -9074,6 +9187,13 @@ __metadata: languageName: node linkType: hard +"mdurl@npm:^2.0.0": + version: 2.0.0 + resolution: "mdurl@npm:2.0.0" + checksum: 10/1720349d4a53e401aa993241368e35c0ad13d816ad0b28388928c58ca9faa0cf755fa45f18ccbf64f4ce54a845a50ddce5c84e4016897b513096a68dac4b0158 + languageName: node + linkType: hard + "media-typer@npm:0.3.0": version: 0.3.0 resolution: "media-typer@npm:0.3.0" @@ -9756,6 +9876,15 @@ __metadata: languageName: node linkType: hard +"minimatch@npm:^9.0.5": + version: 9.0.5 + resolution: "minimatch@npm:9.0.5" + dependencies: + brace-expansion: "npm:^2.0.1" + checksum: 10/dd6a8927b063aca6d910b119e1f2df6d2ce7d36eab91de83167dd136bb85e1ebff97b0d3de1cb08bd1f7e018ca170b4962479fefab5b2a69e2ae12cb2edc8348 + languageName: node + linkType: hard + "minimist@npm:^1.2.0": version: 1.2.8 resolution: "minimist@npm:1.2.8" @@ -11347,6 +11476,13 @@ __metadata: languageName: node linkType: hard +"punycode.js@npm:^2.3.1": + version: 2.3.1 + resolution: "punycode.js@npm:2.3.1" + checksum: 10/f0e946d1edf063f9e3d30a32ca86d8ff90ed13ca40dad9c75d37510a04473340cfc98db23a905cc1e517b1e9deb0f6021dce6f422ace235c60d3c9ac47c5a16a + languageName: node + linkType: hard + "punycode@npm:^2.1.0": version: 2.3.1 resolution: "punycode@npm:2.3.1" @@ -13054,6 +13190,48 @@ __metadata: languageName: node linkType: hard +"typedoc-docusaurus-theme@npm:^1.4.0": + version: 1.4.2 + resolution: "typedoc-docusaurus-theme@npm:1.4.2" + peerDependencies: + typedoc-plugin-markdown: ">=4.8.0" + checksum: 10/238186fbb4508f60cef1a3c44e4895f2a3ad198152959cf57c7efb52e7dffee32b76b5b56c1c148f1f615832ec6b6d71d236d3768bb3ef7066601b8b43daf424 + languageName: node + linkType: hard + +"typedoc-plugin-markdown@npm:^4.9.0": + version: 4.9.0 + resolution: "typedoc-plugin-markdown@npm:4.9.0" + peerDependencies: + typedoc: 0.28.x + checksum: 10/69293e9cd1a5cecd9d2f92872472dbc48b3912c658d0a2d07b6d7bd96bd1efa9617e9bea6a4e6181482610733533b1b058dc1fc505cac7931875f081f0023a0c + languageName: node + linkType: hard + +"typedoc@npm:^0.28.16": + version: 0.28.16 + resolution: "typedoc@npm:0.28.16" + dependencies: + "@gerrit0/mini-shiki": "npm:^3.17.0" + lunr: "npm:^2.3.9" + markdown-it: "npm:^14.1.0" + minimatch: "npm:^9.0.5" + yaml: "npm:^2.8.1" + peerDependencies: + typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x + bin: + typedoc: bin/typedoc + checksum: 10/657afd087d88a14cf77ad941de8913041a6a025e87c78833a5ee58a52b8252b685730394ab7920781b0b2faa0507b1c9d87fcf82dd86d1b788420716fc17ded3 + languageName: node + linkType: hard + +"uc.micro@npm:^2.0.0, uc.micro@npm:^2.1.0": + version: 2.1.0 + resolution: "uc.micro@npm:2.1.0" + checksum: 10/37197358242eb9afe367502d4638ac8c5838b78792ab218eafe48287b0ed28aaca268ec0392cc5729f6c90266744de32c06ae938549aee041fc93b0f9672d6b2 + languageName: node + linkType: hard + "undici-types@npm:~7.16.0": version: 7.16.0 resolution: "undici-types@npm:7.16.0" @@ -13737,6 +13915,15 @@ __metadata: languageName: node linkType: hard +"yaml@npm:^2.8.1": + version: 2.8.2 + resolution: "yaml@npm:2.8.2" + bin: + yaml: bin.mjs + checksum: 10/4eab0074da6bc5a5bffd25b9b359cf7061b771b95d1b3b571852098380db3b1b8f96e0f1f354b56cc7216aa97cea25163377ccbc33a2e9ce00316fe8d02f4539 + languageName: node + linkType: hard + "yocto-queue@npm:^1.0.0": version: 1.2.2 resolution: "yocto-queue@npm:1.2.2" From 98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Fri, 23 Jan 2026 18:47:57 +0100 Subject: [PATCH 06/15] Enhance VAD and part of TTS documentation --- .../useTextEmbeddings.ts | 4 +- .../useTextToSpeech.ts | 7 +++ .../useTokenizer.ts | 1 + .../natural_language_processing/useVAD.ts | 15 ++--- .../src/hooks/useModule.ts | 7 --- .../src/types/textEmbeddings.ts | 2 +- .../react-native-executorch/src/types/vad.ts | 60 +++++++++++++++++++ 7 files changed, 79 insertions(+), 17 deletions(-) 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 6b1b86d91..338c63192 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,6 +1,6 @@ import { TextEmbeddingsModule } from '../../modules/natural_language_processing/TextEmbeddingsModule'; import { useModule } from '../useModule'; -import { TextEmbeddingsType, Props } from '../../types/textEmbeddings'; +import { TextEmbeddingsType, TextEmbeddingsProps } from '../../types/textEmbeddings'; /** * React hook for managing a Text Embeddings model instance. @@ -8,7 +8,7 @@ import { TextEmbeddingsType, Props } from '../../types/textEmbeddings'; * @param TextEmbeddingsConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use Text Embeddings model. */ -export const useTextEmbeddings = ({ model, preventLoad = false }: Props): TextEmbeddingsType => +export const useTextEmbeddings = ({ model, preventLoad = false }: TextEmbeddingsProps): TextEmbeddingsType => useModule({ module: TextEmbeddingsModule, model, diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts index 2161f9682..72d98acb7 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts @@ -12,6 +12,13 @@ interface Props extends TextToSpeechConfig { preventLoad?: boolean; } + +/** + * React hook for managing Text to Speech instance. + * + * @param TextToSpeechConfiguration - Configuration object containing `model` source, `voice` and optional `preventLoad`. + * @returns Ready to use Text to Speech model. + */ export const useTextToSpeech = ({ model, voice, diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts index 6b7ba2d23..6899a27ae 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts @@ -6,6 +6,7 @@ import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; import { TokenizerType } from '../../types/tokenizer'; /** + * React hook for managing a Tokenizer instance. * * @param tokenizerConfiguration - Configuration object containing `tokenizer` source and optional `preventLoad` flag. * @returns Ready to use Tokenizer model. 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 2e3cb4235..1350330eb 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,13 +1,14 @@ -import { ResourceSource } from '../../types/common'; import { useModule } from '../useModule'; import { VADModule } from '../../modules/natural_language_processing/VADModule'; +import { VADType, VADProps } from '../../types/vad'; -interface Props { - model: { modelSource: ResourceSource }; - preventLoad?: boolean; -} - -export const useVAD = ({ model, preventLoad = false }: Props) => +/** + * React hook for managing a VAD model instance. + * + * @param VADConfiguration - 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, diff --git a/packages/react-native-executorch/src/hooks/useModule.ts b/packages/react-native-executorch/src/hooks/useModule.ts index e62f861f6..39b10249b 100644 --- a/packages/react-native-executorch/src/hooks/useModule.ts +++ b/packages/react-native-executorch/src/hooks/useModule.ts @@ -93,13 +93,6 @@ export const useModule = < * Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. */ downloadProgress, - - /** - * This function runs the model's forward method with the provided input arguments. - * - * @param input - Input arguments for the model's forward method. - * @returns The output from the model's forward method. - */ forward, }; }; diff --git a/packages/react-native-executorch/src/types/textEmbeddings.ts b/packages/react-native-executorch/src/types/textEmbeddings.ts index 8471b9604..94077bc42 100644 --- a/packages/react-native-executorch/src/types/textEmbeddings.ts +++ b/packages/react-native-executorch/src/types/textEmbeddings.ts @@ -36,7 +36,7 @@ export interface TextEmbeddingsType { /** * Props for the useTextEmbeddings hook. */ -export interface Props { +export interface TextEmbeddingsProps { model: { /** * `ResourceSource` that specifies the location of the model binary. diff --git a/packages/react-native-executorch/src/types/vad.ts b/packages/react-native-executorch/src/types/vad.ts index ca0dff920..ade7b1287 100644 --- a/packages/react-native-executorch/src/types/vad.ts +++ b/packages/react-native-executorch/src/types/vad.ts @@ -1,4 +1,64 @@ +import { ResourceSource } from '../types/common'; +import { RnExecutorchError } from '../errors/errorUtils'; + +/** + * Props for the useVAD hook. + */ +export interface VADProps { + /** + * `ResourceSource` that specifies the location of the VAD model binary. + */ + model: { modelSource: ResourceSource }; + + /** + * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. + */ + preventLoad?: boolean; +} + +/** + * Represents a detected audio segment with start and end timestamps. + */ export interface Segment { + /** + * Start time of the segment in seconds. + */ start: number; + + /** + * End time of the segment in seconds. + */ end: number; } + +/** + * React hook state and methods for managing a Voice Activity Detection (VAD) model instance. + */ +export interface VADType { + /** + * Contains the error message if the VAD model failed to load or during processing. + */ + error: null | RnExecutorchError; + + /** + * Indicates whether the VAD model has successfully loaded and is ready for inference. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently processing an inference. + */ + isGenerating: boolean; + + /** + * Represents the download progress as a value between 0 and 1. + */ + downloadProgress: number; + + /** + * Runs the Voice Activity Detection model on the provided audio waveform. + * @param waveform - The input audio waveform array. + * @returns A promise resolving to an array of detected audio segments (e.g., timestamps for speech). + */ + forward(waveform: Float32Array): Promise; +} From ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Sat, 24 Jan 2026 13:46:05 +0100 Subject: [PATCH 07/15] Fix docusaurus.config.js --- .../classes/ClassificationModule.md | 14 +-- .../classes/ExecutorchModule.md | 14 +-- .../classes/ImageEmbeddingsModule.md | 14 +-- .../classes/ImageSegmentationModule.md | 14 +-- .../06-api-reference/classes/LLMModule.md | 24 +++--- .../06-api-reference/classes/OCRModule.md | 10 +-- .../classes/ObjectDetectionModule.md | 14 +-- .../classes/ResourceFetcher.md | 20 ++--- .../classes/RnExecutorchError.md | 8 +- .../classes/SpeechToTextModule.md | 18 ++-- .../classes/StyleTransferModule.md | 14 +-- .../classes/TextEmbeddingsModule.md | 14 +-- .../classes/TextToImageModule.md | 18 ++-- .../classes/TokenizerModule.md | 16 ++-- .../06-api-reference/classes/VADModule.md | 14 +-- .../classes/VerticalOCRModule.md | 10 +-- .../enumerations/DeeplabLabel.md | 46 +++++----- .../enumerations/RnExecutorchErrorCode.md | 86 +++++++++---------- .../enumerations/ScalarType.md | 46 +++++----- .../DEFAULT_STRUCTURED_OUTPUT_PROMPT.md | 2 +- .../fixAndValidateStructuredOutput.md | 2 +- .../functions/getStructuredOutputPrompt.md | 2 +- .../functions/useClassification.md | 8 +- .../functions/useExecutorchModule.md | 8 +- .../functions/useImageEmbeddings.md | 8 +- .../functions/useImageSegmentation.md | 8 +- .../docs/06-api-reference/functions/useLLM.md | 2 +- .../docs/06-api-reference/functions/useOCR.md | 2 +- .../functions/useObjectDetection.md | 8 +- .../functions/useSpeechToText.md | 2 +- .../functions/useStyleTransfer.md | 8 +- .../functions/useTextEmbeddings.md | 4 +- .../functions/useTextToImage.md | 2 +- .../functions/useTextToSpeech.md | 20 ++++- .../functions/useTokenizer.md | 4 +- .../docs/06-api-reference/functions/useVAD.md | 56 +++--------- .../functions/useVerticalOCR.md | 2 +- docs/docs/06-api-reference/index.md | 8 +- docs/docs/06-api-reference/interfaces/Bbox.md | 10 +-- .../06-api-reference/interfaces/ChatConfig.md | 8 +- .../interfaces/DecodingOptions.md | 4 +- .../06-api-reference/interfaces/Detection.md | 8 +- .../interfaces/GenerationConfig.md | 10 +-- .../interfaces/KokoroConfig.md | 28 ++---- .../interfaces/KokoroOptions.md | 17 ---- .../interfaces/KokoroVoiceExtras.md | 6 +- .../06-api-reference/interfaces/LLMType.md | 28 +++--- .../06-api-reference/interfaces/Message.md | 6 +- .../06-api-reference/interfaces/OCRBbox.md | 6 +- .../interfaces/OCRDetection.md | 8 +- .../docs/06-api-reference/interfaces/Props.md | 35 -------- .../06-api-reference/interfaces/Segment.md | 12 ++- .../interfaces/SpeechToTextModelConfig.md | 10 +-- .../interfaces/SpeechToTextType.md | 26 +++--- .../06-api-reference/interfaces/TensorPtr.md | 8 +- .../interfaces/TextEmbeddingsProps.md | 35 ++++++++ .../interfaces/TextEmbeddingsType.md | 12 +-- .../interfaces/TextToSpeechConfig.md | 16 +--- .../interfaces/TextToSpeechInput.md | 6 +- .../interfaces/TextToSpeechStreamingInput.md | 12 +-- .../interfaces/TokenizerType.md | 20 ++--- .../06-api-reference/interfaces/ToolCall.md | 6 +- .../interfaces/ToolsConfig.md | 8 +- .../06-api-reference/interfaces/VADProps.md | 29 +++++++ .../06-api-reference/interfaces/VADType.md | 69 +++++++++++++++ .../interfaces/VoiceConfig.md | 8 +- .../06-api-reference/type-aliases/LLMTool.md | 2 +- .../type-aliases/MessageRole.md | 2 +- .../type-aliases/OCRLanguage.md | 2 +- .../type-aliases/ResourceSource.md | 2 +- .../type-aliases/SpeechToTextLanguage.md | 2 +- .../type-aliases/TensorBuffer.md | 2 +- .../type-aliases/TextToSpeechLanguage.md | 2 +- .../docs/06-api-reference/typedoc-sidebar.cjs | 2 +- .../variables/ALL_MINILM_L6_V2.md | 2 +- .../variables/ALL_MPNET_BASE_V2.md | 2 +- .../variables/BK_SDM_TINY_VPRED_256.md | 2 +- .../variables/BK_SDM_TINY_VPRED_512.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 2 +- .../variables/DEEPLAB_V3_RESNET50.md | 2 +- .../variables/DEFAULT_CHAT_CONFIG.md | 2 +- .../DEFAULT_CONTEXT_WINDOW_LENGTH.md | 2 +- .../variables/DEFAULT_MESSAGE_HISTORY.md | 2 +- .../variables/DEFAULT_SYSTEM_PROMPT.md | 2 +- .../variables/EFFICIENTNET_V2_S.md | 2 +- .../06-api-reference/variables/FSMN_VAD.md | 2 +- .../variables/HAMMER2_1_0_5B.md | 2 +- .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_1_5B.md | 2 +- .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_3B.md | 2 +- .../variables/HAMMER2_1_3B_QUANTIZED.md | 2 +- .../06-api-reference/variables/KOKORO_EN.md | 27 ------ .../variables/KOKORO_MEDIUM.md | 21 +++++ .../variables/KOKORO_SMALL.md | 23 +++++ .../variables/KOKORO_VOICE_AF_HEART.md | 2 +- .../variables/KOKORO_VOICE_AF_RIVER.md | 2 +- .../variables/KOKORO_VOICE_AF_SARAH.md | 2 +- .../variables/KOKORO_VOICE_AM_ADAM.md | 2 +- .../variables/KOKORO_VOICE_AM_MICHAEL.md | 2 +- .../variables/KOKORO_VOICE_AM_SANTA.md | 2 +- .../variables/KOKORO_VOICE_BF_EMMA.md | 2 +- .../variables/KOKORO_VOICE_BM_DANIEL.md | 2 +- .../06-api-reference/variables/LLAMA3_2_1B.md | 2 +- .../variables/LLAMA3_2_1B_QLORA.md | 2 +- .../variables/LLAMA3_2_1B_SPINQUANT.md | 2 +- .../06-api-reference/variables/LLAMA3_2_3B.md | 2 +- .../variables/LLAMA3_2_3B_QLORA.md | 2 +- .../variables/LLAMA3_2_3B_SPINQUANT.md | 2 +- .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 2 +- .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 2 +- .../06-api-reference/variables/OCR_ABAZA.md | 2 +- .../06-api-reference/variables/OCR_ADYGHE.md | 2 +- .../variables/OCR_AFRIKAANS.md | 2 +- .../variables/OCR_ALBANIAN.md | 2 +- .../06-api-reference/variables/OCR_AVAR.md | 2 +- .../variables/OCR_AZERBAIJANI.md | 2 +- .../variables/OCR_BELARUSIAN.md | 2 +- .../06-api-reference/variables/OCR_BOSNIAN.md | 2 +- .../variables/OCR_BULGARIAN.md | 2 +- .../06-api-reference/variables/OCR_CHECHEN.md | 2 +- .../variables/OCR_CROATIAN.md | 2 +- .../06-api-reference/variables/OCR_CZECH.md | 2 +- .../06-api-reference/variables/OCR_DANISH.md | 2 +- .../06-api-reference/variables/OCR_DARGWA.md | 2 +- .../06-api-reference/variables/OCR_DUTCH.md | 2 +- .../06-api-reference/variables/OCR_ENGLISH.md | 2 +- .../variables/OCR_ESTONIAN.md | 2 +- .../06-api-reference/variables/OCR_FRENCH.md | 2 +- .../06-api-reference/variables/OCR_GERMAN.md | 2 +- .../variables/OCR_HUNGARIAN.md | 2 +- .../variables/OCR_ICELANDIC.md | 2 +- .../variables/OCR_INDONESIAN.md | 2 +- .../06-api-reference/variables/OCR_INGUSH.md | 2 +- .../06-api-reference/variables/OCR_IRISH.md | 2 +- .../06-api-reference/variables/OCR_ITALIAN.md | 2 +- .../variables/OCR_JAPANESE.md | 2 +- .../06-api-reference/variables/OCR_KANNADA.md | 2 +- .../variables/OCR_KARBADIAN.md | 2 +- .../06-api-reference/variables/OCR_KOREAN.md | 2 +- .../06-api-reference/variables/OCR_KURDISH.md | 2 +- .../06-api-reference/variables/OCR_LAK.md | 2 +- .../06-api-reference/variables/OCR_LATIN.md | 2 +- .../06-api-reference/variables/OCR_LATVIAN.md | 2 +- .../variables/OCR_LEZGHIAN.md | 2 +- .../variables/OCR_LITHUANIAN.md | 2 +- .../06-api-reference/variables/OCR_MALAY.md | 2 +- .../06-api-reference/variables/OCR_MALTESE.md | 2 +- .../06-api-reference/variables/OCR_MAORI.md | 2 +- .../variables/OCR_MONGOLIAN.md | 2 +- .../variables/OCR_NORWEGIAN.md | 2 +- .../06-api-reference/variables/OCR_OCCITAN.md | 2 +- .../06-api-reference/variables/OCR_PALI.md | 2 +- .../06-api-reference/variables/OCR_POLISH.md | 2 +- .../variables/OCR_PORTUGUESE.md | 2 +- .../variables/OCR_ROMANIAN.md | 2 +- .../06-api-reference/variables/OCR_RUSSIAN.md | 2 +- .../variables/OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/OCR_SERBIAN_LATIN.md | 2 +- .../variables/OCR_SIMPLIFIED_CHINESE.md | 2 +- .../06-api-reference/variables/OCR_SLOVAK.md | 2 +- .../variables/OCR_SLOVENIAN.md | 2 +- .../06-api-reference/variables/OCR_SPANISH.md | 2 +- .../06-api-reference/variables/OCR_SWAHILI.md | 2 +- .../06-api-reference/variables/OCR_SWEDISH.md | 2 +- .../variables/OCR_TABASSARAN.md | 2 +- .../06-api-reference/variables/OCR_TAGALOG.md | 2 +- .../06-api-reference/variables/OCR_TAJIK.md | 2 +- .../06-api-reference/variables/OCR_TELUGU.md | 2 +- .../06-api-reference/variables/OCR_TURKISH.md | 2 +- .../variables/OCR_UKRAINIAN.md | 2 +- .../06-api-reference/variables/OCR_UZBEK.md | 2 +- .../variables/OCR_VIETNAMESE.md | 2 +- .../06-api-reference/variables/OCR_WELSH.md | 2 +- .../variables/PHI_4_MINI_4B.md | 2 +- .../variables/PHI_4_MINI_4B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_0_5B.md | 2 +- .../variables/QWEN2_5_0_5B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_1_5B.md | 2 +- .../variables/QWEN2_5_1_5B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN2_5_3B.md | 2 +- .../variables/QWEN2_5_3B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_0_6B.md | 2 +- .../variables/QWEN3_0_6B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_1_7B.md | 2 +- .../variables/QWEN3_1_7B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_4B.md | 2 +- .../variables/QWEN3_4B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_135M.md | 2 +- .../variables/SMOLLM2_1_135M_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_1_7B.md | 2 +- .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_360M.md | 2 +- .../variables/SMOLLM2_1_360M_QUANTIZED.md | 2 +- .../variables/SPECIAL_TOKENS.md | 2 +- .../SSDLITE_320_MOBILENET_V3_LARGE.md | 2 +- .../variables/STYLE_TRANSFER_CANDY.md | 2 +- .../variables/STYLE_TRANSFER_MOSAIC.md | 2 +- .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 2 +- .../variables/STYLE_TRANSFER_UDNIE.md | 2 +- .../variables/VERTICAL_OCR_ABAZA.md | 2 +- .../variables/VERTICAL_OCR_ADYGHE.md | 2 +- .../variables/VERTICAL_OCR_AFRIKAANS.md | 2 +- .../variables/VERTICAL_OCR_ALBANIAN.md | 2 +- .../variables/VERTICAL_OCR_AVAR.md | 2 +- .../variables/VERTICAL_OCR_AZERBAIJANI.md | 2 +- .../variables/VERTICAL_OCR_BELARUSIAN.md | 2 +- .../variables/VERTICAL_OCR_BOSNIAN.md | 2 +- .../variables/VERTICAL_OCR_BULGARIAN.md | 2 +- .../variables/VERTICAL_OCR_CHECHEN.md | 2 +- .../variables/VERTICAL_OCR_CROATIAN.md | 2 +- .../variables/VERTICAL_OCR_CZECH.md | 2 +- .../variables/VERTICAL_OCR_DANISH.md | 2 +- .../variables/VERTICAL_OCR_DARGWA.md | 2 +- .../variables/VERTICAL_OCR_DUTCH.md | 2 +- .../variables/VERTICAL_OCR_ENGLISH.md | 2 +- .../variables/VERTICAL_OCR_ESTONIAN.md | 2 +- .../variables/VERTICAL_OCR_FRENCH.md | 2 +- .../variables/VERTICAL_OCR_GERMAN.md | 2 +- .../variables/VERTICAL_OCR_HUNGARIAN.md | 2 +- .../variables/VERTICAL_OCR_ICELANDIC.md | 2 +- .../variables/VERTICAL_OCR_INDONESIAN.md | 2 +- .../variables/VERTICAL_OCR_INGUSH.md | 2 +- .../variables/VERTICAL_OCR_IRISH.md | 2 +- .../variables/VERTICAL_OCR_ITALIAN.md | 2 +- .../variables/VERTICAL_OCR_JAPANESE.md | 2 +- .../variables/VERTICAL_OCR_KANNADA.md | 2 +- .../variables/VERTICAL_OCR_KARBADIAN.md | 2 +- .../variables/VERTICAL_OCR_KOREAN.md | 2 +- .../variables/VERTICAL_OCR_KURDISH.md | 2 +- .../variables/VERTICAL_OCR_LAK.md | 2 +- .../variables/VERTICAL_OCR_LATIN.md | 2 +- .../variables/VERTICAL_OCR_LATVIAN.md | 2 +- .../variables/VERTICAL_OCR_LEZGHIAN.md | 2 +- .../variables/VERTICAL_OCR_LITHUANIAN.md | 2 +- .../variables/VERTICAL_OCR_MALAY.md | 2 +- .../variables/VERTICAL_OCR_MALTESE.md | 2 +- .../variables/VERTICAL_OCR_MAORI.md | 2 +- .../variables/VERTICAL_OCR_MONGOLIAN.md | 2 +- .../variables/VERTICAL_OCR_NORWEGIAN.md | 2 +- .../variables/VERTICAL_OCR_OCCITAN.md | 2 +- .../variables/VERTICAL_OCR_PALI.md | 2 +- .../variables/VERTICAL_OCR_POLISH.md | 2 +- .../variables/VERTICAL_OCR_PORTUGUESE.md | 2 +- .../variables/VERTICAL_OCR_ROMANIAN.md | 2 +- .../variables/VERTICAL_OCR_RUSSIAN.md | 2 +- .../VERTICAL_OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/VERTICAL_OCR_SERBIAN_LATIN.md | 2 +- .../VERTICAL_OCR_SIMPLIFIED_CHINESE.md | 2 +- .../variables/VERTICAL_OCR_SLOVAK.md | 2 +- .../variables/VERTICAL_OCR_SLOVENIAN.md | 2 +- .../variables/VERTICAL_OCR_SPANISH.md | 2 +- .../variables/VERTICAL_OCR_SWAHILI.md | 2 +- .../variables/VERTICAL_OCR_SWEDISH.md | 2 +- .../variables/VERTICAL_OCR_TABASSARAN.md | 2 +- .../variables/VERTICAL_OCR_TAGALOG.md | 2 +- .../variables/VERTICAL_OCR_TAJIK.md | 2 +- .../variables/VERTICAL_OCR_TELUGU.md | 2 +- .../variables/VERTICAL_OCR_TURKISH.md | 2 +- .../variables/VERTICAL_OCR_UKRAINIAN.md | 2 +- .../variables/VERTICAL_OCR_UZBEK.md | 2 +- .../variables/VERTICAL_OCR_VIETNAMESE.md | 2 +- .../variables/VERTICAL_OCR_WELSH.md | 2 +- .../variables/WHISPER_BASE.md | 2 +- .../variables/WHISPER_BASE_EN.md | 2 +- .../variables/WHISPER_SMALL.md | 2 +- .../variables/WHISPER_SMALL_EN.md | 2 +- .../variables/WHISPER_TINY.md | 2 +- .../variables/WHISPER_TINY_EN.md | 2 +- .../variables/WHISPER_TINY_EN_QUANTIZED.md | 2 +- .../variables/parseToolCall.md | 2 +- docs/docusaurus.config.js | 48 +++++------ docs/src/theme/SearchBar.tsx | 5 ++ 274 files changed, 789 insertions(+), 762 deletions(-) delete mode 100644 docs/docs/06-api-reference/interfaces/KokoroOptions.md delete mode 100644 docs/docs/06-api-reference/interfaces/Props.md create mode 100644 docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md create mode 100644 docs/docs/06-api-reference/interfaces/VADProps.md create mode 100644 docs/docs/06-api-reference/interfaces/VADType.md delete mode 100644 docs/docs/06-api-reference/variables/KOKORO_EN.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md create mode 100644 docs/docs/06-api-reference/variables/KOKORO_SMALL.md create mode 100644 docs/src/theme/SearchBar.tsx diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index 61bf46610..feccbf7e2 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,6 @@ # Class: ClassificationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Class > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Class > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index e7214a4bf..2ddada8ea 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -1,6 +1,6 @@ # Class: ExecutorchModule -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L26) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md index ba9e003d1..d3b778edf 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: ImageEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md index 9a1778e46..2b4057c67 100644 --- a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -1,6 +1,6 @@ # Class: ImageSegmentationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) #### Parameters @@ -80,7 +80,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -128,7 +128,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md index cac3cd483..bd1a27e00 100644 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -1,6 +1,6 @@ # Class: LLMModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L11) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L11) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **new LLMModule**(`__namedParameters`): `LLMModule` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **configure**(`__namedParameters`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L52) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L52) #### Parameters @@ -64,7 +64,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:92](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L92) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:92](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L92) #### Returns @@ -76,7 +76,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:79](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L79) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:79](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L79) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **forward**(`input`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L64) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L64) #### Parameters @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **generate**(`messages`, `tools?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L69) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L69) #### Parameters @@ -134,7 +134,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **getGeneratedTokenCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) #### Returns @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:84](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L84) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:84](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L84) #### Returns @@ -158,7 +158,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L30) #### Parameters @@ -190,7 +190,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) #### Parameters @@ -208,7 +208,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **setTokenCallback**(`__namedParameters`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L44) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L44) #### Parameters diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md index b120ced2c..93245a54e 100644 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -1,6 +1,6 @@ # Class: OCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **new OCRModule**(): `OCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index 582321721..f1ae40652 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -1,6 +1,6 @@ # Class: ObjectDetectionModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -124,7 +124,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md index b9c9b40fd..b92d48363 100644 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -1,6 +1,6 @@ # Class: ResourceFetcher -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](h > `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](h > `static` **cancelFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251]( > `static` **deleteResources**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278]( > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](h > `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290]( > `static` **listDownloadedFiles**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) #### Returns @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268]( > `static` **listDownloadedModels**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) #### Returns @@ -126,7 +126,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273]( > `static` **pauseFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) #### Parameters @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241]( > `static` **resumeFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) #### Parameters diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md index d525c968c..53bdd532b 100644 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -1,6 +1,6 @@ # Class: RnExecutorchError -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/errorUtils.ts#L3) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/errorUtils.ts#L3) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https: > **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/errorUtils.ts#L14) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/errorUtils.ts#L14) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https > `optional` **cause**: `unknown` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/errorUtils.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/errorUtils.ts#L12) The original cause of the error, if any. @@ -56,7 +56,7 @@ The original cause of the error, if any. > **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/errorUtils.ts#L7) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/errorUtils.ts#L7) The error code representing the type of error. diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md index 202038361..dd75cbe75 100644 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -1,6 +1,6 @@ # Class: SpeechToTextModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L7) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L74) Runs the decoder of the model. Passing number[] is deprecated. @@ -48,7 +48,7 @@ Decoded output. > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L51) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L51) #### Returns @@ -60,7 +60,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L55) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L55) #### Parameters @@ -78,7 +78,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L17) #### Parameters @@ -100,7 +100,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **stream**(`options`): `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:121](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L121) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:121](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L121) #### Parameters @@ -118,7 +118,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:176](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L176) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:176](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L176) #### Parameters @@ -136,7 +136,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:186](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L186) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:186](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L186) #### Returns @@ -148,7 +148,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **transcribe**(`waveform`, `options`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:102](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L102) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:102](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L102) Transcribes audio using the Whisper model. diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index d595a7bff..6191f9871 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,6 @@ # Class: StyleTransferModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index 0457a196e..4c501443c 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: TextEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L35) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L35) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index 8e58e0f64..ddcd7b83d 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -1,6 +1,6 @@ # Class: TextToImageModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) #### Parameters @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -62,7 +62,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) #### Parameters @@ -92,7 +92,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -140,7 +140,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) #### Returns @@ -152,7 +152,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md index c58a23835..662f7c7c4 100644 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -1,6 +1,6 @@ # Class: TokenizerModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L7) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L31) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L31) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **encode**(`s`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L27) #### Parameters @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L38) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L38) #### Returns @@ -78,7 +78,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **idToToken**(`tokenId`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L42) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L42) #### Parameters @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L9) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L46) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L46) #### Parameters diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index c426e473d..1a897437b 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -1,6 +1,6 @@ # Class: VADModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L26) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md index ff4f81fb6..f344b3c89 100644 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -1,6 +1,6 @@ # Class: VerticalOCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **new VerticalOCRModule**(): `VerticalOCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md index 4bb33004f..aa2e0b2f5 100644 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -1,6 +1,6 @@ # Enumeration: DeeplabLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L2) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L2) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2]( > **AEROPLANE**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L4) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L4) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4]( > **ARGMAX**: `21` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24] > **BACKGROUND**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L3) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L3) *** @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3]( > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) *** @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5]( > **BIRD**: `3` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) *** @@ -48,7 +48,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6]( > **BOAT**: `4` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) *** @@ -56,7 +56,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7]( > **BOTTLE**: `5` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) *** @@ -64,7 +64,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8]( > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) *** @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9]( > **CAR**: `7` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) *** @@ -80,7 +80,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10] > **CAT**: `8` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) *** @@ -88,7 +88,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11] > **CHAIR**: `9` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) *** @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12] > **COW**: `10` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) *** @@ -104,7 +104,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13] > **DININGTABLE**: `11` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) *** @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14] > **DOG**: `12` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) *** @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15] > **HORSE**: `13` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) *** @@ -128,7 +128,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16] > **MOTORBIKE**: `14` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) *** @@ -136,7 +136,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17] > **PERSON**: `15` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) *** @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18] > **POTTEDPLANT**: `16` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) *** @@ -152,7 +152,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19] > **SHEEP**: `17` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) *** @@ -160,7 +160,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20] > **SOFA**: `18` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) *** @@ -168,7 +168,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21] > **TRAIN**: `19` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) *** @@ -176,4 +176,4 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22] > **TVMONITOR**: `20` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md index af468b85d..0dccaaa39 100644 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -1,6 +1,6 @@ # Enumeration: RnExecutorchErrorCode -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https: > **AccessFailed**: `34` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](http > **DelegateInvalidCompatibility**: `48` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](http > **DelegateInvalidHandle**: `50` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) *** @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](http > **DelegateMemoryAllocationFailed**: `49` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) *** @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](http > **DownloadInterrupted**: `118` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) Thrown when the number of downloaded files is unexpected, due to download interruptions. @@ -50,7 +50,7 @@ Thrown when the number of downloaded files is unexpected, due to download interr > **EndOfMethod**: `3` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](http > **FileReadFailed**: `114` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. @@ -68,7 +68,7 @@ Thrown when a file read operation failed. This could be invalid image url passed > **FileWriteFailed**: `103` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) An error ocurred when saving a file. This could be, for instance a result image from an image model. @@ -78,7 +78,7 @@ An error ocurred when saving a file. This could be, for instance a result image > **Internal**: `1` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) *** @@ -86,7 +86,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](http > **InvalidArgument**: `18` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) *** @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](http > **InvalidConfig**: `112` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. @@ -104,7 +104,7 @@ Thrown when config parameters passed to a model are invalid. For example, when L > **InvalidExternalData**: `36` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) *** @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](http > **InvalidModelOutput**: `115` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) Thrown when the size of model output is unexpected. @@ -122,7 +122,7 @@ Thrown when the size of model output is unexpected. > **InvalidModelSource**: `255` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) Thrown when the type of model source passed by the user is invalid. @@ -132,7 +132,7 @@ Thrown when the type of model source passed by the user is invalid. > **InvalidProgram**: `35` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) *** @@ -140,7 +140,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](http > **InvalidState**: `2` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) *** @@ -148,7 +148,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](http > **InvalidType**: `19` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) *** @@ -156,7 +156,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](http > **InvalidUserInput**: `117` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). @@ -166,7 +166,7 @@ Thrown when the input passed to our APIs is invalid, for example when passing an > **LanguageNotSupported**: `105` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. @@ -176,7 +176,7 @@ Thrown when a language is passed to a multi-language model that is not supported > **MemoryAllocationFailed**: `33` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) *** @@ -184,7 +184,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](http > **MissingDataChunk**: `161` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) Thrown when streaming transcription is attempted but audio data chunk is missing. @@ -194,7 +194,7 @@ Thrown when streaming transcription is attempted but audio data chunk is missing > **ModelGenerating**: `104` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. @@ -204,7 +204,7 @@ Thrown when a user tries to run a model that is currently processing. It is only > **ModuleNotLoaded**: `102` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. @@ -214,7 +214,7 @@ Thrown when a user tries to run a model that is not yet downloaded or loaded int > **MultilingualConfiguration**: `160` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. @@ -224,7 +224,7 @@ Thrown when there's a configuration mismatch between multilingual and language s > **NotFound**: `32` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) *** @@ -232,7 +232,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](http > **NotImplemented**: `17` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) *** @@ -240,7 +240,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](http > **NotSupported**: `16` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) *** @@ -248,7 +248,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](http > **Ok**: `0` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) *** @@ -256,7 +256,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](http > **OperatorMissing**: `20` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) *** @@ -264,7 +264,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](http > **OutOfResources**: `37` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) *** @@ -272,7 +272,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](http > **ResourceFetcherAlreadyOngoing**: `183` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) Thrown when trying to resume a download that is already ongoing. @@ -282,7 +282,7 @@ Thrown when trying to resume a download that is already ongoing. > **ResourceFetcherAlreadyPaused**: `182` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) Thrown when trying to pause a download that is already paused. @@ -292,7 +292,7 @@ Thrown when trying to pause a download that is already paused. > **ResourceFetcherDownloadFailed**: `180` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. @@ -302,7 +302,7 @@ Thrown when a resource fails to download. This could be due to invalid URL, or f > **ResourceFetcherDownloadInProgress**: `181` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) Thrown when a user tries to trigger a download that's already in progress. @@ -312,7 +312,7 @@ Thrown when a user tries to trigger a download that's already in progress. > **ResourceFetcherMissingUri**: `185` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) Thrown when required URI information is missing for a download operation. @@ -322,7 +322,7 @@ Thrown when required URI information is missing for a download operation. > **ResourceFetcherNotActive**: `184` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) Thrown when trying to pause, resume, or cancel a download that is not active. @@ -332,7 +332,7 @@ Thrown when trying to pause, resume, or cancel a download that is not active. > **StreamingInProgress**: `163` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) Thrown when trying to start a new streaming session while another is already in progress. @@ -342,7 +342,7 @@ Thrown when trying to start a new streaming session while another is already in > **StreamingNotStarted**: `162` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) Thrown when trying to stop or insert data into a stream that hasn't been started. @@ -352,7 +352,7 @@ Thrown when trying to stop or insert data into a stream that hasn't been started > **ThreadPoolError**: `113` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) Thrown when React Native ExecuTorch threadpool problem occurs. @@ -362,7 +362,7 @@ Thrown when React Native ExecuTorch threadpool problem occurs. > **UnexpectedNumInputs**: `97` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) Thrown when the number of passed inputs to the model is different than the model metadata specifies. @@ -372,7 +372,7 @@ Thrown when the number of passed inputs to the model is different than the model > **UnknownError**: `101` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. @@ -382,6 +382,6 @@ An umbrella-error that is thrown usually when something unexpected happens, for > **WrongDimensions**: `116` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md index b6756109d..871259b31 100644 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -1,6 +1,6 @@ # Enumeration: ScalarType -Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L13) +Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L13) Enum representing the scalar types of tensors. @@ -10,7 +10,7 @@ Enum representing the scalar types of tensors. > **BITS16**: `22` -Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L28) +Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L28) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://gi > **BOOL**: `11` -Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L22) +Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L22) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://gi > **BYTE**: `0` -Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L14) +Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L14) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://gi > **CHAR**: `1` -Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L15) +Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L15) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://gi > **DOUBLE**: `7` -Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L21) +Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L21) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://gi > **FLOAT**: `6` -Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L20) +Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L20) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://gi > **FLOAT8E4M3FN**: `24` -Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L30) +Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L30) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://gi > **FLOAT8E4M3FNUZ**: `26` -Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L32) +Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L32) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://gi > **FLOAT8E5M2**: `23` -Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L29) +Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L29) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://gi > **FLOAT8E5M2FNUZ**: `25` -Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L31) +Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L31) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://gi > **HALF**: `5` -Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L19) +Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L19) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://gi > **INT**: `3` -Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L17) +Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L17) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://gi > **LONG**: `4` -Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L18) +Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L18) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://gi > **QINT32**: `14` -Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L25) +Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L25) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://gi > **QINT8**: `12` -Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L23) +Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L23) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://gi > **QUINT2X4**: `17` -Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L27) +Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L27) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://gi > **QUINT4X2**: `16` -Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L26) +Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L26) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://gi > **QUINT8**: `13` -Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L24) +Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L24) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://gi > **SHORT**: `2` -Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L16) +Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L16) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://gi > **UINT16**: `27` -Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L33) +Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L33) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://gi > **UINT32**: `28` -Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L34) +Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L34) *** @@ -178,4 +178,4 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://gi > **UINT64**: `29` -Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L35) +Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L35) diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md index ccbef5de1..7485a1c0c 100644 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -2,7 +2,7 @@ > **DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT**(`structuredOutputSchema`): `string` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) ## Parameters diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md index abc762c48..690ac3cb7 100644 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -2,7 +2,7 @@ > **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> -Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/llm.ts#L81) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/llm.ts#L81) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md index 2a2ff4903..a5cce7167 100644 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -2,7 +2,7 @@ > **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` -Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/llm.ts#L50) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/llm.ts#L50) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md index 92efdf984..adbaf551c 100644 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -2,7 +2,7 @@ > **useClassification**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L10) ## Parameters @@ -28,22 +28,16 @@ Contains the error message if the model failed to load. > **forward**: (...`input`) => `Promise`\<`any`\> -This function runs the model's forward method with the provided input arguments. - #### Parameters ##### input ...\[`string`\] -Input arguments for the model's forward method. - #### Returns `Promise`\<`any`\> -The output from the model's forward method. - ### isGenerating > **isGenerating**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md index 4e117fee4..80d48036d 100644 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -2,7 +2,7 @@ > **useExecutorchModule**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L10) ## Parameters @@ -28,22 +28,16 @@ Contains the error message if the model failed to load. > **forward**: (...`input`) => `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -This function runs the model's forward method with the provided input arguments. - #### Parameters ##### input ...\[[`TensorPtr`](../interfaces/TensorPtr.md)[]\] -Input arguments for the model's forward method. - #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -The output from the model's forward method. - ### isGenerating > **isGenerating**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md index 4b604041b..229e5cf71 100644 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -2,7 +2,7 @@ > **useImageEmbeddings**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L10) ## Parameters @@ -28,22 +28,16 @@ Contains the error message if the model failed to load. > **forward**: (...`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -This function runs the model's forward method with the provided input arguments. - #### Parameters ##### input ...\[`string`\] -Input arguments for the model's forward method. - #### Returns `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -The output from the model's forward method. - ### isGenerating > **isGenerating**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md index 6e5b227d3..98408b2ea 100644 --- a/docs/docs/06-api-reference/functions/useImageSegmentation.md +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -2,7 +2,7 @@ > **useImageSegmentation**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L10) ## Parameters @@ -28,22 +28,16 @@ Contains the error message if the model failed to load. > **forward**: (...`input`) => `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> -This function runs the model's forward method with the provided input arguments. - #### Parameters ##### input ...\[`string`, [`DeeplabLabel`](../enumerations/DeeplabLabel.md)[], `boolean`\] -Input arguments for the model's forward method. - #### Returns `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> -The output from the model's forward method. - ### isGenerating > **isGenerating**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md index 095563662..fe422974b 100644 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -2,7 +2,7 @@ > **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L20) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L20) React hook for managing a Large Language Model (LLM) instance. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md index 210e2d717..b3837e2da 100644 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -2,7 +2,7 @@ > **useOCR**(`__namedParameters`): `OCRModule` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L15) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md index 1266bbc23..5211bc17b 100644 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -2,7 +2,7 @@ > **useObjectDetection**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L10) ## Parameters @@ -28,22 +28,16 @@ Contains the error message if the model failed to load. > **forward**: (...`input`) => `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -This function runs the model's forward method with the provided input arguments. - #### Parameters ##### input ...\[`string`, `number`\] -Input arguments for the model's forward method. - #### Returns `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -The output from the model's forward method. - ### isGenerating > **isGenerating**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md index 033434655..e1c259d99 100644 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -2,7 +2,7 @@ > **useSpeechToText**(`speechToTextConfiguration`): [`SpeechToTextType`](../interfaces/SpeechToTextType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) React hook for managing a Speech to Text (STT) instance. diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md index d389774fe..f50e20148 100644 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -2,7 +2,7 @@ > **useStyleTransfer**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L10) ## Parameters @@ -28,22 +28,16 @@ Contains the error message if the model failed to load. > **forward**: (...`input`) => `Promise`\<`string`\> -This function runs the model's forward method with the provided input arguments. - #### Parameters ##### input ...\[`string`\] -Input arguments for the model's forward method. - #### Returns `Promise`\<`string`\> -The output from the model's forward method. - ### isGenerating > **isGenerating**: `boolean` diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md index 3bd623fc8..881108c95 100644 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -2,7 +2,7 @@ > **useTextEmbeddings**(`TextEmbeddingsConfiguration`): [`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) React hook for managing a Text Embeddings model instance. @@ -10,7 +10,7 @@ React hook for managing a Text Embeddings model instance. ### TextEmbeddingsConfiguration -[`Props`](../interfaces/Props.md) +[`TextEmbeddingsProps`](../interfaces/TextEmbeddingsProps.md) Configuration object containing `model` source and optional `preventLoad` flag. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md index 1fe651b94..357a72f9f 100644 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -2,7 +2,7 @@ > **useTextToImage**(`__namedParameters`): `TextToImageType` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L21) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L21) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md index 34f452c58..db0a02062 100644 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -1,19 +1,25 @@ # Function: useTextToSpeech() -> **useTextToSpeech**(`__namedParameters`): `object` +> **useTextToSpeech**(`TextToSpeechConfiguration`): `object` -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L22) + +React hook for managing Text to Speech instance. ## Parameters -### \_\_namedParameters +### TextToSpeechConfiguration `Props` +Configuration object containing `model` source, `voice` and optional `preventLoad`. + ## Returns `object` +Ready to use Text to Speech model. + ### downloadProgress > **downloadProgress**: `number` @@ -57,3 +63,11 @@ Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_proce #### Returns `Promise`\<`void`\> + +### streamStop() + +> **streamStop**: () => `void` = `moduleInstance.streamStop` + +#### Returns + +`void` diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md index e82d5aa19..75f947a7e 100644 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -2,7 +2,9 @@ > **useTokenizer**(`tokenizerConfiguration`): [`TokenizerType`](../interfaces/TokenizerType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) + +React hook for managing a Tokenizer instance. ## Parameters diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md index cc9c3d2cb..dcda74702 100644 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -1,57 +1,21 @@ # Function: useVAD() -> **useVAD**(`__namedParameters`): `object` +> **useVAD**(`VADConfiguration`): [`VADType`](../interfaces/VADType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) -## Parameters - -### \_\_namedParameters - -`Props` - -## Returns - -### downloadProgress - -> **downloadProgress**: `number` - -Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -Contains the error message if the model failed to load. +React hook for managing a VAD model instance. -### forward() - -> **forward**: (...`input`) => `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> - -This function runs the model's forward method with the provided input arguments. - -#### Parameters - -##### input - -...\[`Float32Array`\<`ArrayBufferLike`\>\] - -Input arguments for the model's forward method. - -#### Returns - -`Promise`\<[`Segment`](../interfaces/Segment.md)[]\> - -The output from the model's forward method. +## Parameters -### isGenerating +### VADConfiguration -> **isGenerating**: `boolean` +[`VADProps`](../interfaces/VADProps.md) -Indicates whether the model is currently generating a response. +Configuration object containing `model` source and optional `preventLoad` flag. -### isReady +## Returns -> **isReady**: `boolean` +[`VADType`](../interfaces/VADType.md) -Indicates whether the model is ready. +Ready to use VAD model. diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md index 2cbcbd37f..05eb2508c 100644 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -2,7 +2,7 @@ > **useVerticalOCR**(`__namedParameters`): `OCRModule` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L15) ## Parameters diff --git a/docs/docs/06-api-reference/index.md b/docs/docs/06-api-reference/index.md index b7c7015ac..ff492a1b7 100644 --- a/docs/docs/06-api-reference/index.md +++ b/docs/docs/06-api-reference/index.md @@ -33,17 +33,16 @@ - [Detection](interfaces/Detection.md) - [GenerationConfig](interfaces/GenerationConfig.md) - [KokoroConfig](interfaces/KokoroConfig.md) -- [KokoroOptions](interfaces/KokoroOptions.md) - [KokoroVoiceExtras](interfaces/KokoroVoiceExtras.md) - [LLMType](interfaces/LLMType.md) - [Message](interfaces/Message.md) - [OCRBbox](interfaces/OCRBbox.md) - [OCRDetection](interfaces/OCRDetection.md) -- [Props](interfaces/Props.md) - [Segment](interfaces/Segment.md) - [SpeechToTextModelConfig](interfaces/SpeechToTextModelConfig.md) - [SpeechToTextType](interfaces/SpeechToTextType.md) - [TensorPtr](interfaces/TensorPtr.md) +- [TextEmbeddingsProps](interfaces/TextEmbeddingsProps.md) - [TextEmbeddingsType](interfaces/TextEmbeddingsType.md) - [TextToSpeechConfig](interfaces/TextToSpeechConfig.md) - [TextToSpeechInput](interfaces/TextToSpeechInput.md) @@ -51,6 +50,8 @@ - [TokenizerType](interfaces/TokenizerType.md) - [ToolCall](interfaces/ToolCall.md) - [ToolsConfig](interfaces/ToolsConfig.md) +- [VADProps](interfaces/VADProps.md) +- [VADType](interfaces/VADType.md) - [VoiceConfig](interfaces/VoiceConfig.md) ## Type Aliases @@ -84,7 +85,8 @@ - [HAMMER2\_1\_1\_5B\_QUANTIZED](variables/HAMMER2_1_1_5B_QUANTIZED.md) - [HAMMER2\_1\_3B](variables/HAMMER2_1_3B.md) - [HAMMER2\_1\_3B\_QUANTIZED](variables/HAMMER2_1_3B_QUANTIZED.md) -- [KOKORO\_EN](variables/KOKORO_EN.md) +- [KOKORO\_MEDIUM](variables/KOKORO_MEDIUM.md) +- [KOKORO\_SMALL](variables/KOKORO_SMALL.md) - [KOKORO\_VOICE\_AF\_HEART](variables/KOKORO_VOICE_AF_HEART.md) - [KOKORO\_VOICE\_AF\_RIVER](variables/KOKORO_VOICE_AF_RIVER.md) - [KOKORO\_VOICE\_AF\_SARAH](variables/KOKORO_VOICE_AF_SARAH.md) diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md index 43cb93273..c07e5c2a2 100644 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -1,6 +1,6 @@ # Interface: Bbox -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L1) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L1) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](ht > **x1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L2) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L2) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](ht > **x2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L3) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L3) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](ht > **y1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L4) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L4) *** @@ -32,4 +32,4 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](ht > **y2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L5) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L5) diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md index cdbb50a69..c29722b1f 100644 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -1,6 +1,6 @@ # Interface: ChatConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L154) +Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L154) Object configuring chat management. @@ -10,7 +10,7 @@ Object configuring chat management. > **contextWindowLength**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:163](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L163) +Defined in: [packages/react-native-executorch/src/types/llm.ts:163](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L163) The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. @@ -20,7 +20,7 @@ The number of messages from the current conversation that the model will use to > **initialMessageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:158](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L158) +Defined in: [packages/react-native-executorch/src/types/llm.ts:158](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L158) An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. @@ -30,6 +30,6 @@ An array of `Message` objects that represent the conversation history. This can > **systemPrompt**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L168) +Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L168) Often used to tell the model what is its purpose, for example - "Be a helpful translator". diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md index ab2406b50..b552b288b 100644 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -1,6 +1,6 @@ # Interface: DecodingOptions -Defined in: [packages/react-native-executorch/src/types/stt.ts:167](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L167) +Defined in: [packages/react-native-executorch/src/types/stt.ts:167](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L167) Options for decoding speech to text. @@ -10,6 +10,6 @@ Options for decoding speech to text. > `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:171](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L171) +Defined in: [packages/react-native-executorch/src/types/stt.ts:171](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L171) Optional language code to guide the transcription. diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md index fbf904d04..8cbeb321a 100644 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -1,6 +1,6 @@ # Interface: Detection -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L8) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L8) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](ht > **bbox**: [`Bbox`](Bbox.md) -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L9) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L9) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](ht > **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L10) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L10) *** @@ -24,4 +24,4 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](h > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/objectDetection.ts#L11) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L11) diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md index e37f8c01b..76214ff42 100644 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -1,6 +1,6 @@ # Interface: GenerationConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:194](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L194) +Defined in: [packages/react-native-executorch/src/types/llm.ts:194](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L194) Object configuring generation settings. @@ -10,7 +10,7 @@ Object configuring generation settings. > `optional` **batchTimeInterval**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:213](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L213) +Defined in: [packages/react-native-executorch/src/types/llm.ts:213](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L213) Upper limit on the time interval between consecutive token batches. @@ -20,7 +20,7 @@ Upper limit on the time interval between consecutive token batches. > `optional` **outputTokenBatchSize**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:208](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L208) +Defined in: [packages/react-native-executorch/src/types/llm.ts:208](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L208) Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). @@ -30,7 +30,7 @@ Soft upper limit on the number of tokens in each token batch (in certain cases t > `optional` **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L198) +Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L198) Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. @@ -40,6 +40,6 @@ Scales output logits by the inverse of temperature. Controls the randomness / cr > `optional` **topp**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:203](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L203) +Defined in: [packages/react-native-executorch/src/types/llm.ts:203](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L203) Only samples from the smallest set of tokens whose cumulative probability exceeds topp. diff --git a/docs/docs/06-api-reference/interfaces/KokoroConfig.md b/docs/docs/06-api-reference/interfaces/KokoroConfig.md index 0b13895e6..df69cba00 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroConfig.md +++ b/docs/docs/06-api-reference/interfaces/KokoroConfig.md @@ -1,6 +1,6 @@ # Interface: KokoroConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:33](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L33) +Defined in: [packages/react-native-executorch/src/types/tts.ts:33](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L33) Kokoro model configuration. Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. @@ -11,31 +11,15 @@ Only the core Kokoro model sources, as phonemizer sources are included in voice > **durationPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:35](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L35) +Defined in: [packages/react-native-executorch/src/types/tts.ts:35](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L35) *** -### f0nPredictorSource +### synthesizerSource -> **f0nPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) +> **synthesizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:36](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L36) - -*** - -### textDecoderSource - -> **textDecoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -Defined in: [packages/react-native-executorch/src/types/tts.ts:38](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L38) - -*** - -### textEncoderSource - -> **textEncoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -Defined in: [packages/react-native-executorch/src/types/tts.ts:37](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L37) +Defined in: [packages/react-native-executorch/src/types/tts.ts:36](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L36) *** @@ -43,4 +27,4 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:37](https://githu > **type**: `"kokoro"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:34](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L34) +Defined in: [packages/react-native-executorch/src/types/tts.ts:34](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L34) diff --git a/docs/docs/06-api-reference/interfaces/KokoroOptions.md b/docs/docs/06-api-reference/interfaces/KokoroOptions.md deleted file mode 100644 index 2b4d7b5cb..000000000 --- a/docs/docs/06-api-reference/interfaces/KokoroOptions.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: KokoroOptions - -Defined in: [packages/react-native-executorch/src/types/tts.ts:48](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L48) - -Extra options associated with the Kokoro model - -## Properties - -### fixedModel? - -> `optional` **fixedModel**: `"small"` \| `"medium"` \| `"large"` - -Defined in: [packages/react-native-executorch/src/types/tts.ts:49](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L49) - -if set, forces Kokoro to use only one if it's 3 models - with static input shapes. Reduces the memory usage and - inference time variance, but could affect the result quality a little bit. diff --git a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md index 8d74ceea9..d1d8da2fa 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md +++ b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md @@ -1,6 +1,6 @@ # Interface: KokoroVoiceExtras -Defined in: [packages/react-native-executorch/src/types/tts.ts:24](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L24) +Defined in: [packages/react-native-executorch/src/types/tts.ts:24](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L24) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:24](https://githu > **lexiconSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L26) +Defined in: [packages/react-native-executorch/src/types/tts.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L26) *** @@ -16,4 +16,4 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:26](https://githu > **taggerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L25) +Defined in: [packages/react-native-executorch/src/types/tts.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L25) diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md index a01ff1f46..c503dc47f 100644 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -1,6 +1,6 @@ # Interface: LLMType -Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L6) +Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L6) React hook for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ React hook for managing a Large Language Model (LLM) instance. > **configure**: (`configuration`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L48) +Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L48) Configures chat and tool calling. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -69,7 +69,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > **deleteMessage**: (`index`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L114) +Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L114) Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. @@ -91,7 +91,7 @@ The index of the message to delete from history. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L35) +Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L35) Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. @@ -101,7 +101,7 @@ Represents the download progress as a value between 0 and 1, indicating the exte > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L40) +Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L40) Contains the error message if the model failed to load. @@ -111,7 +111,7 @@ Contains the error message if the model failed to load. > **generate**: (`messages`, `tools?`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:100](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L100) +Defined in: [packages/react-native-executorch/src/types/llm.ts:100](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L100) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -139,7 +139,7 @@ Optional array of tools that can be used during generation. > **getGeneratedTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L93) +Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L93) Returns the number of tokens generated so far in the current generation. @@ -155,7 +155,7 @@ The count of generated tokens. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:119](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L119) +Defined in: [packages/react-native-executorch/src/types/llm.ts:119](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L119) Function to interrupt the current inference. @@ -169,7 +169,7 @@ Function to interrupt the current inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L30) +Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L30) Indicates whether the model is currently generating a response. @@ -179,7 +179,7 @@ Indicates whether the model is currently generating a response. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L25) +Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L25) Indicates whether the model is ready. @@ -189,7 +189,7 @@ Indicates whether the model is ready. > **messageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L10) +Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L10) History containing all messages in conversation. This field is updated after model responds to sendMessage. @@ -199,7 +199,7 @@ History containing all messages in conversation. This field is updated after mod > **response**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L15) +Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L15) State of the generated response. This field is updated with each token generated by the model. @@ -209,7 +209,7 @@ State of the generated response. This field is updated with each token generated > **sendMessage**: (`message`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:107](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L107) +Defined in: [packages/react-native-executorch/src/types/llm.ts:107](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L107) Function to add user message to conversation. After model responds, `messageHistory` will be updated with both user message and model response. @@ -232,6 +232,6 @@ The message string to send. > **token**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L20) +Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L20) The most recently generated token. diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md index f7900ba1e..b6f6ee191 100644 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -1,6 +1,6 @@ # Interface: Message -Defined in: [packages/react-native-executorch/src/types/llm.ts:130](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L130) +Defined in: [packages/react-native-executorch/src/types/llm.ts:130](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L130) Represents a message in the conversation. @@ -10,7 +10,7 @@ Represents a message in the conversation. > **content**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:139](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L139) +Defined in: [packages/react-native-executorch/src/types/llm.ts:139](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L139) Content of the message. @@ -20,6 +20,6 @@ Content of the message. > **role**: [`MessageRole`](../type-aliases/MessageRole.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:134](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L134) +Defined in: [packages/react-native-executorch/src/types/llm.ts:134](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L134) Role of the message sender of type `MessageRole`. diff --git a/docs/docs/06-api-reference/interfaces/OCRBbox.md b/docs/docs/06-api-reference/interfaces/OCRBbox.md index 5c0d58bf5..166ec0d95 100644 --- a/docs/docs/06-api-reference/interfaces/OCRBbox.md +++ b/docs/docs/06-api-reference/interfaces/OCRBbox.md @@ -1,6 +1,6 @@ # Interface: OCRBbox -Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L9) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L9) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github > **x**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L10) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L10) *** @@ -16,4 +16,4 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://githu > **y**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L11) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L11) diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md index 52f4f8b1e..46aaa0842 100644 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -1,6 +1,6 @@ # Interface: OCRDetection -Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L3) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L3) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github > **bbox**: [`OCRBbox`](OCRBbox.md)[] -Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L4) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L4) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L6) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L6) *** @@ -24,4 +24,4 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:5](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L5) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L5) diff --git a/docs/docs/06-api-reference/interfaces/Props.md b/docs/docs/06-api-reference/interfaces/Props.md deleted file mode 100644 index 00fff3899..000000000 --- a/docs/docs/06-api-reference/interfaces/Props.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: Props - -Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:39 - -Props for the useTextEmbeddings hook. - -## Properties - -### model - -> **model**: `object` - -Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:40 - -#### modelSource - -> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` that specifies the location of the model binary. - -#### tokenizerSource - -> **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) - -`ResourceSource` pointing to the JSON file which contains the tokenizer. - -*** - -### preventLoad? - -> `optional` **preventLoad**: `boolean` - -Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:55 - -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/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index b43f9c44b..49c011825 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,8 @@ # Interface: Segment -Defined in: [packages/react-native-executorch/src/types/vad.ts:1](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/vad.ts#L1) +Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L22) + +Represents a detected audio segment with start and end timestamps. ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/vad.ts:1](https://github > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/vad.ts#L3) +Defined in: [packages/react-native-executorch/src/types/vad.ts:31](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L31) + +End time of the segment in seconds. *** @@ -16,4 +20,6 @@ Defined in: [packages/react-native-executorch/src/types/vad.ts:3](https://github > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:2](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/vad.ts#L2) +Defined in: [packages/react-native-executorch/src/types/vad.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L26) + +Start time of the segment in seconds. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md index 778de1883..570c312a4 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextModelConfig -Defined in: [packages/react-native-executorch/src/types/stt.ts:177](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L177) +Defined in: [packages/react-native-executorch/src/types/stt.ts:177](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L177) Configuration for Speech to Text model. @@ -10,7 +10,7 @@ Configuration for Speech to Text model. > **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:191](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L191) +Defined in: [packages/react-native-executorch/src/types/stt.ts:191](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L191) A string that specifies the location of a `.pte` file for the decoder. @@ -20,7 +20,7 @@ A string that specifies the location of a `.pte` file for the decoder. > **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:186](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L186) +Defined in: [packages/react-native-executorch/src/types/stt.ts:186](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L186) A string that specifies the location of a `.pte` file for the encoder. @@ -30,7 +30,7 @@ A string that specifies the location of a `.pte` file for the encoder. > **isMultilingual**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:181](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L181) +Defined in: [packages/react-native-executorch/src/types/stt.ts:181](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L181) A boolean flag indicating whether the model supports multiple languages. @@ -40,6 +40,6 @@ A boolean flag indicating whether the model supports multiple languages. > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:196](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L196) +Defined in: [packages/react-native-executorch/src/types/stt.ts:196](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L196) A string that specifies the location to the tokenizer for the model. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md index 43e62d020..3744ff639 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextType -Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L7) +Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L7) React hook for managing Speech to Text (STT) instance. @@ -10,7 +10,7 @@ React hook for managing Speech to Text (STT) instance. > **committedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L32) +Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L32) Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. @@ -21,7 +21,7 @@ Useful for displaying stable results during streaming. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L26) +Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L26) Tracks the progress of the model download process. @@ -31,7 +31,7 @@ Tracks the progress of the model download process. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L11) +Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L11) Contains the error message if the model failed to load. @@ -41,7 +41,7 @@ Contains the error message if the model failed to load. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L21) +Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L21) Indicates whether the model is currently processing an inference. @@ -51,7 +51,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L16) +Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L16) Indicates whether the model has successfully loaded and is ready for inference. @@ -61,7 +61,7 @@ Indicates whether the model has successfully loaded and is ready for inference. > **nonCommittedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L38) +Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L38) Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. @@ -72,7 +72,7 @@ Useful for displaying live, partial results during streaming. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L53) +Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L53) Runs the decoder of the model. Passing `number[]` is deprecated. @@ -102,7 +102,7 @@ A promise resolving to the decoded text. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L45) +Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L45) Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. @@ -126,7 +126,7 @@ A promise resolving to the encoded data. > **stream**(`options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L71) +Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L71) Starts a streaming transcription process. Use in combination with streamInsert to feed audio chunks and streamStop to end the stream. @@ -152,7 +152,7 @@ The final transcription string. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L78) +Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L78) Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Passing `number[]` is deprecated. @@ -175,7 +175,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L83) +Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L83) Stops the ongoing streaming transcription process. @@ -189,7 +189,7 @@ Stops the ongoing streaming transcription process. > **transcribe**(`waveform`, `options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L62) +Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L62) Starts a transcription process for a given input array, which should be a waveform at 16kHz. Passing `number[]` is deprecated. diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md index 6b21550a8..73bdb0eeb 100644 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -1,6 +1,6 @@ # Interface: TensorPtr -Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L51) +Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L51) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://gi > **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L52) +Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L52) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://gi > **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L54) +Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L54) *** @@ -24,4 +24,4 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://gi > **sizes**: `number`[] -Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L53) +Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L53) diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md new file mode 100644 index 000000000..f1c81483e --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md @@ -0,0 +1,35 @@ +# Interface: TextEmbeddingsProps + +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L39) + +Props for the useTextEmbeddings hook. + +## Properties + +### model + +> **model**: `object` + +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:40](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L40) + +#### modelSource + +> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +`ResourceSource` that specifies the location of the model binary. + +#### tokenizerSource + +> **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +`ResourceSource` pointing to the JSON file which contains the tokenizer. + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:55](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L55) + +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 849716e11..93eeb4ae4 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsType -Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:7 +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) React hook state and methods for managing a Text Embeddings model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Text Embeddings model instance. > **downloadProgress**: `number` -Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:26 +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) Tracks the progress of the model download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the model download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:11 +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) Contains the error message if the model failed to load or during inference. @@ -30,7 +30,7 @@ Contains the error message if the model failed to load or during inference. > **isGenerating**: `boolean` -Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:21 +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) Indicates whether the model is currently generating embeddings. @@ -40,7 +40,7 @@ Indicates whether the model is currently generating embeddings. > **isReady**: `boolean` -Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:16 +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) Indicates whether the embeddings model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the embeddings model has successfully loaded and is ready for > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: packages/react-native-executorch/src/types/textEmbeddings.ts:33 +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:33](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L33) Runs the text embeddings model on the provided input string. * diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md index b138c414b..f3bb780af 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:59](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L59) +Defined in: [packages/react-native-executorch/src/types/tts.ts:46](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L46) General Text to Speech module configuration @@ -10,26 +10,16 @@ General Text to Speech module configuration > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:60](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L60) +Defined in: [packages/react-native-executorch/src/types/tts.ts:47](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L47) a selected T2S model *** -### options? - -> `optional` **options**: [`KokoroOptions`](KokoroOptions.md) - -Defined in: [packages/react-native-executorch/src/types/tts.ts:62](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L62) - -a completely optional model-specific configuration - -*** - ### voice > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:61](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L61) +Defined in: [packages/react-native-executorch/src/types/tts.ts:48](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L48) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md index 6524acb87..07d201433 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:71](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L71) +Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L57) Text to Speech module input definition @@ -14,7 +14,7 @@ Text to Speech module input definition > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:73](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L73) +Defined in: [packages/react-native-executorch/src/types/tts.ts:59](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L59) optional speed argument - the higher it is, the faster the speech becomes @@ -24,6 +24,6 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:72](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L72) +Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L58) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md index b3f721a12..7eea46d4a 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechStreamingInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L87) +Defined in: [packages/react-native-executorch/src/types/tts.ts:73](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L73) Text to Speech streaming input definition @@ -19,7 +19,7 @@ Callbacks can be both synchronous or asynchronous. > `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:88](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L88) +Defined in: [packages/react-native-executorch/src/types/tts.ts:74](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L74) Called when streaming begins @@ -33,7 +33,7 @@ Called when streaming begins > `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:90](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L90) +Defined in: [packages/react-native-executorch/src/types/tts.ts:76](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L76) Called when streaming ends @@ -47,7 +47,7 @@ Called when streaming ends > `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:89](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L89) +Defined in: [packages/react-native-executorch/src/types/tts.ts:75](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L75) Called after each audio chunk gets calculated. @@ -67,7 +67,7 @@ Called after each audio chunk gets calculated. > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:73](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L73) +Defined in: [packages/react-native-executorch/src/types/tts.ts:59](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L59) optional speed argument - the higher it is, the faster the speech becomes @@ -81,7 +81,7 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:72](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L72) +Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L58) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TokenizerType.md b/docs/docs/06-api-reference/interfaces/TokenizerType.md index fe27735d5..35374fe79 100644 --- a/docs/docs/06-api-reference/interfaces/TokenizerType.md +++ b/docs/docs/06-api-reference/interfaces/TokenizerType.md @@ -1,6 +1,6 @@ # Interface: TokenizerType -Defined in: packages/react-native-executorch/src/types/tokenizer.ts:6 +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L6) React hook state and methods for managing a Tokenizer instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Tokenizer instance. > **downloadProgress**: `number` -Defined in: packages/react-native-executorch/src/types/tokenizer.ts:25 +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L25) Tracks the progress of the tokenizer download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the tokenizer download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: packages/react-native-executorch/src/types/tokenizer.ts:10 +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L10) Contains the error message if the tokenizer failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the tokenizer failed to load or during processing. > **isGenerating**: `boolean` -Defined in: packages/react-native-executorch/src/types/tokenizer.ts:20 +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L20) Indicates whether the tokenizer is currently processing data. @@ -40,7 +40,7 @@ Indicates whether the tokenizer is currently processing data. > **isReady**: `boolean` -Defined in: packages/react-native-executorch/src/types/tokenizer.ts:15 +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L15) Indicates whether the tokenizer has successfully loaded and is ready for use. @@ -50,7 +50,7 @@ Indicates whether the tokenizer has successfully loaded and is ready for use. > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: packages/react-native-executorch/src/types/tokenizer.ts:32 +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:32](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L32) Converts an array of token IDs into a string. @@ -78,7 +78,7 @@ A promise resolving to the decoded text string. > **encode**(`text`): `Promise`\<`number`[]\> -Defined in: packages/react-native-executorch/src/types/tokenizer.ts:39 +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L39) Converts a string into an array of token IDs. @@ -102,7 +102,7 @@ A promise resolving to an array `number[]` containing the encoded token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: packages/react-native-executorch/src/types/tokenizer.ts:45 +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:45](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L45) Returns the size of the tokenizer's vocabulary. @@ -118,7 +118,7 @@ A promise resolving to the vocabulary size. > **idToToken**(`id`): `Promise`\<`string`\> -Defined in: packages/react-native-executorch/src/types/tokenizer.ts:52 +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:52](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L52) Returns the token associated to the ID. @@ -142,7 +142,7 @@ A promise resolving to the token string representation. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: packages/react-native-executorch/src/types/tokenizer.ts:59 +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:59](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L59) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md index e88229b22..0a651c51e 100644 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -1,6 +1,6 @@ # Interface: ToolCall -Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L142) +Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L142) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://gith > **arguments**: `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L144) +Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L144) *** @@ -16,4 +16,4 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://gith > **toolName**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L143) +Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L143) diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md index a8a853e12..92ec2d1f2 100644 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -1,6 +1,6 @@ # Interface: ToolsConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:174](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L174) +Defined in: [packages/react-native-executorch/src/types/llm.ts:174](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L174) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. @@ -10,7 +10,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > `optional` **displayToolCalls**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:188](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L188) +Defined in: [packages/react-native-executorch/src/types/llm.ts:188](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L188) If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. @@ -20,7 +20,7 @@ If set to true, JSON tool calls will be displayed in chat. If false, only answer > **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L183) +Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L183) Function that accepts `ToolCall`, executes tool and returns the string to model. @@ -40,6 +40,6 @@ Function that accepts `ToolCall`, executes tool and returns the string to model. > **tools**: `Object`[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:178](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L178) +Defined in: [packages/react-native-executorch/src/types/llm.ts:178](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L178) List of objects defining tools. diff --git a/docs/docs/06-api-reference/interfaces/VADProps.md b/docs/docs/06-api-reference/interfaces/VADProps.md new file mode 100644 index 000000000..6f86caf39 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/VADProps.md @@ -0,0 +1,29 @@ +# Interface: VADProps + +Defined in: [packages/react-native-executorch/src/types/vad.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L7) + +Props for the useVAD hook. + +## Properties + +### model + +> **model**: `object` + +Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L11) + +`ResourceSource` that specifies the location of the VAD model binary. + +#### modelSource + +> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/vad.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L16) + +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 new file mode 100644 index 000000000..6f36aba38 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/VADType.md @@ -0,0 +1,69 @@ +# Interface: VADType + +Defined in: [packages/react-native-executorch/src/types/vad.ts:37](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L37) + +React hook state and methods for managing a Voice Activity Detection (VAD) model instance. + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: [packages/react-native-executorch/src/types/vad.ts:56](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L56) + +Represents the download progress as a value between 0 and 1. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: [packages/react-native-executorch/src/types/vad.ts:41](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L41) + +Contains the error message if the VAD model failed to load or during processing. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/vad.ts:51](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L51) + +Indicates whether the model is currently processing an inference. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/vad.ts:46](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L46) + +Indicates whether the VAD model has successfully loaded and is ready for inference. + +## Methods + +### forward() + +> **forward**(`waveform`): `Promise`\<[`Segment`](Segment.md)[]\> + +Defined in: [packages/react-native-executorch/src/types/vad.ts:63](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L63) + +Runs the Voice Activity Detection model on the provided audio waveform. + +#### Parameters + +##### waveform + +`Float32Array` + +The input audio waveform array. + +#### Returns + +`Promise`\<[`Segment`](Segment.md)[]\> + +A promise resolving to an array of detected audio segments (e.g., timestamps for speech). diff --git a/docs/docs/06-api-reference/interfaces/VoiceConfig.md b/docs/docs/06-api-reference/interfaces/VoiceConfig.md index 59a785e9c..4cf1f2a51 100644 --- a/docs/docs/06-api-reference/interfaces/VoiceConfig.md +++ b/docs/docs/06-api-reference/interfaces/VoiceConfig.md @@ -1,6 +1,6 @@ # Interface: VoiceConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L17) +Defined in: [packages/react-native-executorch/src/types/tts.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L17) Voice configuration @@ -12,7 +12,7 @@ So far in Kokoro, each voice is directly associated with a language. > `optional` **extra**: [`KokoroVoiceExtras`](KokoroVoiceExtras.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L20) an optional extra sources or properties related to specific voice @@ -22,7 +22,7 @@ an optional extra sources or properties related to specific voice > **lang**: [`TextToSpeechLanguage`](../type-aliases/TextToSpeechLanguage.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L18) +Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L18) speaker's language @@ -32,6 +32,6 @@ speaker's language > **voiceSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L19) +Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L19) a source to a binary file with voice embedding diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md index 38d76aba5..4bb21536e 100644 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -2,4 +2,4 @@ > **LLMTool** = `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:149](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L149) +Defined in: [packages/react-native-executorch/src/types/llm.ts:149](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L149) diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md index e985336aa..6e20258b2 100644 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -2,6 +2,6 @@ > **MessageRole** = `"user"` \| `"assistant"` \| `"system"` -Defined in: [packages/react-native-executorch/src/types/llm.ts:125](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L125) +Defined in: [packages/react-native-executorch/src/types/llm.ts:125](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L125) Roles that a message sender can have. diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md index 05f753d11..2902e333d 100644 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -2,4 +2,4 @@ > **OCRLanguage** = keyof *typeof* `symbols` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/ocr.ts#L14) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L14) diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md index 85eb2edfb..5c8679235 100644 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -2,6 +2,6 @@ > **ResourceSource** = `string` \| `number` \| `object` -Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L8) +Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L8) Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md index 493dec186..0130c56cc 100644 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -2,4 +2,4 @@ > **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/stt.ts#L87) +Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L87) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md index ddbda14f5..a401bf33b 100644 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -2,4 +2,4 @@ > **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` -Defined in: [packages/react-native-executorch/src/types/common.ts:38](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/common.ts#L38) +Defined in: [packages/react-native-executorch/src/types/common.ts:38](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L38) diff --git a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md index c6dbba5ef..512f206b2 100644 --- a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md @@ -2,4 +2,4 @@ > **TextToSpeechLanguage** = `"en-us"` \| `"en-gb"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:4](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/tts.ts#L4) +Defined in: [packages/react-native-executorch/src/types/tts.ts:4](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L4) diff --git a/docs/docs/06-api-reference/typedoc-sidebar.cjs b/docs/docs/06-api-reference/typedoc-sidebar.cjs index 5032ac327..2e9f60cd2 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:"Enumerations",items:[{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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/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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroConfig",label:"KokoroConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroOptions",label:"KokoroOptions"},{type:"doc",id:"06-api-reference/interfaces/KokoroVoiceExtras",label:"KokoroVoiceExtras"},{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/OCRBbox",label:"OCRBbox"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/Props",label:"Props"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextType",label:"SpeechToTextType"},{type:"doc",id:"06-api-reference/interfaces/TensorPtr",label:"TensorPtr"},{type:"doc",id:"06-api-reference/interfaces/TextEmbeddingsType",label:"TextEmbeddingsType"},{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/TextToSpeechStreamingInput",label:"TextToSpeechStreamingInput"},{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/VoiceConfig",label:"VoiceConfig"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_EN",label:"KOKORO_EN"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; +const typedocSidebar = {items:[{type:"category",label:"Enumerations",items:[{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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/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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{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/LLMType",label:"LLMType"},{type:"doc",id:"06-api-reference/interfaces/Message",label:"Message"},{type:"doc",id:"06-api-reference/interfaces/OCRBbox",label:"OCRBbox"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextType",label:"SpeechToTextType"},{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/TextToSpeechConfig",label:"TextToSpeechConfig"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechInput",label:"TextToSpeechInput"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechStreamingInput",label:"TextToSpeechStreamingInput"},{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/VADProps",label:"VADProps"},{type:"doc",id:"06-api-reference/interfaces/VADType",label:"VADType"},{type:"doc",id:"06-api-reference/interfaces/VoiceConfig",label:"VoiceConfig"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_MEDIUM",label:"KOKORO_MEDIUM"},{type:"doc",id:"06-api-reference/variables/KOKORO_SMALL",label:"KOKORO_SMALL"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; 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 68f49e605..53c2bf292 100644 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MINILM\_L6\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L408) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L408) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md index da63ed261..3680a10c7 100644 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MPNET\_BASE\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L413) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L413) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md index dcab30090..2c41ea483 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_256**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L442) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L442) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index 9be37f923..064a1dab8 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_512**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L434) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L434) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index 0908e5d11..0aac1cb50 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_IMAGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md index bf2bce137..4104fdb53 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_TEXT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L428) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L428) ## 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 e217e99ca..53494f666 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: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L385) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L385) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md index 55778439d..17bf9bcdb 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_CHAT\_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md index 532658af0..8ed33e234 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_CONTEXT\_WINDOW\_LENGTH**: `5` = `5` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md index 0b87a33d5..94b02c19f 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_MESSAGE\_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md index ed87ff56a..e97bfe73a 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_SYSTEM\_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) 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 134ef9b9f..6264f2d9e 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -2,7 +2,7 @@ > `const` **EFFICIENTNET\_V2\_S**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L260) ## 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 e0be45348..bb9d2a12a 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -2,7 +2,7 @@ > `const` **FSMN\_VAD**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L453) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L453) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md index 360e46a96..7c376918e 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L108) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L108) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md index 98c154672..5d70bd907 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L114) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L114) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md index 631a1c5f7..881c678b3 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L120) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L120) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md index 4369aa8c2..9743569bc 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L126) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L126) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md index 676433803..77b00c457 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L132) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L132) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md index 4e39d5305..545b55159 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L138) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L138) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_EN.md b/docs/docs/06-api-reference/variables/KOKORO_EN.md deleted file mode 100644 index 0852fd700..000000000 --- a/docs/docs/06-api-reference/variables/KOKORO_EN.md +++ /dev/null @@ -1,27 +0,0 @@ -# Variable: KOKORO\_EN - -> `const` **KOKORO\_EN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/models.ts#L9) - -## Type Declaration - -### durationPredictorSource - -> **durationPredictorSource**: `string` = `KOKORO_EN_DURATION_PREDICTOR` - -### f0nPredictorSource - -> **f0nPredictorSource**: `string` = `KOKORO_EN_F0N_PREDICTOR` - -### textDecoderSource - -> **textDecoderSource**: `string` = `KOKORO_EN_TEXT_DECODER` - -### textEncoderSource - -> **textEncoderSource**: `string` = `KOKORO_EN_TEXT_ENCODER` - -### type - -> **type**: `"kokoro"` diff --git a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md new file mode 100644 index 000000000..fda14df2f --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md @@ -0,0 +1,21 @@ +# Variable: KOKORO\_MEDIUM + +> `const` **KOKORO\_MEDIUM**: `object` + +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/models.ts#L22) + +A standard Kokoro instance which processes the text in batches of maximum 128 tokens. + +## Type Declaration + +### durationPredictorSource + +> **durationPredictorSource**: `string` + +### synthesizerSource + +> **synthesizerSource**: `string` + +### type + +> **type**: `"kokoro"` diff --git a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md new file mode 100644 index 000000000..e96d87ed2 --- /dev/null +++ b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md @@ -0,0 +1,23 @@ +# Variable: KOKORO\_SMALL + +> `const` **KOKORO\_SMALL**: `object` + +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/models.ts#L13) + +A Kokoro model instance which processes the text in batches of maximum 64 tokens. +Uses significant less memory than the medium model, but could produce +a lower quality speech due to forced, aggressive text splitting. + +## Type Declaration + +### durationPredictorSource + +> **durationPredictorSource**: `string` + +### synthesizerSource + +> **synthesizerSource**: `string` + +### type + +> **type**: `"kokoro"` diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md index beb6d7cd9..4bde7f398 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_HEART**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L21) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md index 01511285b..8f1acc313 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_RIVER**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L26) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L26) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md index 2f467da4f..348d7651a 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_SARAH**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L31) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L31) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md index c40b60617..3dae4a2b8 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_ADAM**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L36) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L36) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md index 8d78c3af6..7057a3928 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_MICHAEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L41) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md index ee624a8fc..016e30267 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_SANTA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L46) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md index ddbbb96a6..50dc26244 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BF\_EMMA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L51) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L51) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md index b41380fd4..4c6902a90 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BM\_DANIEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/tts/voices.ts#L56) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L56) 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 4279417b8..af58310b3 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L34) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L34) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md index 3ebf0add9..70952dcec 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L40) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L40) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md index ad6079d2b..26feeba35 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L46) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md index 82682e321..2cb21f7c3 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L16) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L16) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md index 756fc2457..97b9909f7 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L22) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md index b05cebefe..111b6173d 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L28) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L28) ## 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 be26e55cb..9d6b2a4c4 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MINILM\_L6\_COS\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L418) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L418) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md index f67a5065d..014e31d21 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MPNET\_BASE\_DOT\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md index 5f6d0c4b5..d16e48efe 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L41) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md index eb3d24f3b..9db4a5b42 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L47) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L47) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md index a183cd01d..e5031174a 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L53) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L53) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md index b3e882936..747be4950 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L362) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L362) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md index c921c6baf..5185cef20 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L59) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L59) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md index 4988914f0..c14b5fe0d 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L65) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L65) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md index 4e00e31af..0a4334aec 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L71) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L71) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md index c499b5b04..727b7f833 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L83) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L83) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md index 5fef0e3dd..0f4f043d3 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L77) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L77) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md index dd4d0f063..186547dec 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L98) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L98) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md index 6867c7c00..5dedd846b 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L164) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L164) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md index b1ae7d970..e2557bacf 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L104) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L104) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md index e22875eab..e9441aed4 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L116) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L116) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md index d73b10d65..f023eb886 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L122) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L122) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md index f5b75b820..f2d631c96 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L284) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md index 8819ac5a1..058c26817 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L134) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L134) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md index 214729225..1fb964a3e 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L146) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L146) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md index f5cea7f26..b23d33f9f 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L152) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L152) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md index 8d6a731bf..8f31581a1 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L128) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L128) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md index 34a287a10..51f161175 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L170) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L170) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md index 9a5a51291..10afe8a5d 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L188) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L188) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md index 50b3d5a79..cd0340792 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L176) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L176) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md index 968e8c622..970da0dec 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L182) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L182) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md index 8ae3b6b7d..be097d512 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L158) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L158) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md index 53eab4633..2aa5f5a26 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L194) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L194) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md index 192be0161..6b24bd9ce 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md index 7e07decbe..d1ab54490 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md index e8ebf56ff..392d7fcf6 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md index 6b7c925e9..751e90f0f 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md index da94ee29b..643b6a035 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md index 904d78db8..aa5bcfb7c 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L236) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L236) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md index 4e622edd0..3a5da7d05 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md index 983921edb..9e184b5c4 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L254) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L254) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md index 94820a459..f6e718fa5 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md index 474561067..642eba8b8 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md index b19a32e7d..fb9060852 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L272) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L272) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md index 564f6b7e9..0c18b7241 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L278) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L278) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md index 270a62bae..b550de3fb 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L260) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md index 07f90bcb0..28c6d516e 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L266) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L266) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md index 07384c1f5..79578af62 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L290) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L290) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md index 65e4cbaae..104840cc1 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L296) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L296) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md index cf2ba9262..bc2c74c70 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L302) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md index c1db60c14..57926459b 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L308) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L308) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md index 349c73995..073fd38c7 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L314) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L314) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md index 8c45d5bfb..0c801360a 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L320) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L320) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md index c06293b70..3127d15f7 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L326) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L326) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md index 1d739773c..1d50c1030 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L332) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L332) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md index da57e75c8..6af8d44c0 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L341) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L341) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md index 49773fbef..1f03c9284 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L89) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L89) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md index cd6288eac..95df823cc 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L350) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L350) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md index 358136883..209f6176c 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L356) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L356) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md index 4f3bf12d3..192e5a419 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L140) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L140) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md index d290f3b37..7723f5ec3 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L374) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L374) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md index 253770fb9..bb4990d47 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md index be43b02ad..257c5ee42 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L380) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L380) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md index 76439b0ec..a2164b717 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L398) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L398) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md index 175cc8125..c50ad2412 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md index bb7335d83..e93ae8f0e 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L386) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L386) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md index 96524c1c6..1ab28a287 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L404) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L404) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md index 82deaacdd..1dd014ceb 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L410) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L410) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md index 06c254a2c..18c058e61 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L416) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L416) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md index 20c7f0f0b..b600c9789 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L422) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L422) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md index ed9009963..2850dfd72 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L110) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L110) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md index f03c566fb..2e48c011c 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md index 4e7e404d8..400c27e36 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md index dc8d3ad39..4e519b484 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md index 20b8b5cad..1d8415085 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md index 9fca9e80c..9f3cf979a 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md index 7f39cc260..e002787f2 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md index f3c72a583..6b4270c9d 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md index c33496f9d..22fe56aa6 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md index 2702799ea..3bead53c0 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L62) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L62) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md index 79d5de810..ef8a7c7ec 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L68) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L68) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md index dab6a8ca8..bdfc5011a 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L74) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L74) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md index 21c0b656d..87adeef0d 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L80) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L80) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index b90dd4bb6..e5faddbdf 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L86) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L86) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md index c51ada492..ab6fa96bc 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L92) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L92) ## 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 c92414218..5fe2789cb 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L154) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L154) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md index 2acc2602b..787df9f3f 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L160) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L160) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md index 0766dbcb0..03206dbe7 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L178) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L178) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md index b77f9923b..3ff76186c 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L184) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L184) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md index 22eff8120..3c7b7d47e 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L166) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L166) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md index f39084fed..d076e91d0 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L172) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L172) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md index f78cf2c53..cab3e88a6 100644 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -2,7 +2,7 @@ > `const` **SPECIAL\_TOKENS**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:216](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/types/llm.ts#L216) +Defined in: [packages/react-native-executorch/src/types/llm.ts:216](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L216) ## Type Declaration 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 d6866cd6c..b4b89cbb0 100644 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `const` **SSDLITE\_320\_MOBILENET\_V3\_LARGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L267) ## 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 ec3706d25..3f50af129 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_CANDY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L289) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L289) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md index 5dbca5d17..f00bf8db9 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_MOSAIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L293) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L293) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md index 2faf5ba97..23cfcbc05 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_RAIN\_PRINCESS**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md index af441464f..e0e4e2b9d 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_UDNIE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L301) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L301) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md index 509d9bce7..f1945bf22 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L42) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L42) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md index 978d6fbe2..b2fadbed2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L48) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L48) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md index 2216be767..ff1e502f3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L54) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L54) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md index 5ff5864db..e75d05802 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L363) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L363) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md index b9f1110aa..75c41d432 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L60) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L60) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md index cd27e95de..fe4b23dc6 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L66) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L66) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md index cf7c07cd7..cf7880a43 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L72) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L72) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md index 79d7ca97e..e9972e9e1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L84) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L84) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md index cde882385..5b86b16f6 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L78) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L78) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md index f1646af72..6db898a1d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L99) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L99) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md index aecf7c806..829f48276 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L165) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L165) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md index fff770de1..e8b23f20b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L105) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L105) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md index caf4aae6e..724d2d968 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L117) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L117) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md index 960ae16a0..4d924094b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L123) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L123) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md index 6d76d5ff1..8097f3b9a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L285) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L285) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md index 683c0847d..f3c677e2b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L135) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L135) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md index bd23ea097..2b2531988 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L147) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L147) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md index 01b46b3a1..2fe4c12d0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L153) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L153) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md index e540239bb..d8b20344f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L129) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L129) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md index 822074683..106dde99d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L171) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L171) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md index d032ecd4a..6f91c32d9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L189) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L189) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md index 53227441e..ff00016d7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L177) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L177) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md index 01c7d4936..e89bb6efa 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L183) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L183) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md index 08a2b5d57..cabbae6f8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L159) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L159) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md index 414a9b455..72e440a7b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L195) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L195) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md index 8703fd6a7..b54a0d014 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L201) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L201) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md index d6803ad91..bbdb933ad 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L213) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L213) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md index a7aafa5e4..f2d9b6713 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L207) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L207) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md index 3ec71f642..d408f0030 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L219) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L219) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md index cc628a13e..d57326ea6 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L225) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L225) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md index 937326ad7..d4e4d8a32 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L237) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L237) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md index 8e71a3ac0..36c041ed5 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L231) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L231) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md index 517b8071c..e4bafcf8e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L255) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L255) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md index d96d2074c..368950fe8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L243) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L243) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md index 022db80b6..f7c909c1e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L249) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L249) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md index 8046c0ebc..5715d5359 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L273) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L273) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md index 1604b9b65..1ed3d33bf 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L279) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L279) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md index c99bc1c40..bcd6582c2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L261) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L261) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md index 0b7ee04b1..60700fe24 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L267) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md index a18488508..171de5e64 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L291) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L291) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md index 8a32df7ef..a760ff43f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md index 45b2a4429..81f9c606e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L303) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L303) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md index 41f23570e..dadab1931 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L309) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L309) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md index 678593c04..8636111a8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L315) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L315) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md index a01ddcaa7..4800e5b14 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L321) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L321) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md index 6dd5c784c..7ab1de1b9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L327) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L327) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md index d2a68b9e2..8dd38ae36 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L336) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L336) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md index 5644f4dbe..b0ecebef9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L345) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L345) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md index 44eb7c455..da867e242 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L93) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L93) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md index 6a974e4ad..8bcb02893 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L351) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L351) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md index 69e654129..fde9d920f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L357) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L357) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md index daa67a2eb..74a224ebf 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L141) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L141) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md index fd0ac5027..fb917fcb0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md index a96eb788b..9d7c9695c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L369) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L369) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md index fecab3d86..fae442994 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L381) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L381) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md index d65b992f9..5e08375ed 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L399) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L399) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md index 68a8e2aa7..cfe830a39 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L393) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L393) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md index 7b6dceebb..cff08536c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L387) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L387) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md index a1a699978..e74bb2f36 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L405) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L405) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md index 0eab58cca..a6388b4df 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L411) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L411) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md index c97b8f7e0..9b1209ab5 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L417) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L417) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md index 0efd33c92..0b8ef33c3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md index b11ebb4e8..71d2ef8fc 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/ocr/models.ts#L111) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L111) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md index 76e1cad3f..41dee9a4b 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md index f3b61eb15..8ac4a0dcf 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L347) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L347) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md index 32ede15ee..cfdd67563 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md index 11a3e7cff..974ddee05 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L354) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L354) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md index 9198c48fa..55344f321 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L361) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L361) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md index 5c083c981..b152636ab 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L333) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L333) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md index 31dc4f48d..17cfd3908 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/constants/modelUrls.ts#L340) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L340) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md index 830072040..2e6bb0796 100644 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -2,7 +2,7 @@ > `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] -Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/58509193bdce6956ca0a9f447a97326983ae2e83/packages/react-native-executorch/src/utils/llm.ts#L9) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/llm.ts#L9) ## Parameters diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 66314c245..dc92ca313 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -66,6 +66,28 @@ const config = { // sidebar: { ... } }, ], + [ + '@signalwire/docusaurus-plugin-llms-txt', + /** @type {import('@signalwire/docusaurus-plugin-llms-txt').PluginOptions} */ + ({ + siteTitle: 'React Native ExecuTorch', + siteDescription: + "React Native ExecuTorch brings Meta's ExecuTorch AI framework into the React Native ecosystem, enabling developers to run AI models and LLMs locally, directly on mobile devices. It provides a declarative API for on-device inference, allowing you to use local AI models without relying on cloud infrastructure. Built on the ExecuTorch foundation - part of the PyTorch Edge ecosystem - it extends efficient on-device AI deployment to cross-platform mobile applications in React Native.", + depth: 3, + enableDescriptions: true, + content: { + includeVersionedDocs: false, + relativePaths: false, + enableMarkdownFiles: false, + excludeRoutes: ['**/react-native-executorch/search'], + }, + includeOrder: [ + '**/docs/!(category|benchmarks)**', + '**/docs/benchmarks/**', + '**/docs/category/**', + ], + }), + ], ], themeConfig: @@ -138,31 +160,7 @@ const config = { suggestedQuestions: true, enableSidePanel: true, }, - }, - plugins: [ - [ - '@signalwire/docusaurus-plugin-llms-txt', - /** @type {import('@signalwire/docusaurus-plugin-llms-txt').PluginOptions} */ - ({ - siteTitle: 'React Native ExecuTorch', - siteDescription: - "React Native ExecuTorch brings Meta's ExecuTorch AI framework into the React Native ecosystem, enabling developers to run AI models and LLMs locally, directly on mobile devices. It provides a declarative API for on-device inference, allowing you to use local AI models without relying on cloud infrastructure. Built on the ExecuTorch foundation - part of the PyTorch Edge ecosystem - it extends efficient on-device AI deployment to cross-platform mobile applications in React Native.", - depth: 3, - enableDescriptions: true, - content: { - includeVersionedDocs: false, - relativePaths: false, - enableMarkdownFiles: false, - excludeRoutes: ['**/react-native-executorch/search'], - }, - includeOrder: [ - '**/docs/!(category|benchmarks)**', - '**/docs/benchmarks/**', - '**/docs/category/**', - ], - }), - ], - ], + } }; module.exports = config; diff --git a/docs/src/theme/SearchBar.tsx b/docs/src/theme/SearchBar.tsx new file mode 100644 index 000000000..7536c3716 --- /dev/null +++ b/docs/src/theme/SearchBar.tsx @@ -0,0 +1,5 @@ +import React from 'react'; + +export default function SearchBar() { + return
; +} \ No newline at end of file From 9bb82fb60d89f90f318e9cd8ce4319b8930ff81f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Mon, 26 Jan 2026 13:47:14 +0100 Subject: [PATCH 08/15] Add another batch of typed docs --- .../classes/ClassificationModule.md | 14 +- .../classes/ExecutorchModule.md | 14 +- .../classes/ImageEmbeddingsModule.md | 14 +- .../classes/ImageSegmentationModule.md | 14 +- .../06-api-reference/classes/LLMModule.md | 24 +- .../06-api-reference/classes/OCRModule.md | 10 +- .../classes/ObjectDetectionModule.md | 14 +- .../classes/ResourceFetcher.md | 20 +- .../classes/RnExecutorchError.md | 8 +- .../classes/SpeechToTextModule.md | 18 +- .../classes/StyleTransferModule.md | 14 +- .../classes/TextEmbeddingsModule.md | 14 +- .../classes/TextToImageModule.md | 18 +- .../classes/TokenizerModule.md | 16 +- .../06-api-reference/classes/VADModule.md | 14 +- .../classes/VerticalOCRModule.md | 10 +- .../enumerations/CocoLabel.md | 725 ++++++++++++++++++ .../enumerations/DeeplabLabel.md | 46 +- .../enumerations/RnExecutorchErrorCode.md | 86 +-- .../enumerations/ScalarType.md | 46 +- .../DEFAULT_STRUCTURED_OUTPUT_PROMPT.md | 2 +- .../fixAndValidateStructuredOutput.md | 2 +- .../functions/getStructuredOutputPrompt.md | 2 +- .../functions/useClassification.md | 50 +- .../functions/useExecutorchModule.md | 50 +- .../functions/useImageEmbeddings.md | 14 +- .../functions/useImageSegmentation.md | 50 +- .../docs/06-api-reference/functions/useLLM.md | 2 +- .../docs/06-api-reference/functions/useOCR.md | 2 +- .../functions/useObjectDetection.md | 50 +- .../functions/useSpeechToText.md | 2 +- .../functions/useStyleTransfer.md | 2 +- .../functions/useTextEmbeddings.md | 2 +- .../functions/useTextToImage.md | 2 +- .../functions/useTextToSpeech.md | 60 +- .../functions/useTokenizer.md | 2 +- .../docs/06-api-reference/functions/useVAD.md | 2 +- .../functions/useVerticalOCR.md | 2 +- docs/docs/06-api-reference/index.md | 15 +- docs/docs/06-api-reference/interfaces/Bbox.md | 20 +- .../06-api-reference/interfaces/ChatConfig.md | 8 +- .../interfaces/ClassificationProps.md | 29 + .../interfaces/ClassificationType.md | 74 ++ .../interfaces/DecodingOptions.md | 4 +- .../06-api-reference/interfaces/Detection.md | 16 +- .../interfaces/ExecutorchModuleProps.md | 25 + .../interfaces/ExecutorchModuleType.md | 74 ++ .../interfaces/GenerationConfig.md | 10 +- .../interfaces/ImageEmbeddingsProps.md | 29 + .../interfaces/ImageEmbeddingsType.md | 74 ++ .../interfaces/ImageSegmentationProps.md | 29 + .../interfaces/ImageSegmentationType.md | 86 +++ .../interfaces/KokoroConfig.md | 8 +- .../interfaces/KokoroVoiceExtras.md | 6 +- .../06-api-reference/interfaces/LLMType.md | 28 +- .../06-api-reference/interfaces/Message.md | 6 +- .../interfaces/OCRDetection.md | 10 +- .../interfaces/ObjectDetectionProps.md | 29 + .../interfaces/ObjectDetectionType.md | 80 ++ .../interfaces/{OCRBbox.md => Point.md} | 8 +- .../06-api-reference/interfaces/Segment.md | 6 +- .../interfaces/SpeechToTextModelConfig.md | 10 +- .../interfaces/SpeechToTextType.md | 26 +- .../06-api-reference/interfaces/TensorPtr.md | 8 +- .../interfaces/TextEmbeddingsProps.md | 6 +- .../interfaces/TextEmbeddingsType.md | 16 +- .../interfaces/TextToSpeechConfig.md | 10 +- .../interfaces/TextToSpeechInput.md | 6 +- .../interfaces/TextToSpeechProps.md | 47 ++ .../interfaces/TextToSpeechStreamingInput.md | 12 +- .../interfaces/TextToSpeechType.md | 119 +++ .../interfaces/TokenizerType.md | 20 +- .../06-api-reference/interfaces/ToolCall.md | 6 +- .../interfaces/ToolsConfig.md | 8 +- .../06-api-reference/interfaces/VADProps.md | 6 +- .../06-api-reference/interfaces/VADType.md | 16 +- .../interfaces/VoiceConfig.md | 8 +- .../06-api-reference/type-aliases/LLMTool.md | 2 +- .../type-aliases/MessageRole.md | 2 +- .../type-aliases/OCRLanguage.md | 2 +- .../type-aliases/ResourceSource.md | 2 +- .../type-aliases/SpeechToTextLanguage.md | 2 +- .../type-aliases/TensorBuffer.md | 2 +- .../type-aliases/TextToSpeechLanguage.md | 2 +- .../docs/06-api-reference/typedoc-sidebar.cjs | 2 +- .../variables/ALL_MINILM_L6_V2.md | 2 +- .../variables/ALL_MPNET_BASE_V2.md | 2 +- .../variables/BK_SDM_TINY_VPRED_256.md | 2 +- .../variables/BK_SDM_TINY_VPRED_512.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 2 +- .../variables/DEEPLAB_V3_RESNET50.md | 2 +- .../variables/DEFAULT_CHAT_CONFIG.md | 2 +- .../DEFAULT_CONTEXT_WINDOW_LENGTH.md | 2 +- .../variables/DEFAULT_MESSAGE_HISTORY.md | 2 +- .../variables/DEFAULT_SYSTEM_PROMPT.md | 2 +- .../variables/EFFICIENTNET_V2_S.md | 2 +- .../06-api-reference/variables/FSMN_VAD.md | 2 +- .../variables/HAMMER2_1_0_5B.md | 2 +- .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_1_5B.md | 2 +- .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_3B.md | 2 +- .../variables/HAMMER2_1_3B_QUANTIZED.md | 2 +- .../variables/KOKORO_MEDIUM.md | 2 +- .../variables/KOKORO_SMALL.md | 2 +- .../variables/KOKORO_VOICE_AF_HEART.md | 2 +- .../variables/KOKORO_VOICE_AF_RIVER.md | 2 +- .../variables/KOKORO_VOICE_AF_SARAH.md | 2 +- .../variables/KOKORO_VOICE_AM_ADAM.md | 2 +- .../variables/KOKORO_VOICE_AM_MICHAEL.md | 2 +- .../variables/KOKORO_VOICE_AM_SANTA.md | 2 +- .../variables/KOKORO_VOICE_BF_EMMA.md | 2 +- .../variables/KOKORO_VOICE_BM_DANIEL.md | 2 +- .../06-api-reference/variables/LLAMA3_2_1B.md | 2 +- .../variables/LLAMA3_2_1B_QLORA.md | 2 +- .../variables/LLAMA3_2_1B_SPINQUANT.md | 2 +- .../06-api-reference/variables/LLAMA3_2_3B.md | 2 +- .../variables/LLAMA3_2_3B_QLORA.md | 2 +- .../variables/LLAMA3_2_3B_SPINQUANT.md | 2 +- .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 2 +- .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 2 +- .../06-api-reference/variables/OCR_ABAZA.md | 2 +- .../06-api-reference/variables/OCR_ADYGHE.md | 2 +- .../variables/OCR_AFRIKAANS.md | 2 +- .../variables/OCR_ALBANIAN.md | 2 +- .../06-api-reference/variables/OCR_AVAR.md | 2 +- .../variables/OCR_AZERBAIJANI.md | 2 +- .../variables/OCR_BELARUSIAN.md | 2 +- .../06-api-reference/variables/OCR_BOSNIAN.md | 2 +- .../variables/OCR_BULGARIAN.md | 2 +- .../06-api-reference/variables/OCR_CHECHEN.md | 2 +- .../variables/OCR_CROATIAN.md | 2 +- .../06-api-reference/variables/OCR_CZECH.md | 2 +- .../06-api-reference/variables/OCR_DANISH.md | 2 +- .../06-api-reference/variables/OCR_DARGWA.md | 2 +- .../06-api-reference/variables/OCR_DUTCH.md | 2 +- .../06-api-reference/variables/OCR_ENGLISH.md | 2 +- .../variables/OCR_ESTONIAN.md | 2 +- .../06-api-reference/variables/OCR_FRENCH.md | 2 +- .../06-api-reference/variables/OCR_GERMAN.md | 2 +- .../variables/OCR_HUNGARIAN.md | 2 +- .../variables/OCR_ICELANDIC.md | 2 +- .../variables/OCR_INDONESIAN.md | 2 +- .../06-api-reference/variables/OCR_INGUSH.md | 2 +- .../06-api-reference/variables/OCR_IRISH.md | 2 +- .../06-api-reference/variables/OCR_ITALIAN.md | 2 +- .../variables/OCR_JAPANESE.md | 2 +- .../06-api-reference/variables/OCR_KANNADA.md | 2 +- .../variables/OCR_KARBADIAN.md | 2 +- .../06-api-reference/variables/OCR_KOREAN.md | 2 +- .../06-api-reference/variables/OCR_KURDISH.md | 2 +- .../06-api-reference/variables/OCR_LAK.md | 2 +- .../06-api-reference/variables/OCR_LATIN.md | 2 +- .../06-api-reference/variables/OCR_LATVIAN.md | 2 +- .../variables/OCR_LEZGHIAN.md | 2 +- .../variables/OCR_LITHUANIAN.md | 2 +- .../06-api-reference/variables/OCR_MALAY.md | 2 +- .../06-api-reference/variables/OCR_MALTESE.md | 2 +- .../06-api-reference/variables/OCR_MAORI.md | 2 +- .../variables/OCR_MONGOLIAN.md | 2 +- .../variables/OCR_NORWEGIAN.md | 2 +- .../06-api-reference/variables/OCR_OCCITAN.md | 2 +- .../06-api-reference/variables/OCR_PALI.md | 2 +- .../06-api-reference/variables/OCR_POLISH.md | 2 +- .../variables/OCR_PORTUGUESE.md | 2 +- .../variables/OCR_ROMANIAN.md | 2 +- .../06-api-reference/variables/OCR_RUSSIAN.md | 2 +- .../variables/OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/OCR_SERBIAN_LATIN.md | 2 +- .../variables/OCR_SIMPLIFIED_CHINESE.md | 2 +- .../06-api-reference/variables/OCR_SLOVAK.md | 2 +- .../variables/OCR_SLOVENIAN.md | 2 +- .../06-api-reference/variables/OCR_SPANISH.md | 2 +- .../06-api-reference/variables/OCR_SWAHILI.md | 2 +- .../06-api-reference/variables/OCR_SWEDISH.md | 2 +- .../variables/OCR_TABASSARAN.md | 2 +- .../06-api-reference/variables/OCR_TAGALOG.md | 2 +- .../06-api-reference/variables/OCR_TAJIK.md | 2 +- .../06-api-reference/variables/OCR_TELUGU.md | 2 +- .../06-api-reference/variables/OCR_TURKISH.md | 2 +- .../variables/OCR_UKRAINIAN.md | 2 +- .../06-api-reference/variables/OCR_UZBEK.md | 2 +- .../variables/OCR_VIETNAMESE.md | 2 +- .../06-api-reference/variables/OCR_WELSH.md | 2 +- .../variables/PHI_4_MINI_4B.md | 2 +- .../variables/PHI_4_MINI_4B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_0_5B.md | 2 +- .../variables/QWEN2_5_0_5B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_1_5B.md | 2 +- .../variables/QWEN2_5_1_5B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN2_5_3B.md | 2 +- .../variables/QWEN2_5_3B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_0_6B.md | 2 +- .../variables/QWEN3_0_6B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_1_7B.md | 2 +- .../variables/QWEN3_1_7B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_4B.md | 2 +- .../variables/QWEN3_4B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_135M.md | 2 +- .../variables/SMOLLM2_1_135M_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_1_7B.md | 2 +- .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_360M.md | 2 +- .../variables/SMOLLM2_1_360M_QUANTIZED.md | 2 +- .../variables/SPECIAL_TOKENS.md | 2 +- .../SSDLITE_320_MOBILENET_V3_LARGE.md | 2 +- .../variables/STYLE_TRANSFER_CANDY.md | 2 +- .../variables/STYLE_TRANSFER_MOSAIC.md | 2 +- .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 2 +- .../variables/STYLE_TRANSFER_UDNIE.md | 2 +- .../variables/VERTICAL_OCR_ABAZA.md | 2 +- .../variables/VERTICAL_OCR_ADYGHE.md | 2 +- .../variables/VERTICAL_OCR_AFRIKAANS.md | 2 +- .../variables/VERTICAL_OCR_ALBANIAN.md | 2 +- .../variables/VERTICAL_OCR_AVAR.md | 2 +- .../variables/VERTICAL_OCR_AZERBAIJANI.md | 2 +- .../variables/VERTICAL_OCR_BELARUSIAN.md | 2 +- .../variables/VERTICAL_OCR_BOSNIAN.md | 2 +- .../variables/VERTICAL_OCR_BULGARIAN.md | 2 +- .../variables/VERTICAL_OCR_CHECHEN.md | 2 +- .../variables/VERTICAL_OCR_CROATIAN.md | 2 +- .../variables/VERTICAL_OCR_CZECH.md | 2 +- .../variables/VERTICAL_OCR_DANISH.md | 2 +- .../variables/VERTICAL_OCR_DARGWA.md | 2 +- .../variables/VERTICAL_OCR_DUTCH.md | 2 +- .../variables/VERTICAL_OCR_ENGLISH.md | 2 +- .../variables/VERTICAL_OCR_ESTONIAN.md | 2 +- .../variables/VERTICAL_OCR_FRENCH.md | 2 +- .../variables/VERTICAL_OCR_GERMAN.md | 2 +- .../variables/VERTICAL_OCR_HUNGARIAN.md | 2 +- .../variables/VERTICAL_OCR_ICELANDIC.md | 2 +- .../variables/VERTICAL_OCR_INDONESIAN.md | 2 +- .../variables/VERTICAL_OCR_INGUSH.md | 2 +- .../variables/VERTICAL_OCR_IRISH.md | 2 +- .../variables/VERTICAL_OCR_ITALIAN.md | 2 +- .../variables/VERTICAL_OCR_JAPANESE.md | 2 +- .../variables/VERTICAL_OCR_KANNADA.md | 2 +- .../variables/VERTICAL_OCR_KARBADIAN.md | 2 +- .../variables/VERTICAL_OCR_KOREAN.md | 2 +- .../variables/VERTICAL_OCR_KURDISH.md | 2 +- .../variables/VERTICAL_OCR_LAK.md | 2 +- .../variables/VERTICAL_OCR_LATIN.md | 2 +- .../variables/VERTICAL_OCR_LATVIAN.md | 2 +- .../variables/VERTICAL_OCR_LEZGHIAN.md | 2 +- .../variables/VERTICAL_OCR_LITHUANIAN.md | 2 +- .../variables/VERTICAL_OCR_MALAY.md | 2 +- .../variables/VERTICAL_OCR_MALTESE.md | 2 +- .../variables/VERTICAL_OCR_MAORI.md | 2 +- .../variables/VERTICAL_OCR_MONGOLIAN.md | 2 +- .../variables/VERTICAL_OCR_NORWEGIAN.md | 2 +- .../variables/VERTICAL_OCR_OCCITAN.md | 2 +- .../variables/VERTICAL_OCR_PALI.md | 2 +- .../variables/VERTICAL_OCR_POLISH.md | 2 +- .../variables/VERTICAL_OCR_PORTUGUESE.md | 2 +- .../variables/VERTICAL_OCR_ROMANIAN.md | 2 +- .../variables/VERTICAL_OCR_RUSSIAN.md | 2 +- .../VERTICAL_OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/VERTICAL_OCR_SERBIAN_LATIN.md | 2 +- .../VERTICAL_OCR_SIMPLIFIED_CHINESE.md | 2 +- .../variables/VERTICAL_OCR_SLOVAK.md | 2 +- .../variables/VERTICAL_OCR_SLOVENIAN.md | 2 +- .../variables/VERTICAL_OCR_SPANISH.md | 2 +- .../variables/VERTICAL_OCR_SWAHILI.md | 2 +- .../variables/VERTICAL_OCR_SWEDISH.md | 2 +- .../variables/VERTICAL_OCR_TABASSARAN.md | 2 +- .../variables/VERTICAL_OCR_TAGALOG.md | 2 +- .../variables/VERTICAL_OCR_TAJIK.md | 2 +- .../variables/VERTICAL_OCR_TELUGU.md | 2 +- .../variables/VERTICAL_OCR_TURKISH.md | 2 +- .../variables/VERTICAL_OCR_UKRAINIAN.md | 2 +- .../variables/VERTICAL_OCR_UZBEK.md | 2 +- .../variables/VERTICAL_OCR_VIETNAMESE.md | 2 +- .../variables/VERTICAL_OCR_WELSH.md | 2 +- .../variables/WHISPER_BASE.md | 2 +- .../variables/WHISPER_BASE_EN.md | 2 +- .../variables/WHISPER_SMALL.md | 2 +- .../variables/WHISPER_SMALL_EN.md | 2 +- .../variables/WHISPER_TINY.md | 2 +- .../variables/WHISPER_TINY_EN.md | 2 +- .../variables/WHISPER_TINY_EN_QUANTIZED.md | 2 +- .../variables/parseToolCall.md | 2 +- 282 files changed, 2071 insertions(+), 774 deletions(-) create mode 100644 docs/docs/06-api-reference/enumerations/CocoLabel.md create mode 100644 docs/docs/06-api-reference/interfaces/ClassificationProps.md create mode 100644 docs/docs/06-api-reference/interfaces/ClassificationType.md create mode 100644 docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md create mode 100644 docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md create mode 100644 docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md create mode 100644 docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md create mode 100644 docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md create mode 100644 docs/docs/06-api-reference/interfaces/ImageSegmentationType.md create mode 100644 docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md create mode 100644 docs/docs/06-api-reference/interfaces/ObjectDetectionType.md rename docs/docs/06-api-reference/interfaces/{OCRBbox.md => Point.md} (72%) create mode 100644 docs/docs/06-api-reference/interfaces/TextToSpeechProps.md create mode 100644 docs/docs/06-api-reference/interfaces/TextToSpeechType.md diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index feccbf7e2..a9ad42730 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,6 @@ # Class: ClassificationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Class > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Class > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index 2ddada8ea..4bb8171b3 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -1,6 +1,6 @@ # Class: ExecutorchModule -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L26) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md index d3b778edf..efc1c9260 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: ImageEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md index 2b4057c67..53f575d15 100644 --- a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -1,6 +1,6 @@ # Class: ImageSegmentationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) #### Parameters @@ -80,7 +80,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -128,7 +128,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md index bd1a27e00..d8022aee8 100644 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -1,6 +1,6 @@ # Class: LLMModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L11) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L11) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **new LLMModule**(`__namedParameters`): `LLMModule` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **configure**(`__namedParameters`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L52) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L52) #### Parameters @@ -64,7 +64,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:92](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L92) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:92](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L92) #### Returns @@ -76,7 +76,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:79](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L79) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:79](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L79) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **forward**(`input`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L64) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L64) #### Parameters @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **generate**(`messages`, `tools?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L69) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L69) #### Parameters @@ -134,7 +134,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **getGeneratedTokenCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) #### Returns @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:84](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L84) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:84](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L84) #### Returns @@ -158,7 +158,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L30) #### Parameters @@ -190,7 +190,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) #### Parameters @@ -208,7 +208,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **setTokenCallback**(`__namedParameters`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L44) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L44) #### Parameters diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md index 93245a54e..6c99e73ee 100644 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -1,6 +1,6 @@ # Class: OCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **new OCRModule**(): `OCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index f1ae40652..e4de045c7 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -1,6 +1,6 @@ # Class: ObjectDetectionModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -124,7 +124,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md index b92d48363..359e0ba0e 100644 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -1,6 +1,6 @@ # Class: ResourceFetcher -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](h > `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](h > `static` **cancelFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251]( > `static` **deleteResources**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278]( > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](h > `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290]( > `static` **listDownloadedFiles**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) #### Returns @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268]( > `static` **listDownloadedModels**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) #### Returns @@ -126,7 +126,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273]( > `static` **pauseFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) #### Parameters @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241]( > `static` **resumeFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) #### Parameters diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md index 53bdd532b..605fc91de 100644 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -1,6 +1,6 @@ # Class: RnExecutorchError -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/errorUtils.ts#L3) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/errorUtils.ts#L3) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https: > **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/errorUtils.ts#L14) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/errorUtils.ts#L14) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https > `optional` **cause**: `unknown` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/errorUtils.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/errorUtils.ts#L12) The original cause of the error, if any. @@ -56,7 +56,7 @@ The original cause of the error, if any. > **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/errorUtils.ts#L7) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/errorUtils.ts#L7) The error code representing the type of error. diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md index dd75cbe75..e74db2253 100644 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -1,6 +1,6 @@ # Class: SpeechToTextModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L7) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L74) Runs the decoder of the model. Passing number[] is deprecated. @@ -48,7 +48,7 @@ Decoded output. > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L51) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L51) #### Returns @@ -60,7 +60,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L55) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L55) #### Parameters @@ -78,7 +78,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L17) #### Parameters @@ -100,7 +100,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **stream**(`options`): `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:121](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L121) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:121](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L121) #### Parameters @@ -118,7 +118,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:176](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L176) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:176](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L176) #### Parameters @@ -136,7 +136,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:186](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L186) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:186](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L186) #### Returns @@ -148,7 +148,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **transcribe**(`waveform`, `options`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:102](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L102) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:102](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L102) Transcribes audio using the Whisper model. diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index 6191f9871..b88c54a13 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,6 @@ # Class: StyleTransferModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index 4c501443c..a25bf2df4 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: TextEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L35) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L35) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index ddcd7b83d..ac20eacf6 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -1,6 +1,6 @@ # Class: TextToImageModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) #### Parameters @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -62,7 +62,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) #### Parameters @@ -92,7 +92,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -140,7 +140,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) #### Returns @@ -152,7 +152,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md index 662f7c7c4..7fdddd9a0 100644 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -1,6 +1,6 @@ # Class: TokenizerModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L7) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L31) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L31) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **encode**(`s`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L27) #### Parameters @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L38) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L38) #### Returns @@ -78,7 +78,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **idToToken**(`tokenId`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L42) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L42) #### Parameters @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L9) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L46) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L46) #### Parameters diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index 1a897437b..46583ae79 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -1,6 +1,6 @@ # Class: VADModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L26) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) #### Parameters @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md index f344b3c89..7472eea21 100644 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -1,6 +1,6 @@ # Class: VerticalOCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **new VerticalOCRModule**(): `VerticalOCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/enumerations/CocoLabel.md b/docs/docs/06-api-reference/enumerations/CocoLabel.md new file mode 100644 index 000000000..6f082a06a --- /dev/null +++ b/docs/docs/06-api-reference/enumerations/CocoLabel.md @@ -0,0 +1,725 @@ +# Enumeration: CocoLabel + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:35](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L35) + +COCO dataset class labels used for object detection. + +## Enumeration Members + +### AIRPLANE + +> **AIRPLANE**: `5` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L40) + +*** + +### APPLE + +> **APPLE**: `53` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L87) + +*** + +### BACKPACK + +> **BACKPACK**: `27` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L62) + +*** + +### BANANA + +> **BANANA**: `52` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L86) + +*** + +### BASEBALL + +> **BASEBALL**: `39` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L74) + +*** + +### BEAR + +> **BEAR**: `23` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L58) + +*** + +### BED + +> **BED**: `65` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L99) + +*** + +### BENCH + +> **BENCH**: `15` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L50) + +*** + +### BICYCLE + +> **BICYCLE**: `2` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L37) + +*** + +### BIRD + +> **BIRD**: `16` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L51) + +*** + +### BLENDER + +> **BLENDER**: `83` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L117) + +*** + +### BOAT + +> **BOAT**: `9` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L44) + +*** + +### BOOK + +> **BOOK**: `84` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L118) + +*** + +### BOTTLE + +> **BOTTLE**: `44` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L78) + +*** + +### BOWL + +> **BOWL**: `51` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L85) + +*** + +### BROCCOLI + +> **BROCCOLI**: `56` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L90) + +*** + +### BUS + +> **BUS**: `6` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L41) + +*** + +### CAKE + +> **CAKE**: `61` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L95) + +*** + +### CAR + +> **CAR**: `3` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L38) + +*** + +### CARROT + +> **CARROT**: `57` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L91) + +*** + +### CAT + +> **CAT**: `17` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L52) + +*** + +### CELL\_PHONE + +> **CELL\_PHONE**: `77` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L111) + +*** + +### CHAIR + +> **CHAIR**: `62` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L96) + +*** + +### CLOCK + +> **CLOCK**: `85` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L119) + +*** + +### COUCH + +> **COUCH**: `63` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L97) + +*** + +### COW + +> **COW**: `21` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L56) + +*** + +### CUP + +> **CUP**: `47` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L81) + +*** + +### DESK + +> **DESK**: `69` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L103) + +*** + +### DINING\_TABLE + +> **DINING\_TABLE**: `67` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L101) + +*** + +### DOG + +> **DOG**: `18` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L53) + +*** + +### DONUT + +> **DONUT**: `60` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L94) + +*** + +### DOOR + +> **DOOR**: `71` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L105) + +*** + +### ELEPHANT + +> **ELEPHANT**: `22` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L57) + +*** + +### EYE + +> **EYE**: `30` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L65) + +*** + +### FIRE\_HYDRANT + +> **FIRE\_HYDRANT**: `11` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L46) + +*** + +### FORK + +> **FORK**: `48` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L82) + +*** + +### FRISBEE + +> **FRISBEE**: `34` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L69) + +*** + +### GIRAFFE + +> **GIRAFFE**: `25` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L60) + +*** + +### HAIR\_BRUSH + +> **HAIR\_BRUSH**: `91` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L125) + +*** + +### HAIR\_DRIER + +> **HAIR\_DRIER**: `89` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L123) + +*** + +### HANDBAG + +> **HANDBAG**: `31` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L66) + +*** + +### HAT + +> **HAT**: `26` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L61) + +*** + +### HORSE + +> **HORSE**: `19` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L54) + +*** + +### HOT\_DOG + +> **HOT\_DOG**: `58` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L92) + +*** + +### KEYBOARD + +> **KEYBOARD**: `76` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L110) + +*** + +### KITE + +> **KITE**: `38` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L73) + +*** + +### KNIFE + +> **KNIFE**: `49` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L83) + +*** + +### LAPTOP + +> **LAPTOP**: `73` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L107) + +*** + +### MICROWAVE + +> **MICROWAVE**: `78` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L112) + +*** + +### MIRROR + +> **MIRROR**: `66` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L100) + +*** + +### MOTORCYCLE + +> **MOTORCYCLE**: `4` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L39) + +*** + +### MOUSE + +> **MOUSE**: `74` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L108) + +*** + +### ORANGE + +> **ORANGE**: `55` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L89) + +*** + +### OVEN + +> **OVEN**: `79` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L113) + +*** + +### PARKING + +> **PARKING**: `14` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L49) + +*** + +### PERSON + +> **PERSON**: `1` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L36) + +*** + +### PIZZA + +> **PIZZA**: `59` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L93) + +*** + +### PLATE + +> **PLATE**: `45` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L79) + +*** + +### POTTED\_PLANT + +> **POTTED\_PLANT**: `64` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L98) + +*** + +### REFRIGERATOR + +> **REFRIGERATOR**: `82` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L116) + +*** + +### REMOTE + +> **REMOTE**: `75` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L109) + +*** + +### SANDWICH + +> **SANDWICH**: `54` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L88) + +*** + +### SCISSORS + +> **SCISSORS**: `87` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L121) + +*** + +### SHEEP + +> **SHEEP**: `20` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L55) + +*** + +### SHOE + +> **SHOE**: `29` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L64) + +*** + +### SINK + +> **SINK**: `81` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L115) + +*** + +### SKATEBOARD + +> **SKATEBOARD**: `41` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L75) + +*** + +### SKIS + +> **SKIS**: `35` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L70) + +*** + +### SNOWBOARD + +> **SNOWBOARD**: `36` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L71) + +*** + +### SPOON + +> **SPOON**: `50` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L84) + +*** + +### SPORTS + +> **SPORTS**: `37` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L72) + +*** + +### STOP\_SIGN + +> **STOP\_SIGN**: `13` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L48) + +*** + +### STREET\_SIGN + +> **STREET\_SIGN**: `12` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L47) + +*** + +### SUITCASE + +> **SUITCASE**: `33` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L68) + +*** + +### SURFBOARD + +> **SURFBOARD**: `42` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L76) + +*** + +### TEDDY\_BEAR + +> **TEDDY\_BEAR**: `88` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L122) + +*** + +### TENNIS\_RACKET + +> **TENNIS\_RACKET**: `43` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L77) + +*** + +### TIE + +> **TIE**: `32` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L67) + +*** + +### TOASTER + +> **TOASTER**: `80` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L114) + +*** + +### TOILET + +> **TOILET**: `70` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L104) + +*** + +### TOOTHBRUSH + +> **TOOTHBRUSH**: `90` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L124) + +*** + +### TRAFFIC\_LIGHT + +> **TRAFFIC\_LIGHT**: `10` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L45) + +*** + +### TRAIN + +> **TRAIN**: `7` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L42) + +*** + +### TRUCK + +> **TRUCK**: `8` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L43) + +*** + +### TV + +> **TV**: `72` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L106) + +*** + +### UMBRELLA + +> **UMBRELLA**: `28` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L63) + +*** + +### VASE + +> **VASE**: `86` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L120) + +*** + +### WINDOW + +> **WINDOW**: `68` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L102) + +*** + +### WINE\_GLASS + +> **WINE\_GLASS**: `46` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L80) + +*** + +### ZEBRA + +> **ZEBRA**: `24` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L59) diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md index aa2e0b2f5..36fdbbd86 100644 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -1,6 +1,6 @@ # Enumeration: DeeplabLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L2) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:2]( > **AEROPLANE**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L4) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:4]( > **ARGMAX**: `21` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24] > **BACKGROUND**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L3) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) *** @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:3]( > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) *** @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5]( > **BIRD**: `3` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) *** @@ -48,7 +48,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6]( > **BOAT**: `4` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) *** @@ -56,7 +56,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7]( > **BOTTLE**: `5` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) *** @@ -64,7 +64,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8]( > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) *** @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9]( > **CAR**: `7` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) *** @@ -80,7 +80,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10] > **CAT**: `8` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) *** @@ -88,7 +88,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11] > **CHAIR**: `9` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) *** @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12] > **COW**: `10` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) *** @@ -104,7 +104,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13] > **DININGTABLE**: `11` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) *** @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14] > **DOG**: `12` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) *** @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15] > **HORSE**: `13` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) *** @@ -128,7 +128,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16] > **MOTORBIKE**: `14` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) *** @@ -136,7 +136,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17] > **PERSON**: `15` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) *** @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18] > **POTTEDPLANT**: `16` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) *** @@ -152,7 +152,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19] > **SHEEP**: `17` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) *** @@ -160,7 +160,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20] > **SOFA**: `18` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) *** @@ -168,7 +168,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21] > **TRAIN**: `19` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) *** @@ -176,4 +176,4 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22] > **TVMONITOR**: `20` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md index 0dccaaa39..228dc0eab 100644 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -1,6 +1,6 @@ # Enumeration: RnExecutorchErrorCode -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https: > **AccessFailed**: `34` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](http > **DelegateInvalidCompatibility**: `48` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](http > **DelegateInvalidHandle**: `50` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) *** @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](http > **DelegateMemoryAllocationFailed**: `49` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) *** @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](http > **DownloadInterrupted**: `118` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) Thrown when the number of downloaded files is unexpected, due to download interruptions. @@ -50,7 +50,7 @@ Thrown when the number of downloaded files is unexpected, due to download interr > **EndOfMethod**: `3` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](http > **FileReadFailed**: `114` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. @@ -68,7 +68,7 @@ Thrown when a file read operation failed. This could be invalid image url passed > **FileWriteFailed**: `103` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) An error ocurred when saving a file. This could be, for instance a result image from an image model. @@ -78,7 +78,7 @@ An error ocurred when saving a file. This could be, for instance a result image > **Internal**: `1` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) *** @@ -86,7 +86,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](http > **InvalidArgument**: `18` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) *** @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](http > **InvalidConfig**: `112` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. @@ -104,7 +104,7 @@ Thrown when config parameters passed to a model are invalid. For example, when L > **InvalidExternalData**: `36` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) *** @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](http > **InvalidModelOutput**: `115` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) Thrown when the size of model output is unexpected. @@ -122,7 +122,7 @@ Thrown when the size of model output is unexpected. > **InvalidModelSource**: `255` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) Thrown when the type of model source passed by the user is invalid. @@ -132,7 +132,7 @@ Thrown when the type of model source passed by the user is invalid. > **InvalidProgram**: `35` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) *** @@ -140,7 +140,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](http > **InvalidState**: `2` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) *** @@ -148,7 +148,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](http > **InvalidType**: `19` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) *** @@ -156,7 +156,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](http > **InvalidUserInput**: `117` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). @@ -166,7 +166,7 @@ Thrown when the input passed to our APIs is invalid, for example when passing an > **LanguageNotSupported**: `105` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. @@ -176,7 +176,7 @@ Thrown when a language is passed to a multi-language model that is not supported > **MemoryAllocationFailed**: `33` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) *** @@ -184,7 +184,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](http > **MissingDataChunk**: `161` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) Thrown when streaming transcription is attempted but audio data chunk is missing. @@ -194,7 +194,7 @@ Thrown when streaming transcription is attempted but audio data chunk is missing > **ModelGenerating**: `104` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. @@ -204,7 +204,7 @@ Thrown when a user tries to run a model that is currently processing. It is only > **ModuleNotLoaded**: `102` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. @@ -214,7 +214,7 @@ Thrown when a user tries to run a model that is not yet downloaded or loaded int > **MultilingualConfiguration**: `160` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. @@ -224,7 +224,7 @@ Thrown when there's a configuration mismatch between multilingual and language s > **NotFound**: `32` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) *** @@ -232,7 +232,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](http > **NotImplemented**: `17` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) *** @@ -240,7 +240,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](http > **NotSupported**: `16` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) *** @@ -248,7 +248,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](http > **Ok**: `0` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) *** @@ -256,7 +256,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](http > **OperatorMissing**: `20` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) *** @@ -264,7 +264,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](http > **OutOfResources**: `37` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) *** @@ -272,7 +272,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](http > **ResourceFetcherAlreadyOngoing**: `183` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) Thrown when trying to resume a download that is already ongoing. @@ -282,7 +282,7 @@ Thrown when trying to resume a download that is already ongoing. > **ResourceFetcherAlreadyPaused**: `182` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) Thrown when trying to pause a download that is already paused. @@ -292,7 +292,7 @@ Thrown when trying to pause a download that is already paused. > **ResourceFetcherDownloadFailed**: `180` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. @@ -302,7 +302,7 @@ Thrown when a resource fails to download. This could be due to invalid URL, or f > **ResourceFetcherDownloadInProgress**: `181` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) Thrown when a user tries to trigger a download that's already in progress. @@ -312,7 +312,7 @@ Thrown when a user tries to trigger a download that's already in progress. > **ResourceFetcherMissingUri**: `185` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) Thrown when required URI information is missing for a download operation. @@ -322,7 +322,7 @@ Thrown when required URI information is missing for a download operation. > **ResourceFetcherNotActive**: `184` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) Thrown when trying to pause, resume, or cancel a download that is not active. @@ -332,7 +332,7 @@ Thrown when trying to pause, resume, or cancel a download that is not active. > **StreamingInProgress**: `163` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) Thrown when trying to start a new streaming session while another is already in progress. @@ -342,7 +342,7 @@ Thrown when trying to start a new streaming session while another is already in > **StreamingNotStarted**: `162` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) Thrown when trying to stop or insert data into a stream that hasn't been started. @@ -352,7 +352,7 @@ Thrown when trying to stop or insert data into a stream that hasn't been started > **ThreadPoolError**: `113` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) Thrown when React Native ExecuTorch threadpool problem occurs. @@ -362,7 +362,7 @@ Thrown when React Native ExecuTorch threadpool problem occurs. > **UnexpectedNumInputs**: `97` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) Thrown when the number of passed inputs to the model is different than the model metadata specifies. @@ -372,7 +372,7 @@ Thrown when the number of passed inputs to the model is different than the model > **UnknownError**: `101` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. @@ -382,6 +382,6 @@ An umbrella-error that is thrown usually when something unexpected happens, for > **WrongDimensions**: `116` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md index 871259b31..c2f0d5f12 100644 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -1,6 +1,6 @@ # Enumeration: ScalarType -Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L13) +Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L13) Enum representing the scalar types of tensors. @@ -10,7 +10,7 @@ Enum representing the scalar types of tensors. > **BITS16**: `22` -Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L28) +Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L28) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://gi > **BOOL**: `11` -Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L22) +Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L22) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://gi > **BYTE**: `0` -Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L14) +Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L14) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://gi > **CHAR**: `1` -Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L15) +Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L15) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://gi > **DOUBLE**: `7` -Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L21) +Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L21) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://gi > **FLOAT**: `6` -Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L20) +Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L20) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://gi > **FLOAT8E4M3FN**: `24` -Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L30) +Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L30) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://gi > **FLOAT8E4M3FNUZ**: `26` -Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L32) +Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L32) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://gi > **FLOAT8E5M2**: `23` -Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L29) +Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L29) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://gi > **FLOAT8E5M2FNUZ**: `25` -Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L31) +Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L31) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://gi > **HALF**: `5` -Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L19) +Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L19) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://gi > **INT**: `3` -Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L17) +Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L17) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://gi > **LONG**: `4` -Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L18) +Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L18) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://gi > **QINT32**: `14` -Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L25) +Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L25) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://gi > **QINT8**: `12` -Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L23) +Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L23) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://gi > **QUINT2X4**: `17` -Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L27) +Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L27) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://gi > **QUINT4X2**: `16` -Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L26) +Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L26) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://gi > **QUINT8**: `13` -Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L24) +Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L24) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://gi > **SHORT**: `2` -Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L16) +Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L16) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://gi > **UINT16**: `27` -Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L33) +Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L33) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://gi > **UINT32**: `28` -Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L34) +Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L34) *** @@ -178,4 +178,4 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://gi > **UINT64**: `29` -Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L35) +Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L35) diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md index 7485a1c0c..fa6269ad0 100644 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -2,7 +2,7 @@ > **DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT**(`structuredOutputSchema`): `string` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) ## Parameters diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md index 690ac3cb7..9f31e4c79 100644 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -2,7 +2,7 @@ > **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> -Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/llm.ts#L81) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/llm.ts#L81) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md index a5cce7167..f678fa3cc 100644 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -2,7 +2,7 @@ > **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` -Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/llm.ts#L50) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/llm.ts#L50) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md index adbaf551c..4fef03761 100644 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -1,51 +1,21 @@ # Function: useClassification() -> **useClassification**(`__namedParameters`): `object` +> **useClassification**(`ClassificationConfiguration`): [`ClassificationType`](../interfaces/ClassificationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L11) -## Parameters - -### \_\_namedParameters - -`Props` - -## Returns - -### downloadProgress - -> **downloadProgress**: `number` - -Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +React hook for managing a Classification model instance. -Contains the error message if the model failed to load. - -### forward() - -> **forward**: (...`input`) => `Promise`\<`any`\> - -#### Parameters - -##### input - -...\[`string`\] - -#### Returns - -`Promise`\<`any`\> +## Parameters -### isGenerating +### ClassificationConfiguration -> **isGenerating**: `boolean` +[`ClassificationProps`](../interfaces/ClassificationProps.md) -Indicates whether the model is currently generating a response. +Configuration object containing `model` source and optional `preventLoad` flag. -### isReady +## Returns -> **isReady**: `boolean` +[`ClassificationType`](../interfaces/ClassificationType.md) -Indicates whether the model is ready. +Ready to use Classification model. diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md index 80d48036d..96f6abd20 100644 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -1,51 +1,21 @@ # Function: useExecutorchModule() -> **useExecutorchModule**(`__namedParameters`): `object` +> **useExecutorchModule**(`executorchModuleConfiguration`): [`ExecutorchModuleType`](../interfaces/ExecutorchModuleType.md) -Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L11) -## Parameters - -### \_\_namedParameters - -`Props` - -## Returns - -### downloadProgress - -> **downloadProgress**: `number` - -Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +React hook for managing an arbitrary Executorch module instance. -Contains the error message if the model failed to load. - -### forward() - -> **forward**: (...`input`) => `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> - -#### Parameters - -##### input - -...\[[`TensorPtr`](../interfaces/TensorPtr.md)[]\] - -#### Returns - -`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +## Parameters -### isGenerating +### executorchModuleConfiguration -> **isGenerating**: `boolean` +[`ExecutorchModuleProps`](../interfaces/ExecutorchModuleProps.md) -Indicates whether the model is currently generating a response. +Configuration object containing `modelSource` and optional `preventLoad` flag. -### isReady +## Returns -> **isReady**: `boolean` +[`ExecutorchModuleType`](../interfaces/ExecutorchModuleType.md) -Indicates whether the model is ready. +Ready to use Executorch module. diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md index 229e5cf71..3ab4c79f6 100644 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -1,17 +1,23 @@ # Function: useImageEmbeddings() -> **useImageEmbeddings**(`__namedParameters`): `object` +> **useImageEmbeddings**(`ImageEmbeddingsConfiguration`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L11) + +React hook for managing an Image Embeddings model instance. ## Parameters -### \_\_namedParameters +### ImageEmbeddingsConfiguration + +[`ImageEmbeddingsProps`](../interfaces/ImageEmbeddingsProps.md) -`Props` +Configuration object containing `model` source and optional `preventLoad` flag. ## Returns +Ready to use Image Embeddings model. + ### downloadProgress > **downloadProgress**: `number` diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md index 98408b2ea..69e0fa6c1 100644 --- a/docs/docs/06-api-reference/functions/useImageSegmentation.md +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -1,51 +1,21 @@ # Function: useImageSegmentation() -> **useImageSegmentation**(`__namedParameters`): `object` +> **useImageSegmentation**(`ImageSegmentationConfiguration`): [`ImageSegmentationType`](../interfaces/ImageSegmentationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L11) -## Parameters - -### \_\_namedParameters - -`Props` - -## Returns - -### downloadProgress - -> **downloadProgress**: `number` - -Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +React hook for managing an Image Segmentation model instance. -Contains the error message if the model failed to load. - -### forward() - -> **forward**: (...`input`) => `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> - -#### Parameters - -##### input - -...\[`string`, [`DeeplabLabel`](../enumerations/DeeplabLabel.md)[], `boolean`\] - -#### Returns - -`Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> +## Parameters -### isGenerating +### ImageSegmentationConfiguration -> **isGenerating**: `boolean` +[`ImageSegmentationProps`](../interfaces/ImageSegmentationProps.md) -Indicates whether the model is currently generating a response. +Configuration object containing `model` source and optional `preventLoad` flag. -### isReady +## Returns -> **isReady**: `boolean` +[`ImageSegmentationType`](../interfaces/ImageSegmentationType.md) -Indicates whether the model is ready. +Ready to use Image Segmentation model. diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md index fe422974b..eebaddcf4 100644 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -2,7 +2,7 @@ > **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L20) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L20) React hook for managing a Large Language Model (LLM) instance. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md index b3837e2da..2655135d3 100644 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -2,7 +2,7 @@ > **useOCR**(`__namedParameters`): `OCRModule` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L15) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md index 5211bc17b..6d83789f6 100644 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -1,51 +1,21 @@ # Function: useObjectDetection() -> **useObjectDetection**(`__namedParameters`): `object` +> **useObjectDetection**(`ObjectDetectionConfiguration`): [`ObjectDetectionType`](../interfaces/ObjectDetectionType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L11) -## Parameters - -### \_\_namedParameters - -`Props` - -## Returns - -### downloadProgress - -> **downloadProgress**: `number` - -Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +React hook for managing an Object Detection model instance. -Contains the error message if the model failed to load. - -### forward() - -> **forward**: (...`input`) => `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> - -#### Parameters - -##### input - -...\[`string`, `number`\] - -#### Returns - -`Promise`\<[`Detection`](../interfaces/Detection.md)[]\> +## Parameters -### isGenerating +### ObjectDetectionConfiguration -> **isGenerating**: `boolean` +[`ObjectDetectionProps`](../interfaces/ObjectDetectionProps.md) -Indicates whether the model is currently generating a response. +Configuration object containing `model` source and optional `preventLoad` flag. -### isReady +## Returns -> **isReady**: `boolean` +[`ObjectDetectionType`](../interfaces/ObjectDetectionType.md) -Indicates whether the model is ready. +Ready to use Object Detection model. diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md index e1c259d99..4075be2da 100644 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -2,7 +2,7 @@ > **useSpeechToText**(`speechToTextConfiguration`): [`SpeechToTextType`](../interfaces/SpeechToTextType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) React hook for managing a Speech to Text (STT) instance. diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md index f50e20148..e381b0ca5 100644 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -2,7 +2,7 @@ > **useStyleTransfer**(`__namedParameters`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L10) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md index 881108c95..d2e15de71 100644 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -2,7 +2,7 @@ > **useTextEmbeddings**(`TextEmbeddingsConfiguration`): [`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) React hook for managing a Text Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md index 357a72f9f..a0b097b4a 100644 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -2,7 +2,7 @@ > **useTextToImage**(`__namedParameters`): `TextToImageType` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L21) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L21) ## Parameters diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md index db0a02062..5264e655d 100644 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -1,8 +1,8 @@ # Function: useTextToSpeech() -> **useTextToSpeech**(`TextToSpeechConfiguration`): `object` +> **useTextToSpeech**(`TextToSpeechConfiguration`): [`TextToSpeechType`](../interfaces/TextToSpeechType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L22) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:18](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L18) React hook for managing Text to Speech instance. @@ -10,64 +10,12 @@ React hook for managing Text to Speech instance. ### TextToSpeechConfiguration -`Props` +[`TextToSpeechProps`](../interfaces/TextToSpeechProps.md) Configuration object containing `model` source, `voice` and optional `preventLoad`. ## Returns -`object` +[`TextToSpeechType`](../interfaces/TextToSpeechType.md) Ready to use Text to Speech model. - -### downloadProgress - -> **downloadProgress**: `number` - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` - -### forward() - -> **forward**: (`input`) => `Promise`\<`any`\> - -#### Parameters - -##### input - -[`TextToSpeechInput`](../interfaces/TextToSpeechInput.md) - -#### Returns - -`Promise`\<`any`\> - -### isGenerating - -> **isGenerating**: `boolean` - -### isReady - -> **isReady**: `boolean` - -### stream() - -> **stream**: (`input`) => `Promise`\<`void`\> - -#### Parameters - -##### input - -[`TextToSpeechStreamingInput`](../interfaces/TextToSpeechStreamingInput.md) - -#### Returns - -`Promise`\<`void`\> - -### streamStop() - -> **streamStop**: () => `void` = `moduleInstance.streamStop` - -#### Returns - -`void` diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md index 75f947a7e..ef4b940ed 100644 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -2,7 +2,7 @@ > **useTokenizer**(`tokenizerConfiguration`): [`TokenizerType`](../interfaces/TokenizerType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) React hook for managing a Tokenizer instance. diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md index dcda74702..bc0bebf8c 100644 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -2,7 +2,7 @@ > **useVAD**(`VADConfiguration`): [`VADType`](../interfaces/VADType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) React hook for managing a VAD model instance. diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md index 05eb2508c..72d1ba83a 100644 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -2,7 +2,7 @@ > **useVerticalOCR**(`__namedParameters`): `OCRModule` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L15) ## Parameters diff --git a/docs/docs/06-api-reference/index.md b/docs/docs/06-api-reference/index.md index ff492a1b7..cf0eced8c 100644 --- a/docs/docs/06-api-reference/index.md +++ b/docs/docs/06-api-reference/index.md @@ -2,6 +2,7 @@ ## Enumerations +- [CocoLabel](enumerations/CocoLabel.md) - [DeeplabLabel](enumerations/DeeplabLabel.md) - [RnExecutorchErrorCode](enumerations/RnExecutorchErrorCode.md) - [ScalarType](enumerations/ScalarType.md) @@ -29,15 +30,25 @@ - [Bbox](interfaces/Bbox.md) - [ChatConfig](interfaces/ChatConfig.md) +- [ClassificationProps](interfaces/ClassificationProps.md) +- [ClassificationType](interfaces/ClassificationType.md) - [DecodingOptions](interfaces/DecodingOptions.md) - [Detection](interfaces/Detection.md) +- [ExecutorchModuleProps](interfaces/ExecutorchModuleProps.md) +- [ExecutorchModuleType](interfaces/ExecutorchModuleType.md) - [GenerationConfig](interfaces/GenerationConfig.md) +- [ImageEmbeddingsProps](interfaces/ImageEmbeddingsProps.md) +- [ImageEmbeddingsType](interfaces/ImageEmbeddingsType.md) +- [ImageSegmentationProps](interfaces/ImageSegmentationProps.md) +- [ImageSegmentationType](interfaces/ImageSegmentationType.md) - [KokoroConfig](interfaces/KokoroConfig.md) - [KokoroVoiceExtras](interfaces/KokoroVoiceExtras.md) - [LLMType](interfaces/LLMType.md) - [Message](interfaces/Message.md) -- [OCRBbox](interfaces/OCRBbox.md) +- [ObjectDetectionProps](interfaces/ObjectDetectionProps.md) +- [ObjectDetectionType](interfaces/ObjectDetectionType.md) - [OCRDetection](interfaces/OCRDetection.md) +- [Point](interfaces/Point.md) - [Segment](interfaces/Segment.md) - [SpeechToTextModelConfig](interfaces/SpeechToTextModelConfig.md) - [SpeechToTextType](interfaces/SpeechToTextType.md) @@ -46,7 +57,9 @@ - [TextEmbeddingsType](interfaces/TextEmbeddingsType.md) - [TextToSpeechConfig](interfaces/TextToSpeechConfig.md) - [TextToSpeechInput](interfaces/TextToSpeechInput.md) +- [TextToSpeechProps](interfaces/TextToSpeechProps.md) - [TextToSpeechStreamingInput](interfaces/TextToSpeechStreamingInput.md) +- [TextToSpeechType](interfaces/TextToSpeechType.md) - [TokenizerType](interfaces/TokenizerType.md) - [ToolCall](interfaces/ToolCall.md) - [ToolsConfig](interfaces/ToolsConfig.md) diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md index c07e5c2a2..321210463 100644 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -1,6 +1,8 @@ # Interface: Bbox -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L1) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L12) + +Represents a bounding box for a detected object in an image. ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:1](ht > **x1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L2) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L13) + +The x-coordinate of the bottom-left corner of the bounding box. *** @@ -16,7 +20,9 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:2](ht > **x2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L3) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L14) + +The x-coordinate of the top-right corner of the bounding box. *** @@ -24,7 +30,9 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:3](ht > **y1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L4) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L15) + +The y-coordinate of the bottom-left corner of the bounding box. *** @@ -32,4 +40,6 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:4](ht > **y2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L5) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L16) + +The y-coordinate of the top-right corner of the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md index c29722b1f..cfd2eaf89 100644 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -1,6 +1,6 @@ # Interface: ChatConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L154) +Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L154) Object configuring chat management. @@ -10,7 +10,7 @@ Object configuring chat management. > **contextWindowLength**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:163](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L163) +Defined in: [packages/react-native-executorch/src/types/llm.ts:163](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L163) The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. @@ -20,7 +20,7 @@ The number of messages from the current conversation that the model will use to > **initialMessageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:158](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L158) +Defined in: [packages/react-native-executorch/src/types/llm.ts:158](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L158) An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. @@ -30,6 +30,6 @@ An array of `Message` objects that represent the conversation history. This can > **systemPrompt**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L168) +Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L168) Often used to tell the model what is its purpose, for example - "Be a helpful translator". diff --git a/docs/docs/06-api-reference/interfaces/ClassificationProps.md b/docs/docs/06-api-reference/interfaces/ClassificationProps.md new file mode 100644 index 000000000..3a91f5eff --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ClassificationProps.md @@ -0,0 +1,29 @@ +# Interface: ClassificationProps + +Defined in: packages/react-native-executorch/src/types/classification.ts:11 + +Props for the `useClassification` hook. + +## Properties + +### model + +> **model**: `object` + +Defined in: packages/react-native-executorch/src/types/classification.ts:12 + +An object containing the model source. + +#### modelSource + +> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: packages/react-native-executorch/src/types/classification.ts:13 + +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 new file mode 100644 index 000000000..75d80f324 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ClassificationType.md @@ -0,0 +1,74 @@ +# Interface: ClassificationType + +Defined in: packages/react-native-executorch/src/types/classification.ts:20 + +Return type for the `useClassification` hook. +Manages the state and operations for Computer Vision image classification. + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: packages/react-native-executorch/src/types/classification.ts:39 + +Represents the download progress of the model binary as a value between 0 and 1. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: packages/react-native-executorch/src/types/classification.ts:24 + +Contains the error object if the model failed to load, download, or encountered a runtime error during classification. + +*** + +### forward() + +> **forward**: (`imageSource`) => `Promise`\<\{\[`category`: `string`\]: `number`; \}\> + +Defined in: packages/react-native-executorch/src/types/classification.ts:47 + +Executes the model's forward pass to classify the provided image. + +#### Parameters + +##### imageSource + +`string` + +A string representing the image source (e.g., a file path, URI, or base64 string) to be classified. + +#### Returns + +`Promise`\<\{\[`category`: `string`\]: `number`; \}\> + +A Promise that resolves to the classification result (typically containing labels and confidence scores). + +#### Throws + +If the model is not loaded or is currently processing another image. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: packages/react-native-executorch/src/types/classification.ts:34 + +Indicates whether the model is currently processing an image. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: packages/react-native-executorch/src/types/classification.ts:29 + +Indicates whether the classification model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md index b552b288b..82c033f68 100644 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -1,6 +1,6 @@ # Interface: DecodingOptions -Defined in: [packages/react-native-executorch/src/types/stt.ts:167](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L167) +Defined in: [packages/react-native-executorch/src/types/stt.ts:167](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L167) Options for decoding speech to text. @@ -10,6 +10,6 @@ Options for decoding speech to text. > `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:171](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L171) +Defined in: [packages/react-native-executorch/src/types/stt.ts:171](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L171) Optional language code to guide the transcription. diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md index 8cbeb321a..844a3a605 100644 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -1,6 +1,8 @@ # Interface: Detection -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L8) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L26) + +Represents a detected object within an image, including its bounding box, label, and confidence score. ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:8](ht > **bbox**: [`Bbox`](Bbox.md) -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L9) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L27) + +The bounding box of the detected object, defined by its top-left (x1, y1) and bottom-right (x2, y2) coordinates. *** @@ -16,7 +20,9 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:9](ht > **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L10) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L28) + +The class label of the detected object, represented as a key from the `CocoLabel` enum. *** @@ -24,4 +30,6 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:10](h > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/objectDetection.ts#L11) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L29) + +The confidence score of the detection, typically ranging from 0 to 1. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md new file mode 100644 index 000000000..d7b5cd966 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md @@ -0,0 +1,25 @@ +# Interface: ExecutorchModuleProps + +Defined in: packages/react-native-executorch/src/types/executorchModule.ts:10 + +Props for the `useExecutorchModule` hook. + +## Properties + +### modelSource + +> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Defined in: packages/react-native-executorch/src/types/executorchModule.ts:11 + +The source of the ExecuTorch model binary. + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: packages/react-native-executorch/src/types/executorchModule.ts:12 + +Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md new file mode 100644 index 000000000..bca85c568 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md @@ -0,0 +1,74 @@ +# Interface: ExecutorchModuleType + +Defined in: packages/react-native-executorch/src/types/executorchModule.ts:19 + +Return type for the `useExecutorchModule` hook. +Manages the state and core execution methods for a general ExecuTorch model. + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: packages/react-native-executorch/src/types/executorchModule.ts:38 + +Represents the download progress of the model binary as a value between 0 and 1. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: packages/react-native-executorch/src/types/executorchModule.ts:23 + +Contains the error object if the model failed to load, download, or encountered a runtime error. + +*** + +### forward() + +> **forward**: (`inputTensor`) => `Promise`\<[`TensorPtr`](TensorPtr.md)[]\> + +Defined in: packages/react-native-executorch/src/types/executorchModule.ts:46 + +Executes the model's forward pass with the provided input tensors. + +#### Parameters + +##### inputTensor + +[`TensorPtr`](TensorPtr.md)[] + +An array of `TensorPtr` objects representing the input tensors required by the model. + +#### Returns + +`Promise`\<[`TensorPtr`](TensorPtr.md)[]\> + +A Promise that resolves to an array of output `TensorPtr` objects resulting from the model's inference. + +#### Throws + +If the model is not loaded or is currently processing another request. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: packages/react-native-executorch/src/types/executorchModule.ts:33 + +Indicates whether the model is currently processing a forward pass. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: packages/react-native-executorch/src/types/executorchModule.ts:28 + +Indicates whether the ExecuTorch model binary has successfully loaded into memory and is ready for inference. diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md index 76214ff42..5558956d2 100644 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -1,6 +1,6 @@ # Interface: GenerationConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:194](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L194) +Defined in: [packages/react-native-executorch/src/types/llm.ts:194](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L194) Object configuring generation settings. @@ -10,7 +10,7 @@ Object configuring generation settings. > `optional` **batchTimeInterval**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:213](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L213) +Defined in: [packages/react-native-executorch/src/types/llm.ts:213](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L213) Upper limit on the time interval between consecutive token batches. @@ -20,7 +20,7 @@ Upper limit on the time interval between consecutive token batches. > `optional` **outputTokenBatchSize**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:208](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L208) +Defined in: [packages/react-native-executorch/src/types/llm.ts:208](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L208) Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). @@ -30,7 +30,7 @@ Soft upper limit on the number of tokens in each token batch (in certain cases t > `optional` **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L198) +Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L198) Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. @@ -40,6 +40,6 @@ Scales output logits by the inverse of temperature. Controls the randomness / cr > `optional` **topp**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:203](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L203) +Defined in: [packages/react-native-executorch/src/types/llm.ts:203](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L203) Only samples from the smallest set of tokens whose cumulative probability exceeds topp. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md new file mode 100644 index 000000000..82a637b1e --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md @@ -0,0 +1,29 @@ +# Interface: ImageEmbeddingsProps + +Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:11 + +Props for the `useImageEmbeddings` hook. + +## Properties + +### model + +> **model**: `object` + +Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:12 + +An object containing the model source. + +#### modelSource + +> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:13 + +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 new file mode 100644 index 000000000..22b9cc74b --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md @@ -0,0 +1,74 @@ +# Interface: ImageEmbeddingsType + +Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:20 + +Return type for the `useImageEmbeddings` hook. +Manages the state and operations for generating image embeddings (feature vectors) used in Computer Vision tasks. + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:39 + +Represents the download progress of the model binary as a value between 0 and 1. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:24 + +Contains the error object if the model failed to load, download, or encountered a runtime error during embedding generation. + +*** + +### forward() + +> **forward**: (`imageSource`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:47 + +Executes the model's forward pass to generate embeddings (a feature vector) for the provided image. + +#### Parameters + +##### imageSource + +`string` + +A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +A Promise that resolves to a `Float32Array` containing the generated embedding vector. + +#### Throws + +If the model is not loaded or is currently processing another image. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:34 + +Indicates whether the model is currently generating embeddings for an image. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:29 + +Indicates whether the image embeddings model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md new file mode 100644 index 000000000..9e51f966f --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md @@ -0,0 +1,29 @@ +# Interface: ImageSegmentationProps + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:37](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L37) + +Props for the `useImageSegmentation` hook. + +## Properties + +### model + +> **model**: `object` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L38) + +An object containing the model source. + +#### modelSource + +> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:39](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L39) + +Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md new file mode 100644 index 000000000..951e05de3 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md @@ -0,0 +1,86 @@ +# Interface: ImageSegmentationType + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L46) + +Return type for the `useImageSegmentation` hook. +Manages the state and operations for Computer Vision image segmentation (e.g., DeepLab). + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:65](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L65) + +Represents the download progress of the model binary as a value between 0 and 1. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:50](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L50) + +Contains the error object if the model failed to load, download, or encountered a runtime error during segmentation. + +*** + +### forward() + +> **forward**: (`imageSource`, `classesOfInterest?`, `resize?`) => `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:75](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L75) + +Executes the model's forward pass to perform semantic segmentation on the provided image. + +#### Parameters + +##### imageSource + +`string` + +A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. + +##### classesOfInterest? + +[`DeeplabLabel`](../enumerations/DeeplabLabel.md)[] + +An optional array of `DeeplabLabel` enums. If provided, the model will only return segmentation masks for these specific classes. + +##### resize? + +`boolean` + +An optional boolean indicating whether the output segmentation masks should be resized to match the original image dimensions. Defaults to standard model behavior if undefined. + +#### Returns + +`Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> + +A Promise that resolves to an object mapping each detected `DeeplabLabel` to its corresponding segmentation mask (represented as a flattened array of numbers). + +#### Throws + +If the model is not loaded or is currently processing another image. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L60) + +Indicates whether the model is currently processing an image. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:55](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L55) + +Indicates whether the segmentation model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/KokoroConfig.md b/docs/docs/06-api-reference/interfaces/KokoroConfig.md index df69cba00..fef23c156 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroConfig.md +++ b/docs/docs/06-api-reference/interfaces/KokoroConfig.md @@ -1,6 +1,6 @@ # Interface: KokoroConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:33](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L33) +Defined in: [packages/react-native-executorch/src/types/tts.ts:34](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L34) Kokoro model configuration. Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. @@ -11,7 +11,7 @@ Only the core Kokoro model sources, as phonemizer sources are included in voice > **durationPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:35](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L35) +Defined in: [packages/react-native-executorch/src/types/tts.ts:36](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L36) *** @@ -19,7 +19,7 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:35](https://githu > **synthesizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:36](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L36) +Defined in: [packages/react-native-executorch/src/types/tts.ts:37](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L37) *** @@ -27,4 +27,4 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:36](https://githu > **type**: `"kokoro"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:34](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L34) +Defined in: [packages/react-native-executorch/src/types/tts.ts:35](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L35) diff --git a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md index d1d8da2fa..a5185ae5e 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md +++ b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md @@ -1,6 +1,6 @@ # Interface: KokoroVoiceExtras -Defined in: [packages/react-native-executorch/src/types/tts.ts:24](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L24) +Defined in: [packages/react-native-executorch/src/types/tts.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L25) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:24](https://githu > **lexiconSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L26) +Defined in: [packages/react-native-executorch/src/types/tts.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L27) *** @@ -16,4 +16,4 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:26](https://githu > **taggerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L25) +Defined in: [packages/react-native-executorch/src/types/tts.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L26) diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md index c503dc47f..1b9ebc1b3 100644 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -1,6 +1,6 @@ # Interface: LLMType -Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L6) +Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L6) React hook for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ React hook for managing a Large Language Model (LLM) instance. > **configure**: (`configuration`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L48) +Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L48) Configures chat and tool calling. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -69,7 +69,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > **deleteMessage**: (`index`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L114) +Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L114) Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. @@ -91,7 +91,7 @@ The index of the message to delete from history. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L35) +Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L35) Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. @@ -101,7 +101,7 @@ Represents the download progress as a value between 0 and 1, indicating the exte > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L40) +Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L40) Contains the error message if the model failed to load. @@ -111,7 +111,7 @@ Contains the error message if the model failed to load. > **generate**: (`messages`, `tools?`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:100](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L100) +Defined in: [packages/react-native-executorch/src/types/llm.ts:100](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L100) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -139,7 +139,7 @@ Optional array of tools that can be used during generation. > **getGeneratedTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L93) +Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L93) Returns the number of tokens generated so far in the current generation. @@ -155,7 +155,7 @@ The count of generated tokens. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:119](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L119) +Defined in: [packages/react-native-executorch/src/types/llm.ts:119](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L119) Function to interrupt the current inference. @@ -169,7 +169,7 @@ Function to interrupt the current inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L30) +Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L30) Indicates whether the model is currently generating a response. @@ -179,7 +179,7 @@ Indicates whether the model is currently generating a response. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L25) +Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L25) Indicates whether the model is ready. @@ -189,7 +189,7 @@ Indicates whether the model is ready. > **messageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L10) +Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L10) History containing all messages in conversation. This field is updated after model responds to sendMessage. @@ -199,7 +199,7 @@ History containing all messages in conversation. This field is updated after mod > **response**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L15) +Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L15) State of the generated response. This field is updated with each token generated by the model. @@ -209,7 +209,7 @@ State of the generated response. This field is updated with each token generated > **sendMessage**: (`message`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:107](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L107) +Defined in: [packages/react-native-executorch/src/types/llm.ts:107](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L107) Function to add user message to conversation. After model responds, `messageHistory` will be updated with both user message and model response. @@ -232,6 +232,6 @@ The message string to send. > **token**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L20) +Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L20) The most recently generated token. diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md index b6f6ee191..c9f41e77e 100644 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -1,6 +1,6 @@ # Interface: Message -Defined in: [packages/react-native-executorch/src/types/llm.ts:130](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L130) +Defined in: [packages/react-native-executorch/src/types/llm.ts:130](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L130) Represents a message in the conversation. @@ -10,7 +10,7 @@ Represents a message in the conversation. > **content**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:139](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L139) +Defined in: [packages/react-native-executorch/src/types/llm.ts:139](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L139) Content of the message. @@ -20,6 +20,6 @@ Content of the message. > **role**: [`MessageRole`](../type-aliases/MessageRole.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:134](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L134) +Defined in: [packages/react-native-executorch/src/types/llm.ts:134](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L134) Role of the message sender of type `MessageRole`. diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md index 46aaa0842..2694b24c2 100644 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -1,14 +1,14 @@ # Interface: OCRDetection -Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L3) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L3) ## Properties ### bbox -> **bbox**: [`OCRBbox`](OCRBbox.md)[] +> **bbox**: [`Point`](Point.md)[] -Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L4) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L4) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L6) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L6) *** @@ -24,4 +24,4 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:5](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L5) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L5) diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md new file mode 100644 index 000000000..c67b3077d --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md @@ -0,0 +1,29 @@ +# Interface: ObjectDetectionProps + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:135](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L135) + +Props for the `useObjectDetection` hook. + +## Properties + +### model + +> **model**: `object` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:136](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L136) + +An object containing the model source. + +#### modelSource + +> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:137](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L137) + +Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md new file mode 100644 index 000000000..baa51b37f --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md @@ -0,0 +1,80 @@ +# Interface: ObjectDetectionType + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:144](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L144) + +Return type for the `useObjectDetection` hook. +Manages the state and operations for Computer Vision object detection tasks. + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:163](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L163) + +Represents the download progress of the model binary as a value between 0 and 1. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:148](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L148) + +Contains the error object if the model failed to load, download, or encountered a runtime error during detection. + +*** + +### forward() + +> **forward**: (`imageSource`, `detectionThreshold?`) => `Promise`\<[`Detection`](Detection.md)[]\> + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:172](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L172) + +Executes the model's forward pass to detect objects within the provided image. + +#### Parameters + +##### imageSource + +`string` + +A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. + +##### detectionThreshold? + +`number` + +An optional number between 0 and 1 representing the minimum confidence score required for an object to be included in the results. Dafault is 0.7. + +#### Returns + +`Promise`\<[`Detection`](Detection.md)[]\> + +A Promise that resolves to an array of `Detection` objects, where each object typically contains bounding box coordinates, a class label, and a confidence score. + +#### Throws + +If the model is not loaded or is currently processing another image. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:158](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L158) + +Indicates whether the model is currently processing an image. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:153](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L153) + +Indicates whether the object detection model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/OCRBbox.md b/docs/docs/06-api-reference/interfaces/Point.md similarity index 72% rename from docs/docs/06-api-reference/interfaces/OCRBbox.md rename to docs/docs/06-api-reference/interfaces/Point.md index 166ec0d95..527fac294 100644 --- a/docs/docs/06-api-reference/interfaces/OCRBbox.md +++ b/docs/docs/06-api-reference/interfaces/Point.md @@ -1,6 +1,6 @@ -# Interface: OCRBbox +# Interface: Point -Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L9) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L9) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github > **x**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L10) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L10) *** @@ -16,4 +16,4 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://githu > **y**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L11) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L11) diff --git a/docs/docs/06-api-reference/interfaces/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index 49c011825..14ff242e8 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,6 @@ # Interface: Segment -Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L22) +Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L22) Represents a detected audio segment with start and end timestamps. @@ -10,7 +10,7 @@ Represents a detected audio segment with start and end timestamps. > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:31](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L31) +Defined in: [packages/react-native-executorch/src/types/vad.ts:31](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L31) End time of the segment in seconds. @@ -20,6 +20,6 @@ End time of the segment in seconds. > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L26) +Defined in: [packages/react-native-executorch/src/types/vad.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L26) Start time of the segment in seconds. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md index 570c312a4..2be4723ac 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextModelConfig -Defined in: [packages/react-native-executorch/src/types/stt.ts:177](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L177) +Defined in: [packages/react-native-executorch/src/types/stt.ts:177](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L177) Configuration for Speech to Text model. @@ -10,7 +10,7 @@ Configuration for Speech to Text model. > **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:191](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L191) +Defined in: [packages/react-native-executorch/src/types/stt.ts:191](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L191) A string that specifies the location of a `.pte` file for the decoder. @@ -20,7 +20,7 @@ A string that specifies the location of a `.pte` file for the decoder. > **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:186](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L186) +Defined in: [packages/react-native-executorch/src/types/stt.ts:186](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L186) A string that specifies the location of a `.pte` file for the encoder. @@ -30,7 +30,7 @@ A string that specifies the location of a `.pte` file for the encoder. > **isMultilingual**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:181](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L181) +Defined in: [packages/react-native-executorch/src/types/stt.ts:181](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L181) A boolean flag indicating whether the model supports multiple languages. @@ -40,6 +40,6 @@ A boolean flag indicating whether the model supports multiple languages. > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:196](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L196) +Defined in: [packages/react-native-executorch/src/types/stt.ts:196](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L196) A string that specifies the location to the tokenizer for the model. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md index 3744ff639..f8d03cd79 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextType -Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L7) +Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L7) React hook for managing Speech to Text (STT) instance. @@ -10,7 +10,7 @@ React hook for managing Speech to Text (STT) instance. > **committedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L32) +Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L32) Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. @@ -21,7 +21,7 @@ Useful for displaying stable results during streaming. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L26) +Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L26) Tracks the progress of the model download process. @@ -31,7 +31,7 @@ Tracks the progress of the model download process. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L11) +Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L11) Contains the error message if the model failed to load. @@ -41,7 +41,7 @@ Contains the error message if the model failed to load. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L21) +Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L21) Indicates whether the model is currently processing an inference. @@ -51,7 +51,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L16) +Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L16) Indicates whether the model has successfully loaded and is ready for inference. @@ -61,7 +61,7 @@ Indicates whether the model has successfully loaded and is ready for inference. > **nonCommittedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L38) +Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L38) Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. @@ -72,7 +72,7 @@ Useful for displaying live, partial results during streaming. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L53) +Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L53) Runs the decoder of the model. Passing `number[]` is deprecated. @@ -102,7 +102,7 @@ A promise resolving to the decoded text. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L45) +Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L45) Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. @@ -126,7 +126,7 @@ A promise resolving to the encoded data. > **stream**(`options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L71) +Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L71) Starts a streaming transcription process. Use in combination with streamInsert to feed audio chunks and streamStop to end the stream. @@ -152,7 +152,7 @@ The final transcription string. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L78) +Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L78) Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Passing `number[]` is deprecated. @@ -175,7 +175,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L83) +Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L83) Stops the ongoing streaming transcription process. @@ -189,7 +189,7 @@ Stops the ongoing streaming transcription process. > **transcribe**(`waveform`, `options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L62) +Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L62) Starts a transcription process for a given input array, which should be a waveform at 16kHz. Passing `number[]` is deprecated. diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md index 73bdb0eeb..2299da15e 100644 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -1,6 +1,6 @@ # Interface: TensorPtr -Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L51) +Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L51) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://gi > **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L52) +Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L52) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://gi > **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L54) +Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L54) *** @@ -24,4 +24,4 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://gi > **sizes**: `number`[] -Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L53) +Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L53) diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md index f1c81483e..4a1aba11f 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L39) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:40](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L40) Props for the useTextEmbeddings hook. @@ -10,7 +10,7 @@ Props for the useTextEmbeddings hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:40](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L40) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:41](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L41) #### modelSource @@ -30,6 +30,6 @@ Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:40](ht > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:55](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L55) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:56](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L56) 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 93eeb4ae4..1ba529aee 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) React hook state and methods for managing a Text Embeddings model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Text Embeddings model instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) Tracks the progress of the model download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the model download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) Contains the error message if the model failed to load or during inference. @@ -30,7 +30,7 @@ Contains the error message if the model failed to load or during inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) Indicates whether the model is currently generating embeddings. @@ -40,7 +40,7 @@ Indicates whether the model is currently generating embeddings. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) Indicates whether the embeddings model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the embeddings model has successfully loaded and is ready for > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:33](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/textEmbeddings.ts#L33) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) Runs the text embeddings model on the provided input string. * @@ -68,3 +68,7 @@ The text string to embed. `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> A promise resolving to a Float32Array containing the vector embeddings. + +#### Throws + +If the model is not loaded or is currently processing another request. diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md index f3bb780af..5e843276f 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md @@ -1,16 +1,20 @@ # Interface: TextToSpeechConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:46](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tts.ts:47](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L47) General Text to Speech module configuration +## Extended by + +- [`TextToSpeechProps`](TextToSpeechProps.md) + ## Properties ### model > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:47](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L47) +Defined in: [packages/react-native-executorch/src/types/tts.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L48) a selected T2S model @@ -20,6 +24,6 @@ a selected T2S model > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:48](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L48) +Defined in: [packages/react-native-executorch/src/types/tts.ts:49](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L49) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md index 07d201433..07980c579 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L57) +Defined in: [packages/react-native-executorch/src/types/tts.ts:69](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L69) Text to Speech module input definition @@ -14,7 +14,7 @@ Text to Speech module input definition > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:59](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L59) +Defined in: [packages/react-native-executorch/src/types/tts.ts:71](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L71) optional speed argument - the higher it is, the faster the speech becomes @@ -24,6 +24,6 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L58) +Defined in: [packages/react-native-executorch/src/types/tts.ts:70](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L70) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md new file mode 100644 index 000000000..237630003 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md @@ -0,0 +1,47 @@ +# Interface: TextToSpeechProps + +Defined in: [packages/react-native-executorch/src/types/tts.ts:59](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L59) + +Props for the useTextToSpeech hook. + +## Extends + +- [`TextToSpeechConfig`](TextToSpeechConfig.md) + +## Properties + +### model + +> **model**: [`KokoroConfig`](KokoroConfig.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L48) + +a selected T2S model + +#### Inherited from + +[`TextToSpeechConfig`](TextToSpeechConfig.md).[`model`](TextToSpeechConfig.md#model) + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L60) + +Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. + +*** + +### voice + +> **voice**: [`VoiceConfig`](VoiceConfig.md) + +Defined in: [packages/react-native-executorch/src/types/tts.ts:49](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L49) + +a selected speaker's voice + +#### Inherited from + +[`TextToSpeechConfig`](TextToSpeechConfig.md).[`voice`](TextToSpeechConfig.md#voice) diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md index 7eea46d4a..fd2e1b572 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechStreamingInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:73](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L73) +Defined in: [packages/react-native-executorch/src/types/tts.ts:133](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L133) Text to Speech streaming input definition @@ -19,7 +19,7 @@ Callbacks can be both synchronous or asynchronous. > `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:74](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L74) +Defined in: [packages/react-native-executorch/src/types/tts.ts:134](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L134) Called when streaming begins @@ -33,7 +33,7 @@ Called when streaming begins > `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:76](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L76) +Defined in: [packages/react-native-executorch/src/types/tts.ts:136](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L136) Called when streaming ends @@ -47,7 +47,7 @@ Called when streaming ends > `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:75](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L75) +Defined in: [packages/react-native-executorch/src/types/tts.ts:135](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L135) Called after each audio chunk gets calculated. @@ -67,7 +67,7 @@ Called after each audio chunk gets calculated. > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:59](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L59) +Defined in: [packages/react-native-executorch/src/types/tts.ts:71](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L71) optional speed argument - the higher it is, the faster the speech becomes @@ -81,7 +81,7 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L58) +Defined in: [packages/react-native-executorch/src/types/tts.ts:70](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L70) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md new file mode 100644 index 000000000..4bae59bd6 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md @@ -0,0 +1,119 @@ +# Interface: TextToSpeechType + +Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L78) + +Return type for the `useTextToSpeech` hook. +Manages the state and operations for Text-to-Speech generation. + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:97](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L97) + +Represents the download progress of the model and voice assets as a value between 0 and 1. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:82](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L82) + +Contains the error object if the model failed to load or encountered an error during inference. + +*** + +### forward() + +> **forward**: (`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +Defined in: [packages/react-native-executorch/src/types/tts.ts:105](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L105) + +Runs the model to convert the provided text into speech audio in a single pass. +* + +#### Parameters + +##### input + +[`TextToSpeechInput`](TextToSpeechInput.md) + +The `TextToSpeechInput` object containing the `text` to synthesize and optional `speed`. + +#### Returns + +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> + +A Promise that resolves with the generated audio data (typically a `Float32Array`). + +#### Throws + +If the model is not loaded or is currently generating. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:92](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L92) + +Indicates whether the model is currently generating audio. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L87) + +Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. + +*** + +### stream() + +> **stream**: (`input`) => `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L114) + +Streams the generated audio data incrementally. +This is optimal for real-time playback, allowing audio to start playing before the full text is synthesized. +* + +#### Parameters + +##### input + +[`TextToSpeechStreamingInput`](TextToSpeechStreamingInput.md) + +The `TextToSpeechStreamingInput` object containing `text`, optional `speed`, and lifecycle callbacks (`onBegin`, `onNext`, `onEnd`). + +#### Returns + +`Promise`\<`void`\> + +A Promise that resolves when the streaming process is complete. + +#### Throws + +If the model is not loaded or is currently generating. + +*** + +### streamStop() + +> **streamStop**: () => `void` + +Defined in: [packages/react-native-executorch/src/types/tts.ts:119](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L119) + +Interrupts and stops the currently active audio generation stream. + +#### Returns + +`void` diff --git a/docs/docs/06-api-reference/interfaces/TokenizerType.md b/docs/docs/06-api-reference/interfaces/TokenizerType.md index 35374fe79..efcb6753e 100644 --- a/docs/docs/06-api-reference/interfaces/TokenizerType.md +++ b/docs/docs/06-api-reference/interfaces/TokenizerType.md @@ -1,6 +1,6 @@ # Interface: TokenizerType -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L6) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L6) React hook state and methods for managing a Tokenizer instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Tokenizer instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L25) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L25) Tracks the progress of the tokenizer download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the tokenizer download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L10) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L10) Contains the error message if the tokenizer failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the tokenizer failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L20) Indicates whether the tokenizer is currently processing data. @@ -40,7 +40,7 @@ Indicates whether the tokenizer is currently processing data. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L15) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L15) Indicates whether the tokenizer has successfully loaded and is ready for use. @@ -50,7 +50,7 @@ Indicates whether the tokenizer has successfully loaded and is ready for use. > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:32](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L32) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:32](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L32) Converts an array of token IDs into a string. @@ -78,7 +78,7 @@ A promise resolving to the decoded text string. > **encode**(`text`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L39) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L39) Converts a string into an array of token IDs. @@ -102,7 +102,7 @@ A promise resolving to an array `number[]` containing the encoded token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:45](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L45) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:45](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L45) Returns the size of the tokenizer's vocabulary. @@ -118,7 +118,7 @@ A promise resolving to the vocabulary size. > **idToToken**(`id`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:52](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L52) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:52](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L52) Returns the token associated to the ID. @@ -142,7 +142,7 @@ A promise resolving to the token string representation. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:59](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tokenizer.ts#L59) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:59](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L59) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md index 0a651c51e..c18b570c9 100644 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -1,6 +1,6 @@ # Interface: ToolCall -Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L142) +Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L142) ## Properties @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://gith > **arguments**: `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L144) +Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L144) *** @@ -16,4 +16,4 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://gith > **toolName**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L143) +Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L143) diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md index 92ec2d1f2..82c165a85 100644 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -1,6 +1,6 @@ # Interface: ToolsConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:174](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L174) +Defined in: [packages/react-native-executorch/src/types/llm.ts:174](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L174) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. @@ -10,7 +10,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > `optional` **displayToolCalls**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:188](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L188) +Defined in: [packages/react-native-executorch/src/types/llm.ts:188](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L188) If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. @@ -20,7 +20,7 @@ If set to true, JSON tool calls will be displayed in chat. If false, only answer > **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L183) +Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L183) Function that accepts `ToolCall`, executes tool and returns the string to model. @@ -40,6 +40,6 @@ Function that accepts `ToolCall`, executes tool and returns the string to model. > **tools**: `Object`[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:178](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L178) +Defined in: [packages/react-native-executorch/src/types/llm.ts:178](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L178) List of objects defining tools. diff --git a/docs/docs/06-api-reference/interfaces/VADProps.md b/docs/docs/06-api-reference/interfaces/VADProps.md index 6f86caf39..75df093ba 100644 --- a/docs/docs/06-api-reference/interfaces/VADProps.md +++ b/docs/docs/06-api-reference/interfaces/VADProps.md @@ -1,6 +1,6 @@ # Interface: VADProps -Defined in: [packages/react-native-executorch/src/types/vad.ts:7](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L7) +Defined in: [packages/react-native-executorch/src/types/vad.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L7) Props for the useVAD hook. @@ -10,7 +10,7 @@ Props for the useVAD hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L11) +Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L11) `ResourceSource` that specifies the location of the VAD model binary. @@ -24,6 +24,6 @@ Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://githu > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L16) +Defined in: [packages/react-native-executorch/src/types/vad.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L16) 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 6f36aba38..31b131fd7 100644 --- a/docs/docs/06-api-reference/interfaces/VADType.md +++ b/docs/docs/06-api-reference/interfaces/VADType.md @@ -1,6 +1,6 @@ # Interface: VADType -Defined in: [packages/react-native-executorch/src/types/vad.ts:37](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L37) +Defined in: [packages/react-native-executorch/src/types/vad.ts:37](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L37) React hook state and methods for managing a Voice Activity Detection (VAD) model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Voice Activity Detection (VAD) model > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:56](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L56) +Defined in: [packages/react-native-executorch/src/types/vad.ts:56](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L56) Represents the download progress as a value between 0 and 1. @@ -20,7 +20,7 @@ Represents the download progress as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/vad.ts:41](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L41) +Defined in: [packages/react-native-executorch/src/types/vad.ts:41](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L41) Contains the error message if the VAD model failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the VAD model failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:51](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L51) +Defined in: [packages/react-native-executorch/src/types/vad.ts:51](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L51) Indicates whether the model is currently processing an inference. @@ -40,7 +40,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:46](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L46) +Defined in: [packages/react-native-executorch/src/types/vad.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L46) Indicates whether the VAD model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the VAD model has successfully loaded and is ready for inferen > **forward**(`waveform`): `Promise`\<[`Segment`](Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/types/vad.ts:63](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/vad.ts#L63) +Defined in: [packages/react-native-executorch/src/types/vad.ts:64](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L64) Runs the Voice Activity Detection model on the provided audio waveform. @@ -67,3 +67,7 @@ The input audio waveform array. `Promise`\<[`Segment`](Segment.md)[]\> A promise resolving to an array of detected audio segments (e.g., timestamps for speech). + +#### Throws + +If the model is not loaded or is currently processing another request. diff --git a/docs/docs/06-api-reference/interfaces/VoiceConfig.md b/docs/docs/06-api-reference/interfaces/VoiceConfig.md index 4cf1f2a51..017184d22 100644 --- a/docs/docs/06-api-reference/interfaces/VoiceConfig.md +++ b/docs/docs/06-api-reference/interfaces/VoiceConfig.md @@ -1,6 +1,6 @@ # Interface: VoiceConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L17) +Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L18) Voice configuration @@ -12,7 +12,7 @@ So far in Kokoro, each voice is directly associated with a language. > `optional` **extra**: [`KokoroVoiceExtras`](KokoroVoiceExtras.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tts.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L21) an optional extra sources or properties related to specific voice @@ -22,7 +22,7 @@ an optional extra sources or properties related to specific voice > **lang**: [`TextToSpeechLanguage`](../type-aliases/TextToSpeechLanguage.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L18) +Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L19) speaker's language @@ -32,6 +32,6 @@ speaker's language > **voiceSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L19) +Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L20) a source to a binary file with voice embedding diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md index 4bb21536e..683613aee 100644 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -2,4 +2,4 @@ > **LLMTool** = `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:149](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L149) +Defined in: [packages/react-native-executorch/src/types/llm.ts:149](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L149) diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md index 6e20258b2..1e8220ec8 100644 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -2,6 +2,6 @@ > **MessageRole** = `"user"` \| `"assistant"` \| `"system"` -Defined in: [packages/react-native-executorch/src/types/llm.ts:125](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L125) +Defined in: [packages/react-native-executorch/src/types/llm.ts:125](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L125) Roles that a message sender can have. diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md index 2902e333d..c8a40bb4d 100644 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -2,4 +2,4 @@ > **OCRLanguage** = keyof *typeof* `symbols` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/ocr.ts#L14) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L14) diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md index 5c8679235..858dfb26b 100644 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -2,6 +2,6 @@ > **ResourceSource** = `string` \| `number` \| `object` -Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L8) +Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L8) Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md index 0130c56cc..551281453 100644 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -2,4 +2,4 @@ > **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/stt.ts#L87) +Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L87) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md index a401bf33b..2940e2aa4 100644 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -2,4 +2,4 @@ > **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` -Defined in: [packages/react-native-executorch/src/types/common.ts:38](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/common.ts#L38) +Defined in: [packages/react-native-executorch/src/types/common.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L38) diff --git a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md index 512f206b2..2f8050be3 100644 --- a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md @@ -2,4 +2,4 @@ > **TextToSpeechLanguage** = `"en-us"` \| `"en-gb"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:4](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/tts.ts#L4) +Defined in: [packages/react-native-executorch/src/types/tts.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L5) diff --git a/docs/docs/06-api-reference/typedoc-sidebar.cjs b/docs/docs/06-api-reference/typedoc-sidebar.cjs index 2e9f60cd2..943f2fb67 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:"Enumerations",items:[{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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/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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{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/LLMType",label:"LLMType"},{type:"doc",id:"06-api-reference/interfaces/Message",label:"Message"},{type:"doc",id:"06-api-reference/interfaces/OCRBbox",label:"OCRBbox"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextType",label:"SpeechToTextType"},{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/TextToSpeechConfig",label:"TextToSpeechConfig"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechInput",label:"TextToSpeechInput"},{type:"doc",id:"06-api-reference/interfaces/TextToSpeechStreamingInput",label:"TextToSpeechStreamingInput"},{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/VADProps",label:"VADProps"},{type:"doc",id:"06-api-reference/interfaces/VADType",label:"VADType"},{type:"doc",id:"06-api-reference/interfaces/VoiceConfig",label:"VoiceConfig"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_MEDIUM",label:"KOKORO_MEDIUM"},{type:"doc",id:"06-api-reference/variables/KOKORO_SMALL",label:"KOKORO_SMALL"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; +const typedocSidebar = {items:[{type:"category",label:"Enumerations",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/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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/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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleProps",label:"ExecutorchModuleProps"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleType",label:"ExecutorchModuleType"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsProps",label:"ImageEmbeddingsProps"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsType",label:"ImageEmbeddingsType"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationProps",label:"ImageSegmentationProps"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationType",label:"ImageSegmentationType"},{type:"doc",id:"06-api-reference/interfaces/KokoroConfig",label:"KokoroConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroVoiceExtras",label:"KokoroVoiceExtras"},{type:"doc",id:"06-api-reference/interfaces/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/Point",label:"Point"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextType",label:"SpeechToTextType"},{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/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/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/VADProps",label:"VADProps"},{type:"doc",id:"06-api-reference/interfaces/VADType",label:"VADType"},{type:"doc",id:"06-api-reference/interfaces/VoiceConfig",label:"VoiceConfig"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_MEDIUM",label:"KOKORO_MEDIUM"},{type:"doc",id:"06-api-reference/variables/KOKORO_SMALL",label:"KOKORO_SMALL"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; 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 53c2bf292..ea3e1f241 100644 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MINILM\_L6\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L408) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L408) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md index 3680a10c7..6d789c891 100644 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MPNET\_BASE\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L413) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L413) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md index 2c41ea483..4bb35969b 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_256**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L442) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L442) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index 064a1dab8..d8a42eb97 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_512**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L434) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L434) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index 0aac1cb50..b670b5a86 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_IMAGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md index 4104fdb53..21b34f37a 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_TEXT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L428) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L428) ## 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 53494f666..ae66b3c08 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: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L385) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L385) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md index 17bf9bcdb..04423c5f7 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_CHAT\_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md index 8ed33e234..f2441886f 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_CONTEXT\_WINDOW\_LENGTH**: `5` = `5` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md index 94b02c19f..e62a1ef36 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_MESSAGE\_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md index e97bfe73a..2bf615ee0 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_SYSTEM\_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) 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 6264f2d9e..c265c77bd 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -2,7 +2,7 @@ > `const` **EFFICIENTNET\_V2\_S**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L260) ## 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 bb9d2a12a..81bb4ffda 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -2,7 +2,7 @@ > `const` **FSMN\_VAD**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L453) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L453) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md index 7c376918e..c52b54822 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L108) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L108) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md index 5d70bd907..605b6837f 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L114) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L114) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md index 881c678b3..4f31c7385 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L120) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L120) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md index 9743569bc..8d88ee689 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L126) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L126) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md index 77b00c457..39624558f 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L132) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L132) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md index 545b55159..269c6b268 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L138) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L138) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md index fda14df2f..402e038d2 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_MEDIUM**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/models.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/models.ts#L22) A standard Kokoro instance which processes the text in batches of maximum 128 tokens. diff --git a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md index e96d87ed2..3c4969bdd 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/models.ts#L13) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/models.ts#L13) A Kokoro model instance which processes the text in batches of maximum 64 tokens. Uses significant less memory than the medium model, but could produce diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md index 4bde7f398..77a8fa408 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_HEART**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L21) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md index 8f1acc313..75c8033ab 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_RIVER**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L26) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L26) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md index 348d7651a..3e31e6ac2 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_SARAH**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L31) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L31) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md index 3dae4a2b8..234d52128 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_ADAM**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L36) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L36) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md index 7057a3928..775f0051a 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_MICHAEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L41) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md index 016e30267..364efda06 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_SANTA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L46) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md index 50dc26244..cc38520d8 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BF\_EMMA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L51) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L51) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md index 4c6902a90..317a7df41 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BM\_DANIEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/tts/voices.ts#L56) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L56) 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 af58310b3..ce0d7b6f5 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L34) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L34) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md index 70952dcec..add43e9bd 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L40) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L40) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md index 26feeba35..cba6c20f4 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L46) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md index 2cb21f7c3..bfd7085e1 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L16) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L16) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md index 97b9909f7..1df915d6b 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L22) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md index 111b6173d..a99e859c3 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L28) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L28) ## 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 9d6b2a4c4..d18090b17 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MINILM\_L6\_COS\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L418) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L418) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md index 014e31d21..0f91c1b9c 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MPNET\_BASE\_DOT\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md index d16e48efe..e69514a6c 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L41) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md index 9db4a5b42..bcf19a6f0 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L47) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L47) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md index e5031174a..5b12d4372 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L53) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L53) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md index 747be4950..0259f6c68 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L362) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L362) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md index 5185cef20..0adc8d192 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L59) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L59) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md index c14b5fe0d..cd6ca4ba5 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L65) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L65) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md index 0a4334aec..0d23f1d73 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L71) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L71) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md index 727b7f833..e098ba40e 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L83) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L83) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md index 0f4f043d3..55b5fe737 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L77) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L77) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md index 186547dec..937233380 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L98) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L98) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md index 5dedd846b..00f14ce9a 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L164) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L164) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md index e2557bacf..6eee7b2a7 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L104) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L104) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md index e9441aed4..acb5ca261 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L116) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L116) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md index f023eb886..7b7d47904 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L122) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L122) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md index f2d631c96..b032324bc 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L284) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md index 058c26817..c9f51a72e 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L134) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L134) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md index 1fb964a3e..76752459e 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L146) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L146) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md index b23d33f9f..33cd5e10a 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L152) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L152) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md index 8f31581a1..decb0bb49 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L128) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L128) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md index 51f161175..498689384 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L170) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L170) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md index 10afe8a5d..ac2ce5ee5 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L188) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L188) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md index cd0340792..d0f0709ec 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L176) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L176) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md index 970da0dec..fd4592a5d 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L182) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L182) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md index be097d512..6c6270d7d 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L158) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L158) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md index 2aa5f5a26..b5d8b5fbc 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L194) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L194) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md index 6b24bd9ce..4752bf061 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md index d1ab54490..e07a1a521 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md index 392d7fcf6..1edb948fc 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md index 751e90f0f..f0ff693c1 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md index 643b6a035..51fbe6eeb 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md index aa5bcfb7c..d02693c13 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L236) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L236) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md index 3a5da7d05..6e72c137f 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md index 9e184b5c4..733ccbb3a 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L254) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L254) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md index f6e718fa5..12d607555 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md index 642eba8b8..0cba62984 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md index fb9060852..d022ee7ef 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L272) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L272) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md index 0c18b7241..e64455bc9 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L278) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L278) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md index b550de3fb..e351bca5e 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L260) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md index 28c6d516e..66405c6a3 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L266) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L266) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md index 79578af62..9dfa309af 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L290) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L290) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md index 104840cc1..d9bb2565f 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L296) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L296) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md index bc2c74c70..8dc2d22a8 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L302) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md index 57926459b..a2681d235 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L308) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L308) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md index 073fd38c7..95bb68d21 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L314) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L314) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md index 0c801360a..5f70dda76 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L320) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L320) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md index 3127d15f7..c4474ff7b 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L326) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L326) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md index 1d50c1030..f3d259516 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L332) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L332) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md index 6af8d44c0..2d0ce51fe 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L341) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L341) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md index 1f03c9284..856ab33af 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L89) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L89) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md index 95df823cc..dcd7c4a85 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L350) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L350) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md index 209f6176c..cd2ea6faf 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L356) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L356) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md index 192e5a419..0a2ddfb2d 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L140) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L140) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md index 7723f5ec3..98cea6b8a 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L374) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L374) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md index bb4990d47..3a655ce64 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md index 257c5ee42..f6da55d80 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L380) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L380) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md index a2164b717..cc99838f4 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L398) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L398) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md index c50ad2412..c84ad7ac2 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md index e93ae8f0e..77fddf2e1 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L386) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L386) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md index 1ab28a287..aee9a01aa 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L404) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L404) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md index 1dd014ceb..5df46ee4d 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L410) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L410) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md index 18c058e61..5d9f09021 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L416) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L416) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md index b600c9789..19b1a56b0 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L422) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L422) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md index 2850dfd72..fff92f5ea 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L110) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L110) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md index 2e48c011c..3c5aa3c3b 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md index 400c27e36..50d9b1b73 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md index 4e519b484..30d9ab491 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md index 1d8415085..b47e8e9b4 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md index 9f3cf979a..96203ae57 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md index e002787f2..ebe740508 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md index 6b4270c9d..5b74b81b7 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md index 22fe56aa6..09a412786 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md index 3bead53c0..8e39e784e 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L62) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L62) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md index ef8a7c7ec..69b3c1f47 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L68) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L68) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md index bdfc5011a..7e5591305 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L74) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L74) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md index 87adeef0d..afbdabfdf 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L80) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L80) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index e5faddbdf..d408b4443 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L86) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L86) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md index ab6fa96bc..221a7dfcc 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L92) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L92) ## 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 5fe2789cb..e3dc4d270 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L154) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L154) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md index 787df9f3f..1cb07b717 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L160) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L160) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md index 03206dbe7..b2d7b1588 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L178) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L178) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md index 3ff76186c..99c8e0af3 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L184) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L184) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md index 3c7b7d47e..7fd237ae0 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L166) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L166) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md index d076e91d0..f1e999bed 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L172) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L172) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md index cab3e88a6..049f31104 100644 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -2,7 +2,7 @@ > `const` **SPECIAL\_TOKENS**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:216](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/types/llm.ts#L216) +Defined in: [packages/react-native-executorch/src/types/llm.ts:216](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L216) ## Type Declaration 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 b4b89cbb0..8e9ad1ab0 100644 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `const` **SSDLITE\_320\_MOBILENET\_V3\_LARGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L267) ## 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 3f50af129..a03737823 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_CANDY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L289) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L289) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md index f00bf8db9..1c7c7b2a9 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_MOSAIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L293) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L293) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md index 23cfcbc05..6094f0028 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_RAIN\_PRINCESS**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md index e0e4e2b9d..c8b9a55be 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_UDNIE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L301) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L301) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md index f1945bf22..5fdb7d348 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L42) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L42) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md index b2fadbed2..c61f333f5 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L48) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L48) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md index ff1e502f3..7177cb879 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L54) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L54) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md index e75d05802..3de37a23d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L363) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L363) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md index 75c41d432..d043e65d7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L60) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L60) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md index fe4b23dc6..3d4d8fdf6 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L66) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L66) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md index cf7880a43..a3e56cd3c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L72) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L72) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md index e9972e9e1..144aa04a6 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L84) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L84) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md index 5b86b16f6..2661a941a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L78) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L78) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md index 6db898a1d..2a62eb692 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L99) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L99) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md index 829f48276..b80096e32 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L165) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L165) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md index e8b23f20b..b96af5a11 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L105) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L105) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md index 724d2d968..d3cc13fe0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L117) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L117) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md index 4d924094b..1bac72447 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L123) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L123) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md index 8097f3b9a..12e54b2f9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L285) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L285) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md index f3c677e2b..91e05db1b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L135) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L135) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md index 2b2531988..3ea9dc7ce 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L147) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L147) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md index 2fe4c12d0..576a91582 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L153) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L153) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md index d8b20344f..57e48396d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L129) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L129) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md index 106dde99d..6a3d274aa 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L171) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L171) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md index 6f91c32d9..12f3c02c4 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L189) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L189) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md index ff00016d7..8ee6ae18d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L177) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L177) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md index e89bb6efa..69ee73bad 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L183) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L183) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md index cabbae6f8..95361eeb1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L159) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L159) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md index 72e440a7b..c96737ab0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L195) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L195) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md index b54a0d014..61674f12a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L201) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L201) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md index bbdb933ad..ed758dc9f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L213) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L213) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md index f2d9b6713..f25d0d550 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L207) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L207) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md index d408f0030..f09fbd506 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L219) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L219) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md index d57326ea6..a156ad3ec 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L225) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L225) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md index d4e4d8a32..595d3112c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L237) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L237) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md index 36c041ed5..46b87d3c3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L231) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L231) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md index e4bafcf8e..2086be94f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L255) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L255) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md index 368950fe8..f26bf1dff 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L243) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L243) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md index f7c909c1e..2c85e55d2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L249) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L249) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md index 5715d5359..387301b62 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L273) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L273) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md index 1ed3d33bf..aebe48e15 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L279) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L279) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md index bcd6582c2..65ab380ac 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L261) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L261) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md index 60700fe24..c58f8cccf 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L267) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md index 171de5e64..08fc05b29 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L291) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L291) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md index a760ff43f..a88fa0867 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md index 81f9c606e..d43204109 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L303) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L303) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md index dadab1931..e556921d5 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L309) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L309) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md index 8636111a8..5e48401e1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L315) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L315) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md index 4800e5b14..39d474dab 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L321) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L321) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md index 7ab1de1b9..2ebf32f64 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L327) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L327) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md index 8dd38ae36..bc85c72b5 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L336) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L336) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md index b0ecebef9..1b646076c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L345) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L345) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md index da867e242..6f21d9a16 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L93) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L93) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md index 8bcb02893..a1143e7f9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L351) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L351) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md index fde9d920f..3a320f2c8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L357) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L357) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md index 74a224ebf..b671bbc2d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L141) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L141) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md index fb917fcb0..58a0d07ab 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md index 9d7c9695c..b2e957c9e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L369) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L369) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md index fae442994..2ae4336c7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L381) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L381) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md index 5e08375ed..51a8c4f65 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L399) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L399) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md index cfe830a39..11b32d2eb 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L393) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L393) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md index cff08536c..892655a88 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L387) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L387) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md index e74bb2f36..88e826692 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L405) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L405) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md index a6388b4df..6242eeed1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L411) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L411) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md index 9b1209ab5..36f3a5f18 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L417) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L417) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md index 0b8ef33c3..0a076cc0b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md index 71d2ef8fc..ab1b59969 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/ocr/models.ts#L111) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L111) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md index 41dee9a4b..30e4a6085 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md index 8ac4a0dcf..88311902c 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L347) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L347) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md index cfdd67563..105c50beb 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md index 974ddee05..ae995e365 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L354) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L354) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md index 55344f321..844c79f2c 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L361) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L361) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md index b152636ab..c11241fa8 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L333) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L333) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md index 17cfd3908..35f278425 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/constants/modelUrls.ts#L340) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L340) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md index 2e6bb0796..99b4f369e 100644 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -2,7 +2,7 @@ > `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] -Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/98ccf0be60ddbbdcffa6085f633ea6ccfd6c68f2/packages/react-native-executorch/src/utils/llm.ts#L9) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/llm.ts#L9) ## Parameters From 520acc3881283b9238af4c444f8831911dadd9ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Mon, 26 Jan 2026 13:48:11 +0100 Subject: [PATCH 09/15] Add new files for better type control --- .../computer_vision/useClassification.ts | 15 ++-- .../computer_vision/useImageEmbeddings.ts | 15 ++-- .../computer_vision/useImageSegmentation.ts | 15 ++-- .../computer_vision/useObjectDetection.ts | 15 ++-- .../src/hooks/general/useExecutorchModule.ts | 15 ++-- .../useTextToSpeech.ts | 10 +-- packages/react-native-executorch/src/index.ts | 3 + .../src/types/classification.ts | 48 ++++++++++++ .../src/types/executorchModule.ts | 47 ++++++++++++ .../src/types/imageEmbeddings.ts | 48 ++++++++++++ .../src/types/imageSegmentation.ts | 56 ++++++++++++++ .../src/types/objectDetection.ts | 73 ++++++++++++++++++- .../react-native-executorch/src/types/ocr.ts | 4 +- .../src/types/textEmbeddings.ts | 1 + .../react-native-executorch/src/types/tts.ts | 60 +++++++++++++++ .../react-native-executorch/src/types/vad.ts | 1 + 16 files changed, 381 insertions(+), 45 deletions(-) create mode 100644 packages/react-native-executorch/src/types/classification.ts create mode 100644 packages/react-native-executorch/src/types/executorchModule.ts create mode 100644 packages/react-native-executorch/src/types/imageEmbeddings.ts 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 a2a569ca4..094a3fd5d 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts @@ -1,13 +1,14 @@ -import { ResourceSource } from '../../types/common'; import { useModule } from '../useModule'; import { ClassificationModule } from '../../modules/computer_vision/ClassificationModule'; +import { ClassificationProps, ClassificationType } from '../../types/classification'; -interface Props { - model: { modelSource: ResourceSource }; - preventLoad?: boolean; -} - -export const useClassification = ({ model, preventLoad = false }: Props) => +/** + * React hook for managing a Classification model instance. + * + * @param ClassificationConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. + * @returns Ready to use Classification model. + */ +export const useClassification = ({ model, preventLoad = false }: ClassificationProps): ClassificationType => useModule({ module: ClassificationModule, model, 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 2882d410d..bad2f13cc 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts @@ -1,13 +1,14 @@ import { ImageEmbeddingsModule } from '../../modules/computer_vision/ImageEmbeddingsModule'; -import { ResourceSource } from '../../types/common'; +import { ImageEmbeddingsProps } from '../../types/imageEmbeddings'; import { useModule } from '../useModule'; -interface Props { - model: { modelSource: ResourceSource }; - preventLoad?: boolean; -} - -export const useImageEmbeddings = ({ model, preventLoad = false }: Props) => +/** + * React hook for managing an Image Embeddings model instance. + * + * @param ImageEmbeddingsConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. + * @returns Ready to use Image Embeddings model. + */ +export const useImageEmbeddings = ({ model, preventLoad = false }: ImageEmbeddingsProps) => useModule({ module: ImageEmbeddingsModule, model, diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts b/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts index 8b37c21be..6c2cd303b 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts @@ -1,13 +1,14 @@ import { useModule } from '../useModule'; import { ImageSegmentationModule } from '../../modules/computer_vision/ImageSegmentationModule'; -import { ResourceSource } from '../../types/common'; +import { ImageSegmentationProps, ImageSegmentationType } from '../../types/imageSegmentation'; -interface Props { - model: { modelSource: ResourceSource }; - preventLoad?: boolean; -} - -export const useImageSegmentation = ({ model, preventLoad = false }: Props) => +/** + * React hook for managing an Image Segmentation model instance. + * + * @param ImageSegmentationConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. + * @returns Ready to use Image Segmentation model. + */ +export const useImageSegmentation = ({ model, preventLoad = false }: ImageSegmentationProps): ImageSegmentationType => useModule({ module: ImageSegmentationModule, model, 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 19c7dce3d..75b99c05d 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts @@ -1,13 +1,14 @@ -import { ResourceSource } from '../../types/common'; import { useModule } from '../useModule'; import { ObjectDetectionModule } from '../../modules/computer_vision/ObjectDetectionModule'; +import { ObjectDetectionProps, ObjectDetectionType } from '../../types/objectDetection'; -interface Props { - model: { modelSource: ResourceSource }; - preventLoad?: boolean; -} - -export const useObjectDetection = ({ model, preventLoad = false }: Props) => +/** + * React hook for managing an Object Detection model instance. + * + * @param ObjectDetectionConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. + * @returns Ready to use Object Detection model. + */ +export const useObjectDetection = ({ model, preventLoad = false }: ObjectDetectionProps): ObjectDetectionType => useModule({ module: ObjectDetectionModule, model, diff --git a/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts b/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts index 457d127d0..4535c7a8f 100644 --- a/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts +++ b/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts @@ -1,16 +1,17 @@ import { ExecutorchModule } from '../../modules/general/ExecutorchModule'; -import { ResourceSource } from '../../types/common'; +import { ExecutorchModuleProps, ExecutorchModuleType } from '../../types/executorchModule'; import { useModule } from '../useModule'; -interface Props { - modelSource: ResourceSource; - preventLoad?: boolean; -} - +/** + * React hook for managing an arbitrary Executorch module instance. + * + * @param executorchModuleConfiguration - Configuration object containing `modelSource` and optional `preventLoad` flag. + * @returns Ready to use Executorch module. + */ export const useExecutorchModule = ({ modelSource, preventLoad = false, -}: Props) => +}: ExecutorchModuleProps): ExecutorchModuleType => useModule({ module: ExecutorchModule, model: modelSource, diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts index 72d98acb7..311ae59d8 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts @@ -1,18 +1,14 @@ import { useCallback, useEffect, useState } from 'react'; import { TextToSpeechModule } from '../../modules/natural_language_processing/TextToSpeechModule'; import { - TextToSpeechConfig, + TextToSpeechProps, TextToSpeechInput, + TextToSpeechType, TextToSpeechStreamingInput, } from '../../types/tts'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; -interface Props extends TextToSpeechConfig { - preventLoad?: boolean; -} - - /** * React hook for managing Text to Speech instance. * @@ -23,7 +19,7 @@ export const useTextToSpeech = ({ model, voice, preventLoad = false, -}: Props) => { +}: TextToSpeechProps): TextToSpeechType => { const [error, setError] = useState(null); const [isReady, setIsReady] = useState(false); const [isGenerating, setIsGenerating] = useState(false); diff --git a/packages/react-native-executorch/src/index.ts b/packages/react-native-executorch/src/index.ts index 81236510b..4ae321b69 100644 --- a/packages/react-native-executorch/src/index.ts +++ b/packages/react-native-executorch/src/index.ts @@ -125,6 +125,9 @@ export * from './types/stt'; export * from './types/textEmbeddings'; export * from './types/tts'; export * from './types/tokenizer'; +export * from './types/executorchModule'; +export * from './types/classification'; +export * from './types/imageEmbeddings'; // constants export * from './constants/modelUrls'; diff --git a/packages/react-native-executorch/src/types/classification.ts b/packages/react-native-executorch/src/types/classification.ts new file mode 100644 index 000000000..a6df84fed --- /dev/null +++ b/packages/react-native-executorch/src/types/classification.ts @@ -0,0 +1,48 @@ +import { RnExecutorchError } from "../errors/errorUtils"; +import { ResourceSource } from "./common"; + +/** + * Props for the `useClassification` hook. + * + * @property {Object} model - An object containing the model source. + * @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: { modelSource: ResourceSource }; + preventLoad?: boolean; +} + +/** + * Return type for the `useClassification` hook. + * Manages the state and operations for Computer Vision image classification. + */ +export interface ClassificationType { + /** + * Contains the error object if the model failed to load, download, or encountered a runtime error during classification. + */ + error: RnExecutorchError | null; + + /** + * Indicates whether the classification model is loaded and ready to process images. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently processing an image. + */ + isGenerating: boolean; + + /** + * Represents the download progress of the model binary as a value between 0 and 1. + */ + downloadProgress: number; + + /** + * Executes the model's forward pass to classify the provided image. + * @param imageSource - A string representing the image source (e.g., a file path, URI, or base64 string) to be classified. + * @returns A Promise that resolves to the classification result (typically containing labels and confidence scores). + * @throws {RnExecutorchError} If the model is not loaded or is currently processing another image. + */ + forward: (imageSource: string) => Promise<{ [category: string]: number }> +} \ No newline at end of file diff --git a/packages/react-native-executorch/src/types/executorchModule.ts b/packages/react-native-executorch/src/types/executorchModule.ts new file mode 100644 index 000000000..204a57bdd --- /dev/null +++ b/packages/react-native-executorch/src/types/executorchModule.ts @@ -0,0 +1,47 @@ +import { ResourceSource, TensorPtr } from '../types/common'; +import { RnExecutorchError } from '../errors/errorUtils'; + +/** + * Props for the `useExecutorchModule` hook. + * + * @property {ResourceSource} modelSource - The source of the ExecuTorch 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 ExecutorchModuleProps { + modelSource: ResourceSource; + preventLoad?: boolean; +} + +/** + * Return type for the `useExecutorchModule` hook. + * Manages the state and core execution methods for a general ExecuTorch model. + */ +export interface ExecutorchModuleType { + /** + * Contains the error object if the model failed to load, download, or encountered a runtime error. + */ + error: RnExecutorchError | null; + + /** + * Indicates whether the ExecuTorch model binary has successfully loaded into memory and is ready for inference. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently processing a forward pass. + */ + isGenerating: boolean; + + /** + * Represents the download progress of the model binary as a value between 0 and 1. + */ + downloadProgress: number; + + /** + * Executes the model's forward pass with the provided input tensors. + * @param inputTensor - An array of `TensorPtr` objects representing the input tensors required by the model. + * @returns A Promise that resolves to an array of output `TensorPtr` objects resulting from the model's inference. + * @throws {RnExecutorchError} If the model is not loaded or is currently processing another request. + */ + forward: (inputTensor: TensorPtr[]) => Promise; +} \ No newline at end of file diff --git a/packages/react-native-executorch/src/types/imageEmbeddings.ts b/packages/react-native-executorch/src/types/imageEmbeddings.ts new file mode 100644 index 000000000..d0853ba5a --- /dev/null +++ b/packages/react-native-executorch/src/types/imageEmbeddings.ts @@ -0,0 +1,48 @@ +import { RnExecutorchError } from "../errors/errorUtils"; +import { ResourceSource } from "./common"; + +/** + * Props for the `useImageEmbeddings` hook. + * + * @property {Object} model - An object containing the model source. + * @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: { modelSource: ResourceSource }; + preventLoad?: boolean; +} + +/** + * Return type for the `useImageEmbeddings` hook. + * Manages the state and operations for generating image embeddings (feature vectors) used in Computer Vision tasks. + */ +export interface ImageEmbeddingsType { + /** + * Contains the error object if the model failed to load, download, or encountered a runtime error during embedding generation. + */ + error: RnExecutorchError | null; + + /** + * Indicates whether the image embeddings model is loaded and ready to process images. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently generating embeddings for an image. + */ + isGenerating: boolean; + + /** + * Represents the download progress of the model binary as a value between 0 and 1. + */ + downloadProgress: number; + + /** + * Executes the model's forward pass to generate embeddings (a feature vector) for the provided image. + * @param imageSource - A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. + * @returns A Promise that resolves to a `Float32Array` containing the generated embedding vector. + * @throws {RnExecutorchError} If the model is not loaded or is currently processing another image. + */ + forward: (imageSource: string) => Promise; +} \ No newline at end of file diff --git a/packages/react-native-executorch/src/types/imageSegmentation.ts b/packages/react-native-executorch/src/types/imageSegmentation.ts index 747d97fcd..927294eab 100644 --- a/packages/react-native-executorch/src/types/imageSegmentation.ts +++ b/packages/react-native-executorch/src/types/imageSegmentation.ts @@ -1,3 +1,6 @@ +import { RnExecutorchError } from "../errors/errorUtils"; +import { ResourceSource } from "./common"; + /* eslint-disable @cspell/spellchecker */ export enum DeeplabLabel { BACKGROUND, @@ -23,3 +26,56 @@ export enum DeeplabLabel { TVMONITOR, ARGMAX, // Additional label not present in the model } + +/** + * Props for the `useImageSegmentation` hook. + * + * @property {Object} model - An object containing the model source. + * @property {ResourceSource} model.modelSource - The source of the image segmentation 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 ImageSegmentationProps { + model: { modelSource: ResourceSource }; + preventLoad?: boolean; +} + +/** + * Return type for the `useImageSegmentation` hook. + * Manages the state and operations for Computer Vision image segmentation (e.g., DeepLab). + */ +export interface ImageSegmentationType { + /** + * Contains the error object if the model failed to load, download, or encountered a runtime error during segmentation. + */ + error: RnExecutorchError | null; + + /** + * Indicates whether the segmentation model is loaded and ready to process images. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently processing an image. + */ + isGenerating: boolean; + + /** + * Represents the download progress of the model binary as a value between 0 and 1. + */ + downloadProgress: number; + + /** + * Executes the model's forward pass to perform semantic segmentation on the provided image. + * @param imageSource - A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. + * @param classesOfInterest - An optional array of `DeeplabLabel` enums. If provided, the model will only return segmentation masks for these specific classes. + * @param resize - An optional boolean indicating whether the output segmentation masks should be resized to match the original image dimensions. Defaults to standard model behavior if undefined. + * @returns A Promise that resolves to an object mapping each detected `DeeplabLabel` to its corresponding segmentation mask (represented as a flattened array of numbers). + * @throws {RnExecutorchError} If the model is not loaded or is currently processing another image. + */ + forward: ( + imageSource: string, + classesOfInterest?: DeeplabLabel[], + resize?: boolean + ) => Promise>>; +} + diff --git a/packages/react-native-executorch/src/types/objectDetection.ts b/packages/react-native-executorch/src/types/objectDetection.ts index 78aa324dc..15b0d1a32 100644 --- a/packages/react-native-executorch/src/types/objectDetection.ts +++ b/packages/react-native-executorch/src/types/objectDetection.ts @@ -1,3 +1,14 @@ +import { RnExecutorchError } from "../errors/errorUtils"; +import { ResourceSource } from "./common"; + +/** + * Represents a bounding box for a detected object in an image. + * + * @property {number} x1 - The x-coordinate of the bottom-left corner of the bounding box. + * @property {number} y1 - The y-coordinate of the bottom-left corner of the bounding box. + * @property {number} x2 - The x-coordinate of the top-right corner of the bounding box. + * @property {number} y2 - The y-coordinate of the top-right corner of the bounding box. + */ export interface Bbox { x1: number; x2: number; @@ -5,13 +16,23 @@ export interface Bbox { y2: number; } +/** + * Represents a detected object within an image, including its bounding box, label, and confidence score. + * + * @property {Bbox} bbox - The bounding box of the detected object, defined by its top-left (x1, y1) and bottom-right (x2, y2) coordinates. + * @property {keyof typeof CocoLabel} label - The class label of the detected object, represented as a key from the `CocoLabel` enum. + * @property {number} score - The confidence score of the detection, typically ranging from 0 to 1. + */ export interface Detection { bbox: Bbox; label: keyof typeof CocoLabel; score: number; } -enum CocoLabel { +/** + * COCO dataset class labels used for object detection. + */ +export enum CocoLabel { PERSON = 1, BICYCLE = 2, CAR = 3, @@ -103,3 +124,53 @@ enum CocoLabel { TOOTHBRUSH = 90, HAIR_BRUSH = 91, } + +/** + * Props for the `useObjectDetection` hook. + * + * @property {Object} model - An object containing the model source. + * @property {ResourceSource} model.modelSource - The source of the object detection 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 ObjectDetectionProps { + model: { modelSource: ResourceSource }; + preventLoad?: boolean; +} + +/** + * Return type for the `useObjectDetection` hook. + * Manages the state and operations for Computer Vision object detection tasks. + */ +export interface ObjectDetectionType { + /** + * Contains the error object if the model failed to load, download, or encountered a runtime error during detection. + */ + error: RnExecutorchError | null; + + /** + * Indicates whether the object detection model is loaded and ready to process images. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently processing an image. + */ + isGenerating: boolean; + + /** + * Represents the download progress of the model binary as a value between 0 and 1. + */ + downloadProgress: number; + + /** + * Executes the model's forward pass to detect objects within the provided image. + * @param imageSource - A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. + * @param detectionThreshold - An optional number between 0 and 1 representing the minimum confidence score required for an object to be included in the results. Dafault is 0.7. + * @returns A Promise that resolves to an array of `Detection` objects, where each object typically contains bounding box coordinates, a class label, and a confidence score. + * @throws {RnExecutorchError} If the model is not loaded or is currently processing another image. + */ + forward: ( + imageSource: string, + detectionThreshold?: number + ) => Promise; +} diff --git a/packages/react-native-executorch/src/types/ocr.ts b/packages/react-native-executorch/src/types/ocr.ts index 873703c63..6b8b72efd 100644 --- a/packages/react-native-executorch/src/types/ocr.ts +++ b/packages/react-native-executorch/src/types/ocr.ts @@ -1,12 +1,12 @@ import { symbols } from '../constants/ocr/symbols'; export interface OCRDetection { - bbox: OCRBbox[]; + bbox: Point[]; text: string; score: number; } -export interface OCRBbox { +export interface Point { x: number; y: number; } diff --git a/packages/react-native-executorch/src/types/textEmbeddings.ts b/packages/react-native-executorch/src/types/textEmbeddings.ts index 94077bc42..1f28893fc 100644 --- a/packages/react-native-executorch/src/types/textEmbeddings.ts +++ b/packages/react-native-executorch/src/types/textEmbeddings.ts @@ -29,6 +29,7 @@ export interface TextEmbeddingsType { * Runs the text embeddings model on the provided input string. * * @param input - The text string to embed. * @returns A promise resolving to a Float32Array containing the vector embeddings. + * @throws {RnExecutorchError} If the model is not loaded or is currently processing another request. */ forward(input: string): Promise; } diff --git a/packages/react-native-executorch/src/types/tts.ts b/packages/react-native-executorch/src/types/tts.ts index 6d40c1655..a75b28ef4 100644 --- a/packages/react-native-executorch/src/types/tts.ts +++ b/packages/react-native-executorch/src/types/tts.ts @@ -1,4 +1,5 @@ import { ResourceSource } from './common'; +import { RnExecutorchError } from '../errors/errorUtils'; // List all the languages available in TTS models (as lang shorthands) export type TextToSpeechLanguage = @@ -48,6 +49,17 @@ export interface TextToSpeechConfig { voice: VoiceConfig; } +/** + * Props for the useTextToSpeech hook. + * + * @extends TextToSpeechConfig + * + * @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 TextToSpeechProps extends TextToSpeechConfig { + preventLoad?: boolean; +} + /** * Text to Speech module input definition * @@ -59,6 +71,54 @@ export interface TextToSpeechInput { speed?: number; } +/** + * Return type for the `useTextToSpeech` hook. + * Manages the state and operations for Text-to-Speech generation. + */ +export interface TextToSpeechType { + /** + * Contains the error object if the model failed to load or encountered an error during inference. + */ + error: RnExecutorchError | null; + + /** + * Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently generating audio. + */ + isGenerating: boolean; + + /** + * Represents the download progress of the model and voice assets as a value between 0 and 1. + */ + downloadProgress: number; + + /** + * Runs the model to convert the provided text into speech audio in a single pass. + * * @param input - The `TextToSpeechInput` object containing the `text` to synthesize and optional `speed`. + * @returns A Promise that resolves with the generated audio data (typically a `Float32Array`). + * @throws {RnExecutorchError} If the model is not loaded or is currently generating. + */ + forward: (input: TextToSpeechInput) => Promise; + + /** + * Streams the generated audio data incrementally. + * This is optimal for real-time playback, allowing audio to start playing before the full text is synthesized. + * * @param input - The `TextToSpeechStreamingInput` object containing `text`, optional `speed`, and lifecycle callbacks (`onBegin`, `onNext`, `onEnd`). + * @returns A Promise that resolves when the streaming process is complete. + * @throws {RnExecutorchError} If the model is not loaded or is currently generating. + */ + stream: (input: TextToSpeechStreamingInput) => Promise; + + /** + * Interrupts and stops the currently active audio generation stream. + */ + streamStop: () => void; +} + /** * Text to Speech streaming input definition * diff --git a/packages/react-native-executorch/src/types/vad.ts b/packages/react-native-executorch/src/types/vad.ts index ade7b1287..40b1fb66d 100644 --- a/packages/react-native-executorch/src/types/vad.ts +++ b/packages/react-native-executorch/src/types/vad.ts @@ -59,6 +59,7 @@ export interface VADType { * Runs the Voice Activity Detection model on the provided audio waveform. * @param waveform - The input audio waveform array. * @returns A promise resolving to an array of detected audio segments (e.g., timestamps for speech). + * @throws {RnExecutorchError} If the model is not loaded or is currently processing another request. */ forward(waveform: Float32Array): Promise; } From 81b229bbed784732fe329dbbff41e28b06bdb54d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Mon, 26 Jan 2026 20:48:06 +0100 Subject: [PATCH 10/15] Add new typedocs to another modules --- .../classes/ClassificationModule.md | 33 +++- .../classes/ExecutorchModule.md | 47 ++++- .../classes/ImageEmbeddingsModule.md | 33 +++- .../classes/ImageSegmentationModule.md | 33 +++- .../06-api-reference/classes/LLMModule.md | 124 +++++++++--- .../06-api-reference/classes/OCRModule.md | 10 +- .../classes/ObjectDetectionModule.md | 33 +++- .../classes/ResourceFetcher.md | 20 +- .../classes/RnExecutorchError.md | 8 +- .../classes/SpeechToTextModule.md | 54 +++++- .../classes/StyleTransferModule.md | 33 +++- .../classes/TextEmbeddingsModule.md | 51 ++++- .../classes/TextToImageModule.md | 37 +++- .../classes/TextToSpeechModule.md | 137 +++++++++++++ .../classes/TokenizerModule.md | 59 +++++- .../06-api-reference/classes/VADModule.md | 46 ++++- .../classes/VerticalOCRModule.md | 10 +- .../enumerations/CocoLabel.md | 182 +++++++++--------- .../enumerations/DeeplabLabel.md | 46 ++--- .../enumerations/RnExecutorchErrorCode.md | 86 ++++----- .../enumerations/ScalarType.md | 46 ++--- .../DEFAULT_STRUCTURED_OUTPUT_PROMPT.md | 2 +- .../fixAndValidateStructuredOutput.md | 2 +- .../functions/getStructuredOutputPrompt.md | 2 +- .../functions/useClassification.md | 2 +- .../functions/useExecutorchModule.md | 2 +- .../functions/useImageEmbeddings.md | 2 +- .../functions/useImageSegmentation.md | 2 +- .../docs/06-api-reference/functions/useLLM.md | 2 +- .../docs/06-api-reference/functions/useOCR.md | 32 +-- .../functions/useObjectDetection.md | 2 +- .../functions/useSpeechToText.md | 2 +- .../functions/useStyleTransfer.md | 50 +---- .../functions/useTextEmbeddings.md | 2 +- .../functions/useTextToImage.md | 44 +---- .../functions/useTextToSpeech.md | 2 +- .../functions/useTokenizer.md | 2 +- .../docs/06-api-reference/functions/useVAD.md | 2 +- .../functions/useVerticalOCR.md | 36 +--- docs/docs/06-api-reference/index.md | 9 + docs/docs/06-api-reference/interfaces/Bbox.md | 10 +- .../06-api-reference/interfaces/ChatConfig.md | 8 +- .../interfaces/ClassificationProps.md | 6 +- .../interfaces/ClassificationType.md | 12 +- .../interfaces/DecodingOptions.md | 4 +- .../06-api-reference/interfaces/Detection.md | 8 +- .../interfaces/ExecutorchModuleProps.md | 6 +- .../interfaces/ExecutorchModuleType.md | 12 +- .../interfaces/GenerationConfig.md | 10 +- .../interfaces/ImageEmbeddingsProps.md | 6 +- .../interfaces/ImageEmbeddingsType.md | 12 +- .../interfaces/ImageSegmentationProps.md | 6 +- .../interfaces/ImageSegmentationType.md | 12 +- .../interfaces/KokoroConfig.md | 14 +- .../interfaces/KokoroVoiceExtras.md | 12 +- .../06-api-reference/interfaces/LLMConfig.md | 55 ++++++ .../06-api-reference/interfaces/LLMType.md | 68 ++----- .../06-api-reference/interfaces/Message.md | 6 +- .../interfaces/OCRDetection.md | 17 +- .../06-api-reference/interfaces/OCRProps.md | 48 +++++ .../06-api-reference/interfaces/OCRType.md | 74 +++++++ .../interfaces/ObjectDetectionProps.md | 6 +- .../interfaces/ObjectDetectionType.md | 12 +- .../docs/06-api-reference/interfaces/Point.md | 12 +- .../06-api-reference/interfaces/Segment.md | 6 +- .../interfaces/SpeechToTextModelConfig.md | 10 +- .../interfaces/SpeechToTextType.md | 26 +-- .../interfaces/StyleTransferProps.md | 29 +++ .../interfaces/StyleTransferType.md | 74 +++++++ .../06-api-reference/interfaces/TensorPtr.md | 16 +- .../interfaces/TextEmbeddingsProps.md | 12 +- .../interfaces/TextEmbeddingsType.md | 13 +- .../interfaces/TextToImageParams.md | 79 ++++++++ .../interfaces/TextToImageType.md | 106 ++++++++++ .../interfaces/TextToSpeechConfig.md | 6 +- .../interfaces/TextToSpeechInput.md | 6 +- .../interfaces/TextToSpeechProps.md | 8 +- .../interfaces/TextToSpeechStreamingInput.md | 12 +- .../interfaces/TextToSpeechType.md | 16 +- .../interfaces/TokenizerType.md | 22 ++- .../06-api-reference/interfaces/ToolCall.md | 12 +- .../interfaces/ToolsConfig.md | 8 +- .../06-api-reference/interfaces/VADProps.md | 8 +- .../06-api-reference/interfaces/VADType.md | 12 +- .../interfaces/VerticalOCRProps.md | 67 +++++++ .../interfaces/VoiceConfig.md | 8 +- .../06-api-reference/type-aliases/LLMTool.md | 2 +- .../type-aliases/MessageRole.md | 2 +- .../type-aliases/OCRLanguage.md | 4 +- .../type-aliases/ResourceSource.md | 2 +- .../type-aliases/SpeechToTextLanguage.md | 2 +- .../type-aliases/TensorBuffer.md | 4 +- .../type-aliases/TextToSpeechLanguage.md | 2 +- .../docs/06-api-reference/typedoc-sidebar.cjs | 2 +- .../variables/ALL_MINILM_L6_V2.md | 2 +- .../variables/ALL_MPNET_BASE_V2.md | 2 +- .../variables/BK_SDM_TINY_VPRED_256.md | 2 +- .../variables/BK_SDM_TINY_VPRED_512.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 2 +- .../variables/DEEPLAB_V3_RESNET50.md | 2 +- .../variables/DEFAULT_CHAT_CONFIG.md | 2 +- .../DEFAULT_CONTEXT_WINDOW_LENGTH.md | 2 +- .../variables/DEFAULT_MESSAGE_HISTORY.md | 2 +- .../variables/DEFAULT_SYSTEM_PROMPT.md | 2 +- .../variables/EFFICIENTNET_V2_S.md | 2 +- .../06-api-reference/variables/FSMN_VAD.md | 2 +- .../variables/HAMMER2_1_0_5B.md | 2 +- .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_1_5B.md | 2 +- .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_3B.md | 2 +- .../variables/HAMMER2_1_3B_QUANTIZED.md | 2 +- .../variables/KOKORO_MEDIUM.md | 2 +- .../variables/KOKORO_SMALL.md | 2 +- .../variables/KOKORO_VOICE_AF_HEART.md | 2 +- .../variables/KOKORO_VOICE_AF_RIVER.md | 2 +- .../variables/KOKORO_VOICE_AF_SARAH.md | 2 +- .../variables/KOKORO_VOICE_AM_ADAM.md | 2 +- .../variables/KOKORO_VOICE_AM_MICHAEL.md | 2 +- .../variables/KOKORO_VOICE_AM_SANTA.md | 2 +- .../variables/KOKORO_VOICE_BF_EMMA.md | 2 +- .../variables/KOKORO_VOICE_BM_DANIEL.md | 2 +- .../06-api-reference/variables/LLAMA3_2_1B.md | 2 +- .../variables/LLAMA3_2_1B_QLORA.md | 2 +- .../variables/LLAMA3_2_1B_SPINQUANT.md | 2 +- .../06-api-reference/variables/LLAMA3_2_3B.md | 2 +- .../variables/LLAMA3_2_3B_QLORA.md | 2 +- .../variables/LLAMA3_2_3B_SPINQUANT.md | 2 +- .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 2 +- .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 2 +- .../06-api-reference/variables/OCR_ABAZA.md | 2 +- .../06-api-reference/variables/OCR_ADYGHE.md | 2 +- .../variables/OCR_AFRIKAANS.md | 2 +- .../variables/OCR_ALBANIAN.md | 2 +- .../06-api-reference/variables/OCR_AVAR.md | 2 +- .../variables/OCR_AZERBAIJANI.md | 2 +- .../variables/OCR_BELARUSIAN.md | 2 +- .../06-api-reference/variables/OCR_BOSNIAN.md | 2 +- .../variables/OCR_BULGARIAN.md | 2 +- .../06-api-reference/variables/OCR_CHECHEN.md | 2 +- .../variables/OCR_CROATIAN.md | 2 +- .../06-api-reference/variables/OCR_CZECH.md | 2 +- .../06-api-reference/variables/OCR_DANISH.md | 2 +- .../06-api-reference/variables/OCR_DARGWA.md | 2 +- .../06-api-reference/variables/OCR_DUTCH.md | 2 +- .../06-api-reference/variables/OCR_ENGLISH.md | 2 +- .../variables/OCR_ESTONIAN.md | 2 +- .../06-api-reference/variables/OCR_FRENCH.md | 2 +- .../06-api-reference/variables/OCR_GERMAN.md | 2 +- .../variables/OCR_HUNGARIAN.md | 2 +- .../variables/OCR_ICELANDIC.md | 2 +- .../variables/OCR_INDONESIAN.md | 2 +- .../06-api-reference/variables/OCR_INGUSH.md | 2 +- .../06-api-reference/variables/OCR_IRISH.md | 2 +- .../06-api-reference/variables/OCR_ITALIAN.md | 2 +- .../variables/OCR_JAPANESE.md | 2 +- .../06-api-reference/variables/OCR_KANNADA.md | 2 +- .../variables/OCR_KARBADIAN.md | 2 +- .../06-api-reference/variables/OCR_KOREAN.md | 2 +- .../06-api-reference/variables/OCR_KURDISH.md | 2 +- .../06-api-reference/variables/OCR_LAK.md | 2 +- .../06-api-reference/variables/OCR_LATIN.md | 2 +- .../06-api-reference/variables/OCR_LATVIAN.md | 2 +- .../variables/OCR_LEZGHIAN.md | 2 +- .../variables/OCR_LITHUANIAN.md | 2 +- .../06-api-reference/variables/OCR_MALAY.md | 2 +- .../06-api-reference/variables/OCR_MALTESE.md | 2 +- .../06-api-reference/variables/OCR_MAORI.md | 2 +- .../variables/OCR_MONGOLIAN.md | 2 +- .../variables/OCR_NORWEGIAN.md | 2 +- .../06-api-reference/variables/OCR_OCCITAN.md | 2 +- .../06-api-reference/variables/OCR_PALI.md | 2 +- .../06-api-reference/variables/OCR_POLISH.md | 2 +- .../variables/OCR_PORTUGUESE.md | 2 +- .../variables/OCR_ROMANIAN.md | 2 +- .../06-api-reference/variables/OCR_RUSSIAN.md | 2 +- .../variables/OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/OCR_SERBIAN_LATIN.md | 2 +- .../variables/OCR_SIMPLIFIED_CHINESE.md | 2 +- .../06-api-reference/variables/OCR_SLOVAK.md | 2 +- .../variables/OCR_SLOVENIAN.md | 2 +- .../06-api-reference/variables/OCR_SPANISH.md | 2 +- .../06-api-reference/variables/OCR_SWAHILI.md | 2 +- .../06-api-reference/variables/OCR_SWEDISH.md | 2 +- .../variables/OCR_TABASSARAN.md | 2 +- .../06-api-reference/variables/OCR_TAGALOG.md | 2 +- .../06-api-reference/variables/OCR_TAJIK.md | 2 +- .../06-api-reference/variables/OCR_TELUGU.md | 2 +- .../06-api-reference/variables/OCR_TURKISH.md | 2 +- .../variables/OCR_UKRAINIAN.md | 2 +- .../06-api-reference/variables/OCR_UZBEK.md | 2 +- .../variables/OCR_VIETNAMESE.md | 2 +- .../06-api-reference/variables/OCR_WELSH.md | 2 +- .../variables/PHI_4_MINI_4B.md | 2 +- .../variables/PHI_4_MINI_4B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_0_5B.md | 2 +- .../variables/QWEN2_5_0_5B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_1_5B.md | 2 +- .../variables/QWEN2_5_1_5B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN2_5_3B.md | 2 +- .../variables/QWEN2_5_3B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_0_6B.md | 2 +- .../variables/QWEN3_0_6B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_1_7B.md | 2 +- .../variables/QWEN3_1_7B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_4B.md | 2 +- .../variables/QWEN3_4B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_135M.md | 2 +- .../variables/SMOLLM2_1_135M_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_1_7B.md | 2 +- .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_360M.md | 2 +- .../variables/SMOLLM2_1_360M_QUANTIZED.md | 2 +- .../variables/SPECIAL_TOKENS.md | 2 +- .../SSDLITE_320_MOBILENET_V3_LARGE.md | 2 +- .../variables/STYLE_TRANSFER_CANDY.md | 2 +- .../variables/STYLE_TRANSFER_MOSAIC.md | 2 +- .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 2 +- .../variables/STYLE_TRANSFER_UDNIE.md | 2 +- .../variables/VERTICAL_OCR_ABAZA.md | 2 +- .../variables/VERTICAL_OCR_ADYGHE.md | 2 +- .../variables/VERTICAL_OCR_AFRIKAANS.md | 2 +- .../variables/VERTICAL_OCR_ALBANIAN.md | 2 +- .../variables/VERTICAL_OCR_AVAR.md | 2 +- .../variables/VERTICAL_OCR_AZERBAIJANI.md | 2 +- .../variables/VERTICAL_OCR_BELARUSIAN.md | 2 +- .../variables/VERTICAL_OCR_BOSNIAN.md | 2 +- .../variables/VERTICAL_OCR_BULGARIAN.md | 2 +- .../variables/VERTICAL_OCR_CHECHEN.md | 2 +- .../variables/VERTICAL_OCR_CROATIAN.md | 2 +- .../variables/VERTICAL_OCR_CZECH.md | 2 +- .../variables/VERTICAL_OCR_DANISH.md | 2 +- .../variables/VERTICAL_OCR_DARGWA.md | 2 +- .../variables/VERTICAL_OCR_DUTCH.md | 2 +- .../variables/VERTICAL_OCR_ENGLISH.md | 2 +- .../variables/VERTICAL_OCR_ESTONIAN.md | 2 +- .../variables/VERTICAL_OCR_FRENCH.md | 2 +- .../variables/VERTICAL_OCR_GERMAN.md | 2 +- .../variables/VERTICAL_OCR_HUNGARIAN.md | 2 +- .../variables/VERTICAL_OCR_ICELANDIC.md | 2 +- .../variables/VERTICAL_OCR_INDONESIAN.md | 2 +- .../variables/VERTICAL_OCR_INGUSH.md | 2 +- .../variables/VERTICAL_OCR_IRISH.md | 2 +- .../variables/VERTICAL_OCR_ITALIAN.md | 2 +- .../variables/VERTICAL_OCR_JAPANESE.md | 2 +- .../variables/VERTICAL_OCR_KANNADA.md | 2 +- .../variables/VERTICAL_OCR_KARBADIAN.md | 2 +- .../variables/VERTICAL_OCR_KOREAN.md | 2 +- .../variables/VERTICAL_OCR_KURDISH.md | 2 +- .../variables/VERTICAL_OCR_LAK.md | 2 +- .../variables/VERTICAL_OCR_LATIN.md | 2 +- .../variables/VERTICAL_OCR_LATVIAN.md | 2 +- .../variables/VERTICAL_OCR_LEZGHIAN.md | 2 +- .../variables/VERTICAL_OCR_LITHUANIAN.md | 2 +- .../variables/VERTICAL_OCR_MALAY.md | 2 +- .../variables/VERTICAL_OCR_MALTESE.md | 2 +- .../variables/VERTICAL_OCR_MAORI.md | 2 +- .../variables/VERTICAL_OCR_MONGOLIAN.md | 2 +- .../variables/VERTICAL_OCR_NORWEGIAN.md | 2 +- .../variables/VERTICAL_OCR_OCCITAN.md | 2 +- .../variables/VERTICAL_OCR_PALI.md | 2 +- .../variables/VERTICAL_OCR_POLISH.md | 2 +- .../variables/VERTICAL_OCR_PORTUGUESE.md | 2 +- .../variables/VERTICAL_OCR_ROMANIAN.md | 2 +- .../variables/VERTICAL_OCR_RUSSIAN.md | 2 +- .../VERTICAL_OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/VERTICAL_OCR_SERBIAN_LATIN.md | 2 +- .../VERTICAL_OCR_SIMPLIFIED_CHINESE.md | 2 +- .../variables/VERTICAL_OCR_SLOVAK.md | 2 +- .../variables/VERTICAL_OCR_SLOVENIAN.md | 2 +- .../variables/VERTICAL_OCR_SPANISH.md | 2 +- .../variables/VERTICAL_OCR_SWAHILI.md | 2 +- .../variables/VERTICAL_OCR_SWEDISH.md | 2 +- .../variables/VERTICAL_OCR_TABASSARAN.md | 2 +- .../variables/VERTICAL_OCR_TAGALOG.md | 2 +- .../variables/VERTICAL_OCR_TAJIK.md | 2 +- .../variables/VERTICAL_OCR_TELUGU.md | 2 +- .../variables/VERTICAL_OCR_TURKISH.md | 2 +- .../variables/VERTICAL_OCR_UKRAINIAN.md | 2 +- .../variables/VERTICAL_OCR_UZBEK.md | 2 +- .../variables/VERTICAL_OCR_VIETNAMESE.md | 2 +- .../variables/VERTICAL_OCR_WELSH.md | 2 +- .../variables/WHISPER_BASE.md | 2 +- .../variables/WHISPER_BASE_EN.md | 2 +- .../variables/WHISPER_SMALL.md | 2 +- .../variables/WHISPER_SMALL_EN.md | 2 +- .../variables/WHISPER_TINY.md | 2 +- .../variables/WHISPER_TINY_EN.md | 2 +- .../variables/WHISPER_TINY_EN_QUANTIZED.md | 2 +- .../variables/parseToolCall.md | 2 +- .../src/hooks/computer_vision/useOCR.ts | 26 +-- .../hooks/computer_vision/useStyleTransfer.ts | 15 +- .../hooks/computer_vision/useTextToImage.ts | 34 +--- .../hooks/computer_vision/useVerticalOCR.ts | 27 +-- .../natural_language_processing/useLLM.ts | 10 +- packages/react-native-executorch/src/index.ts | 3 + .../src/modules/BaseModule.ts | 20 ++ .../src/modules/general/ExecutorchModule.ts | 14 ++ .../natural_language_processing/LLMModule.ts | 93 ++++++++- .../SpeechToTextModule.ts | 40 +++- .../TextEmbeddingsModule.ts | 18 ++ .../TextToSpeechModule.ts | 33 ++++ .../TokenizerModule.ts | 44 ++++- .../natural_language_processing/VADModule.ts | 13 ++ .../src/types/common.ts | 10 + .../react-native-executorch/src/types/llm.ts | 150 +++++++-------- .../react-native-executorch/src/types/ocr.ts | 95 +++++++++ .../react-native-executorch/src/types/stt.ts | 5 +- .../src/types/styleTransfer.ts | 48 +++++ .../src/types/textEmbeddings.ts | 18 +- .../src/types/tokenizer.ts | 1 + .../react-native-executorch/src/types/tti.ts | 83 ++++++++ .../react-native-executorch/src/types/tts.ts | 11 +- .../react-native-executorch/src/types/vad.ts | 21 +- 315 files changed, 2478 insertions(+), 1087 deletions(-) create mode 100644 docs/docs/06-api-reference/classes/TextToSpeechModule.md create mode 100644 docs/docs/06-api-reference/interfaces/LLMConfig.md create mode 100644 docs/docs/06-api-reference/interfaces/OCRProps.md create mode 100644 docs/docs/06-api-reference/interfaces/OCRType.md create mode 100644 docs/docs/06-api-reference/interfaces/StyleTransferProps.md create mode 100644 docs/docs/06-api-reference/interfaces/StyleTransferType.md create mode 100644 docs/docs/06-api-reference/interfaces/TextToImageParams.md create mode 100644 docs/docs/06-api-reference/interfaces/TextToImageType.md create mode 100644 docs/docs/06-api-reference/interfaces/VerticalOCRProps.md create mode 100644 packages/react-native-executorch/src/types/styleTransfer.ts create mode 100644 packages/react-native-executorch/src/types/tti.ts diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index a9ad42730..9ab799644 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,6 @@ # Class: ClassificationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) ## Extends @@ -26,7 +26,9 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Class > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) + +Native module instance #### Inherited from @@ -38,7 +40,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) + +Unloads the model from memory. #### Returns @@ -54,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) #### Parameters @@ -72,7 +76,10 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Class > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) + +Runs the model's forward method with the given input tensors. +It returns the output tensors that mimic the structure of output from ExecuTorch. #### Parameters @@ -80,10 +87,14 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http [`TensorPtr`](../interfaces/TensorPtr.md)[] +Array of input tensors. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +Array of output tensors. + #### Inherited from `BaseModule.forwardET` @@ -94,7 +105,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) + +Gets the input shape for a given method and index. #### Parameters @@ -102,14 +115,20 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `string` +method name + ##### index `number` +index of the argument which shape is requested + #### Returns `Promise`\<`number`[]\> +The input shape as an array of numbers. + #### Inherited from `BaseModule.getInputShape` @@ -120,7 +139,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index 4bb8171b3..c370eb9ff 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -1,6 +1,6 @@ # Class: ExecutorchModule -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) ## Extends @@ -26,7 +26,9 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) + +Native module instance #### Inherited from @@ -38,7 +40,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) + +Unloads the model from memory. #### Returns @@ -54,7 +58,10 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L40) + +Executes the model's forward pass, where input is an array of `TensorPtr` objects. +If the inference is successful, an array of tensor pointers is returned. #### Parameters @@ -62,17 +69,24 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu [`TensorPtr`](../interfaces/TensorPtr.md)[] +Array of input tensor pointers. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +An array of output tensor pointers. + *** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) + +Runs the model's forward method with the given input tensors. +It returns the output tensors that mimic the structure of output from ExecuTorch. #### Parameters @@ -80,10 +94,14 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http [`TensorPtr`](../interfaces/TensorPtr.md)[] +Array of input tensors. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +Array of output tensors. + #### Inherited from `BaseModule.forwardET` @@ -94,7 +112,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) + +Gets the input shape for a given method and index. #### Parameters @@ -102,14 +122,20 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `string` +method name + ##### index `number` +index of the argument which shape is requested + #### Returns `Promise`\<`number`[]\> +The input shape as an array of numbers. + #### Inherited from `BaseModule.getInputShape` @@ -120,7 +146,10 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L16) + +Loads the model, where `modelSource` is a string, number, or object that specifies the location of the model binary. +Optionally accepts a download progress callback. #### Parameters @@ -128,10 +157,14 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu [`ResourceSource`](../type-aliases/ResourceSource.md) +Source of the model to be loaded. + ##### onDownloadProgressCallback (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md index efc1c9260..3fe5bd836 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: ImageEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) ## Extends @@ -26,7 +26,9 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) + +Native module instance #### Inherited from @@ -38,7 +40,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) + +Unloads the model from memory. #### Returns @@ -54,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) #### Parameters @@ -72,7 +76,10 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) + +Runs the model's forward method with the given input tensors. +It returns the output tensors that mimic the structure of output from ExecuTorch. #### Parameters @@ -80,10 +87,14 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http [`TensorPtr`](../interfaces/TensorPtr.md)[] +Array of input tensors. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +Array of output tensors. + #### Inherited from `BaseModule.forwardET` @@ -94,7 +105,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) + +Gets the input shape for a given method and index. #### Parameters @@ -102,14 +115,20 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `string` +method name + ##### index `number` +index of the argument which shape is requested + #### Returns `Promise`\<`number`[]\> +The input shape as an array of numbers. + #### Inherited from `BaseModule.getInputShape` @@ -120,7 +139,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md index 53f575d15..2b38719fb 100644 --- a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -1,6 +1,6 @@ # Class: ImageSegmentationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) ## Extends @@ -26,7 +26,9 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) + +Native module instance #### Inherited from @@ -38,7 +40,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) + +Unloads the model from memory. #### Returns @@ -54,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) #### Parameters @@ -80,7 +84,10 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) + +Runs the model's forward method with the given input tensors. +It returns the output tensors that mimic the structure of output from ExecuTorch. #### Parameters @@ -88,10 +95,14 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http [`TensorPtr`](../interfaces/TensorPtr.md)[] +Array of input tensors. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +Array of output tensors. + #### Inherited from `BaseModule.forwardET` @@ -102,7 +113,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) + +Gets the input shape for a given method and index. #### Parameters @@ -110,14 +123,20 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `string` +method name + ##### index `number` +index of the argument which shape is requested + #### Returns `Promise`\<`number`[]\> +The input shape as an array of numbers. + #### Inherited from `BaseModule.getInputShape` @@ -128,7 +147,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md index d8022aee8..b71a167ca 100644 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -1,58 +1,67 @@ # Class: LLMModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L11) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L12) + +Module for managing a Large Language Model (LLM) instance. ## Constructors ### Constructor -> **new LLMModule**(`__namedParameters`): `LLMModule` +> **new LLMModule**(`optionalCallbacks`): `LLMModule` + +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L21) -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) +Creates a new instance of LLMModule with optional callbacks. #### Parameters -##### \_\_namedParameters +##### optionalCallbacks + +Object containing optional callbacks. ###### messageHistoryCallback? (`messageHistory`) => `void` +Optional callback invoked on message history updates (`Message[]`). + ###### responseCallback? (`response`) => `void` +Optional callback invoked on every response update (`string`). + ###### tokenCallback? (`token`) => `void` +Optional callback invoked on every token batch (`string`). + #### Returns `LLMModule` +A new LLMModule instance. + ## Methods ### configure() -> **configure**(`__namedParameters`): `void` - -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:52](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L52) - -#### Parameters +> **configure**(`configuration`): `void` -##### \_\_namedParameters +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) -###### chatConfig? +Configures chat and tool calling and generation settings. +See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. -`Partial`\<[`ChatConfig`](../interfaces/ChatConfig.md)\> - -###### generationConfig? +#### Parameters -[`GenerationConfig`](../interfaces/GenerationConfig.md) +##### configuration -###### toolsConfig? +[`LLMConfig`](../interfaces/LLMConfig.md) -[`ToolsConfig`](../interfaces/ToolsConfig.md) +Configuration object containing `chatConfig`, `toolsConfig`, and `generationConfig`. #### Returns @@ -64,7 +73,11 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:92](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L92) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:169](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L169) + +Method to delete the model from memory. +Note you cannot delete model while it's generating. +You need to interrupt it first and make sure model stopped generation. #### Returns @@ -76,7 +89,11 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:79](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L79) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:143](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L143) + +Deletes all messages starting with message on `index` position. +After deletion it will call `messageHistoryCallback()` containing new history. +It also returns it. #### Parameters @@ -84,17 +101,26 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro `number` +The index of the message to delete from history. + #### Returns [`Message`](../interfaces/Message.md)[] +- Updated message history after deletion. + *** ### forward() > **forward**(`input`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L64) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:105](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L105) + +Runs model inference with raw input string. +You need to provide entire conversation and prompt (in correct format and with special tokens!) in input string to this method. +It doesn't manage conversation context. It is intended for users that need access to the model itself without any wrapper. +If you want a simple chat with model the consider using `sendMessage` #### Parameters @@ -102,17 +128,23 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro `string` +Raw input string containing the prompt and conversation history. + #### Returns `Promise`\<`string`\> +The generated response as a string. + *** ### generate() > **generate**(`messages`, `tools?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:69](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L69) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:117](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L117) + +Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. #### Parameters @@ -120,33 +152,45 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro [`Message`](../interfaces/Message.md)[] +Array of messages representing the chat history. + ##### tools? `Object`[] +Optional array of tools that can be used during generation. + #### Returns `Promise`\<`string`\> +The generated response as a string. + *** ### getGeneratedTokenCount() > **getGeneratedTokenCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:160](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L160) + +Returns the number of tokens generated in the last response. #### Returns `number` +The count of generated tokens. + *** ### interrupt() > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:84](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L84) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L151) + +Interrupts model generation. It may return one more token after interrupt. #### Returns @@ -158,28 +202,40 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L55) + +Loads the LLM model and tokenizer. #### Parameters ##### model +Object containing model, tokenizer, and tokenizer config sources. + ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) +`ResourceSource` that specifies the location of the model binary. + ###### tokenizerConfigSource [`ResourceSource`](../type-aliases/ResourceSource.md) +`ResourceSource` pointing to the JSON file which contains the tokenizer config. + ###### tokenizerSource [`ResourceSource`](../type-aliases/ResourceSource.md) +`ResourceSource` pointing to the JSON file which contains the tokenizer. + ##### onDownloadProgressCallback (`progress`) => `void` +Optional callback to track download progress (value between 0 and 1). + #### Returns `Promise`\<`void`\> @@ -190,7 +246,11 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:130](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L130) + +Method to add user message to conversation. +After model responds it will call `messageHistoryCallback()` containing both user message and model response. +It also returns them. #### Parameters @@ -198,21 +258,29 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro `string` +The message string to send. + #### Returns `Promise`\<[`Message`](../interfaces/Message.md)[]\> +- Updated message history including the new user message and model response. + *** ### setTokenCallback() -> **setTokenCallback**(`__namedParameters`): `void` +> **setTokenCallback**(`tokenCallback`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L44) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) + +Sets new token callback invoked on every token batch. #### Parameters -##### \_\_namedParameters +##### tokenCallback + +Callback function to handle new tokens. ###### tokenCallback diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md index 6c99e73ee..61563ca3c 100644 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -1,6 +1,6 @@ # Class: OCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **new OCRModule**(): `OCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index e4de045c7..4e839f275 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -1,6 +1,6 @@ # Class: ObjectDetectionModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) ## Extends @@ -26,7 +26,9 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) + +Native module instance #### Inherited from @@ -38,7 +40,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) + +Unloads the model from memory. #### Returns @@ -54,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) #### Parameters @@ -76,7 +80,10 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) + +Runs the model's forward method with the given input tensors. +It returns the output tensors that mimic the structure of output from ExecuTorch. #### Parameters @@ -84,10 +91,14 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http [`TensorPtr`](../interfaces/TensorPtr.md)[] +Array of input tensors. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +Array of output tensors. + #### Inherited from `BaseModule.forwardET` @@ -98,7 +109,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) + +Gets the input shape for a given method and index. #### Parameters @@ -106,14 +119,20 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `string` +method name + ##### index `number` +index of the argument which shape is requested + #### Returns `Promise`\<`number`[]\> +The input shape as an array of numbers. + #### Inherited from `BaseModule.getInputShape` @@ -124,7 +143,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md index 359e0ba0e..b6f3a5bb4 100644 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -1,6 +1,6 @@ # Class: ResourceFetcher -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](h > `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](h > `static` **cancelFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251]( > `static` **deleteResources**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278]( > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](h > `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290]( > `static` **listDownloadedFiles**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) #### Returns @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268]( > `static` **listDownloadedModels**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) #### Returns @@ -126,7 +126,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273]( > `static` **pauseFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) #### Parameters @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241]( > `static` **resumeFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) #### Parameters diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md index 605fc91de..2ad557e88 100644 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -1,6 +1,6 @@ # Class: RnExecutorchError -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/errorUtils.ts#L3) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/errorUtils.ts#L3) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https: > **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/errorUtils.ts#L14) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/errorUtils.ts#L14) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https > `optional` **cause**: `unknown` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/errorUtils.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/errorUtils.ts#L12) The original cause of the error, if any. @@ -56,7 +56,7 @@ The original cause of the error, if any. > **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/errorUtils.ts#L7) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/errorUtils.ts#L7) The error code representing the type of error. diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md index e74db2253..adb33064b 100644 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -1,6 +1,8 @@ # Class: SpeechToTextModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L10) + +Module for Speech to Text (STT) functionalities. ## Constructors @@ -18,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:94](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L94) Runs the decoder of the model. Passing number[] is deprecated. @@ -48,7 +50,9 @@ Decoded output. > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:51](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L51) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L64) + +Unloads the model from memory. #### Returns @@ -60,25 +64,35 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L55) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:75](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L75) + +Runs the encoding part of the model on the provided waveform. +Returns the encoded waveform as a Float32Array. Passing `number[]` is deprecated. #### Parameters ##### waveform +The input audio waveform. + `number`[] | `Float32Array`\<`ArrayBufferLike`\> #### Returns `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> +The encoded output. + *** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27) + +Loads the model specified by the config object. +`onDownloadProgressCallback` allows you to monitor the current progress of the model download. #### Parameters @@ -86,10 +100,14 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro [`SpeechToTextModelConfig`](../interfaces/SpeechToTextModelConfig.md) +Configuration object containing model sources. + ##### onDownloadProgressCallback (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> @@ -100,7 +118,11 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **stream**(`options`): `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:121](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L121) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L151) + +Starts a streaming transcription session. +Yields objects with `committed` and `nonCommitted` transcriptions. +Use with `streamInsert` and `streamStop` to control the stream. #### Parameters @@ -108,22 +130,30 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro [`DecodingOptions`](../interfaces/DecodingOptions.md) = `{}` +Decoding options including language. + #### Returns `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> +An async generator yielding transcription updates. + *** ### streamInsert() > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:176](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L176) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:211](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L211) + +Inserts a new audio chunk into the streaming transcription session. Passing `number[]` is deprecated. #### Parameters ##### waveform +The audio chunk to insert. + `number`[] | `Float32Array`\<`ArrayBufferLike`\> #### Returns @@ -136,7 +166,9 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:186](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L186) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:224](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L224) + +Stops the current streaming transcription session. #### Returns @@ -148,9 +180,11 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **transcribe**(`waveform`, `options`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:102](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L102) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:124](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L124) -Transcribes audio using the Whisper model. +Starts a transcription process for a given input array (16kHz waveform). +For multilingual models, specify the language in `options`. +Returns the transcription as a string. Passing `number[]` is deprecated. #### Parameters diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index b88c54a13..732bab437 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,6 @@ # Class: StyleTransferModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) ## Extends @@ -26,7 +26,9 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) + +Native module instance #### Inherited from @@ -38,7 +40,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) + +Unloads the model from memory. #### Returns @@ -54,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`imageSource`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) #### Parameters @@ -72,7 +76,10 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) + +Runs the model's forward method with the given input tensors. +It returns the output tensors that mimic the structure of output from ExecuTorch. #### Parameters @@ -80,10 +87,14 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http [`TensorPtr`](../interfaces/TensorPtr.md)[] +Array of input tensors. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +Array of output tensors. + #### Inherited from `BaseModule.forwardET` @@ -94,7 +105,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) + +Gets the input shape for a given method and index. #### Parameters @@ -102,14 +115,20 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `string` +method name + ##### index `number` +index of the argument which shape is requested + #### Returns `Promise`\<`number`[]\> +The input shape as an array of numbers. + #### Inherited from `BaseModule.getInputShape` @@ -120,7 +139,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index a25bf2df4..8d81802ba 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,8 @@ # Class: TextEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L10) + +Module for generating text embeddings from input text. ## Extends @@ -26,7 +28,9 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) + +Native module instance #### Inherited from @@ -38,7 +42,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) + +Unloads the model from memory. #### Returns @@ -54,7 +60,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L35) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:53](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L53) + +Executes the model's forward pass, where `input` is a text that will be embedded. #### Parameters @@ -62,17 +70,24 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro `string` +The text string to embed. + #### Returns `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> +A Float32Array containing the vector embeddings. + *** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) + +Runs the model's forward method with the given input tensors. +It returns the output tensors that mimic the structure of output from ExecuTorch. #### Parameters @@ -80,10 +95,14 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http [`TensorPtr`](../interfaces/TensorPtr.md)[] +Array of input tensors. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +Array of output tensors. + #### Inherited from `BaseModule.forwardET` @@ -94,7 +113,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) + +Gets the input shape for a given method and index. #### Parameters @@ -102,14 +123,20 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `string` +method name + ##### index `number` +index of the argument which shape is requested + #### Returns `Promise`\<`number`[]\> +The input shape as an array of numbers. + #### Inherited from `BaseModule.getInputShape` @@ -120,24 +147,34 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L20) + +Loads the model and tokenizer specified by the config object. #### Parameters ##### model +Object containing model and tokenizer sources. + ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) +`ResourceSource` that specifies the location of the text embeddings model binary. + ###### tokenizerSource [`ResourceSource`](../type-aliases/ResourceSource.md) +`ResourceSource` that specifies the location of the tokenizer JSON file. + ##### onDownloadProgressCallback (`progress`) => `void` +Optional callback to track download progress (value between 0 and 1). + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index ac20eacf6..21bdff597 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -1,6 +1,6 @@ # Class: TextToImageModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) #### Parameters @@ -34,7 +34,9 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) + +Native module instance #### Inherited from @@ -46,7 +48,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) + +Unloads the model from memory. #### Returns @@ -62,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) #### Parameters @@ -92,7 +96,10 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) + +Runs the model's forward method with the given input tensors. +It returns the output tensors that mimic the structure of output from ExecuTorch. #### Parameters @@ -100,10 +107,14 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http [`TensorPtr`](../interfaces/TensorPtr.md)[] +Array of input tensors. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +Array of output tensors. + #### Inherited from `BaseModule.forwardET` @@ -114,7 +125,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) + +Gets the input shape for a given method and index. #### Parameters @@ -122,14 +135,20 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `string` +method name + ##### index `number` +index of the argument which shape is requested + #### Returns `Promise`\<`number`[]\> +The input shape as an array of numbers. + #### Inherited from `BaseModule.getInputShape` @@ -140,7 +159,7 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) #### Returns @@ -152,7 +171,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextToSpeechModule.md b/docs/docs/06-api-reference/classes/TextToSpeechModule.md new file mode 100644 index 000000000..64f89b456 --- /dev/null +++ b/docs/docs/06-api-reference/classes/TextToSpeechModule.md @@ -0,0 +1,137 @@ +# Class: TextToSpeechModule + +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L14) + +Module for Text to Speech (TTS) functionalities. + +## Constructors + +### Constructor + +> **new TextToSpeechModule**(): `TextToSpeechModule` + +#### Returns + +`TextToSpeechModule` + +## Properties + +### nativeModule + +> **nativeModule**: `any` = `null` + +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L18) + +Native module instance + +## Methods + +### delete() + +> **delete**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:164](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L164) + +Unloads the model from memory. + +#### Returns + +`void` + +*** + +### forward() + +> **forward**(`text`, `speed`): `Promise`\<`any`\> + +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:97](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L97) + +Synthesizes the provided text into speech. +Returns a promise that resolves to the full audio waveform as a `Float32Array`. + +#### Parameters + +##### text + +`string` + +The input text to be synthesized. + +##### speed + +`number` = `1.0` + +Optional speed multiplier for the speech synthesis (default is 1.0). + +#### Returns + +`Promise`\<`any`\> + +A promise resolving to the synthesized audio waveform. + +*** + +### load() + +> **load**(`config`, `onDownloadProgressCallback`): `Promise`\<`void`\> + +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L27) + +Loads the model and voice assets specified by the config object. +`onDownloadProgressCallback` allows you to monitor the current progress. + +#### Parameters + +##### config + +[`TextToSpeechConfig`](../interfaces/TextToSpeechConfig.md) + +Configuration object containing `model` source, `voice` and optional `preventLoad`. + +##### onDownloadProgressCallback + +(`progress`) => `void` + +Optional callback to monitor download progress. + +#### Returns + +`Promise`\<`void`\> + +*** + +### stream() + +> **stream**(`input`): `AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>, `void`, `unknown`\> + +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:112](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L112) + +Starts a streaming synthesis session. Yields audio chunks as they are generated. + +#### Parameters + +##### input + +[`TextToSpeechStreamingInput`](../interfaces/TextToSpeechStreamingInput.md) + +Input object containing text and optional speed. + +#### Returns + +`AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>, `void`, `unknown`\> + +An async generator yielding Float32Array audio chunks. + +*** + +### streamStop() + +> **streamStop**(): `void` + +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:157](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L157) + +Stops the streaming process if there is any ongoing. + +#### Returns + +`void` diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md index 7fdddd9a0..3261e6231 100644 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -1,6 +1,6 @@ # Class: TokenizerModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) ## Constructors @@ -18,7 +18,9 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L10) + +Native module instance ## Methods @@ -26,7 +28,9 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L31) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L54) + +Converts an array of token IDs into a string. #### Parameters @@ -34,51 +38,69 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro `number`[] +Array of token IDs to be decoded. + ##### skipSpecialTokens `boolean` = `true` +Whether to skip special tokens during decoding (default: true). + #### Returns `Promise`\<`any`\> +The decoded string. + *** ### encode() -> **encode**(`s`): `Promise`\<`any`\> +> **encode**(`input`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:43](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L43) + +Converts a string into an array of token IDs. #### Parameters -##### s +##### input `string` +The input string to be tokenized. + #### Returns `Promise`\<`any`\> +An array of token IDs. + *** ### getVocabSize() > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L38) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L66) + +Returns the size of the tokenizer's vocabulary. #### Returns `Promise`\<`number`\> +The vocabulary size. + *** ### idToToken() > **idToToken**(`tokenId`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L42) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:76](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L76) + +Returns the token associated to the ID. #### Parameters @@ -86,22 +108,31 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro `number` +ID of the token. + #### Returns `Promise`\<`string`\> +The token string associated to ID. + *** ### load() > **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L19) + +Loads the tokenizer from the specified source. +`tokenizerSource` is a string that points to the location of the tokenizer JSON file. #### Parameters ##### tokenizer +Object containing `tokenizerSource`. + ###### tokenizerSource [`ResourceSource`](../type-aliases/ResourceSource.md) @@ -110,6 +141,8 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> @@ -120,7 +153,9 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L46) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L86) + +Returns the ID associated to the token. #### Parameters @@ -128,6 +163,10 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro `string` +The token string. + #### Returns `Promise`\<`number`\> + +The ID associated to the token. diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index 46583ae79..743c16607 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -1,6 +1,6 @@ # Class: VADModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) ## Extends @@ -26,7 +26,9 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) + +Native module instance #### Inherited from @@ -38,7 +40,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:5](https > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) + +Unloads the model from memory. #### Returns @@ -54,7 +58,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:21](http > **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L39) + +Executes the model's forward pass, where `waveform` is a Float32Array representing the audio signal. #### Parameters @@ -62,17 +68,24 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro `Float32Array` +The input audio waveform as a Float32Array. + #### Returns `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> +A promise resolving to an array of detected speech segments. + *** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L13) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) + +Runs the model's forward method with the given input tensors. +It returns the output tensors that mimic the structure of output from ExecuTorch. #### Parameters @@ -80,10 +93,14 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http [`TensorPtr`](../interfaces/TensorPtr.md)[] +Array of input tensors. + #### Returns `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> +Array of output tensors. + #### Inherited from `BaseModule.forwardET` @@ -94,7 +111,9 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:13](http > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/BaseModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) + +Gets the input shape for a given method and index. #### Parameters @@ -102,14 +121,20 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http `string` +method name + ##### index `number` +index of the argument which shape is requested + #### Returns `Promise`\<`number`[]\> +The input shape as an array of numbers. + #### Inherited from `BaseModule.getInputShape` @@ -120,12 +145,17 @@ Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:17](http > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L16) + +Loads the model, where `modelSource` is a string that specifies the location of the model binary. +To track the download progress, supply a callback function `onDownloadProgressCallback`. #### Parameters ##### model +Object containing `modelSource`. + ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) @@ -134,6 +164,8 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md index 7472eea21..0308d7c7c 100644 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -1,6 +1,6 @@ # Class: VerticalOCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **new VerticalOCRModule**(): `VerticalOCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/enumerations/CocoLabel.md b/docs/docs/06-api-reference/enumerations/CocoLabel.md index 6f082a06a..0388788ff 100644 --- a/docs/docs/06-api-reference/enumerations/CocoLabel.md +++ b/docs/docs/06-api-reference/enumerations/CocoLabel.md @@ -1,6 +1,6 @@ # Enumeration: CocoLabel -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:35](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L35) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:35](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L35) COCO dataset class labels used for object detection. @@ -10,7 +10,7 @@ COCO dataset class labels used for object detection. > **AIRPLANE**: `5` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L40) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L40) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](h > **APPLE**: `53` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L87) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L87) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](h > **BACKPACK**: `27` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L62) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L62) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](h > **BANANA**: `52` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L86) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L86) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](h > **BASEBALL**: `39` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L74) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L74) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](h > **BEAR**: `23` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L58) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L58) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](h > **BED**: `65` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L99) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L99) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](h > **BENCH**: `15` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L50) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L50) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](h > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L37) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L37) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](h > **BIRD**: `16` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L51) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L51) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](h > **BLENDER**: `83` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L117) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L117) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117]( > **BOAT**: `9` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L44) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L44) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](h > **BOOK**: `84` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L118) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L118) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118]( > **BOTTLE**: `44` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L78) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L78) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](h > **BOWL**: `51` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L85) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L85) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](h > **BROCCOLI**: `56` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L90) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L90) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](h > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L41) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L41) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](h > **CAKE**: `61` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L95) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L95) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](h > **CAR**: `3` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L38) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L38) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](h > **CARROT**: `57` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L91) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L91) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](h > **CAT**: `17` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L52) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L52) *** @@ -178,7 +178,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](h > **CELL\_PHONE**: `77` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L111) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L111) *** @@ -186,7 +186,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111]( > **CHAIR**: `62` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L96) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L96) *** @@ -194,7 +194,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](h > **CLOCK**: `85` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L119) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L119) *** @@ -202,7 +202,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119]( > **COUCH**: `63` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L97) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L97) *** @@ -210,7 +210,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](h > **COW**: `21` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L56) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L56) *** @@ -218,7 +218,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](h > **CUP**: `47` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L81) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L81) *** @@ -226,7 +226,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](h > **DESK**: `69` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L103) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L103) *** @@ -234,7 +234,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103]( > **DINING\_TABLE**: `67` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L101) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L101) *** @@ -242,7 +242,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101]( > **DOG**: `18` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L53) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L53) *** @@ -250,7 +250,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](h > **DONUT**: `60` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L94) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L94) *** @@ -258,7 +258,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](h > **DOOR**: `71` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L105) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L105) *** @@ -266,7 +266,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105]( > **ELEPHANT**: `22` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L57) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L57) *** @@ -274,7 +274,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](h > **EYE**: `30` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L65) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L65) *** @@ -282,7 +282,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](h > **FIRE\_HYDRANT**: `11` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L46) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L46) *** @@ -290,7 +290,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](h > **FORK**: `48` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L82) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L82) *** @@ -298,7 +298,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](h > **FRISBEE**: `34` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L69) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L69) *** @@ -306,7 +306,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](h > **GIRAFFE**: `25` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L60) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L60) *** @@ -314,7 +314,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](h > **HAIR\_BRUSH**: `91` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L125) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L125) *** @@ -322,7 +322,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125]( > **HAIR\_DRIER**: `89` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L123) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L123) *** @@ -330,7 +330,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123]( > **HANDBAG**: `31` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L66) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L66) *** @@ -338,7 +338,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](h > **HAT**: `26` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L61) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L61) *** @@ -346,7 +346,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](h > **HORSE**: `19` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L54) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L54) *** @@ -354,7 +354,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](h > **HOT\_DOG**: `58` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L92) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L92) *** @@ -362,7 +362,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](h > **KEYBOARD**: `76` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L110) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L110) *** @@ -370,7 +370,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110]( > **KITE**: `38` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L73) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L73) *** @@ -378,7 +378,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](h > **KNIFE**: `49` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L83) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L83) *** @@ -386,7 +386,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](h > **LAPTOP**: `73` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L107) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L107) *** @@ -394,7 +394,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107]( > **MICROWAVE**: `78` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L112) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L112) *** @@ -402,7 +402,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112]( > **MIRROR**: `66` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L100) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L100) *** @@ -410,7 +410,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100]( > **MOTORCYCLE**: `4` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L39) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L39) *** @@ -418,7 +418,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](h > **MOUSE**: `74` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L108) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L108) *** @@ -426,7 +426,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108]( > **ORANGE**: `55` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L89) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L89) *** @@ -434,7 +434,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](h > **OVEN**: `79` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L113) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L113) *** @@ -442,7 +442,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113]( > **PARKING**: `14` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L49) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L49) *** @@ -450,7 +450,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](h > **PERSON**: `1` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L36) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L36) *** @@ -458,7 +458,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](h > **PIZZA**: `59` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L93) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L93) *** @@ -466,7 +466,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](h > **PLATE**: `45` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L79) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L79) *** @@ -474,7 +474,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](h > **POTTED\_PLANT**: `64` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L98) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L98) *** @@ -482,7 +482,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](h > **REFRIGERATOR**: `82` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L116) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L116) *** @@ -490,7 +490,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116]( > **REMOTE**: `75` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L109) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L109) *** @@ -498,7 +498,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109]( > **SANDWICH**: `54` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L88) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L88) *** @@ -506,7 +506,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](h > **SCISSORS**: `87` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L121) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L121) *** @@ -514,7 +514,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121]( > **SHEEP**: `20` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L55) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L55) *** @@ -522,7 +522,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](h > **SHOE**: `29` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L64) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L64) *** @@ -530,7 +530,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](h > **SINK**: `81` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L115) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L115) *** @@ -538,7 +538,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115]( > **SKATEBOARD**: `41` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L75) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L75) *** @@ -546,7 +546,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](h > **SKIS**: `35` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L70) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L70) *** @@ -554,7 +554,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](h > **SNOWBOARD**: `36` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L71) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L71) *** @@ -562,7 +562,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](h > **SPOON**: `50` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L84) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L84) *** @@ -570,7 +570,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](h > **SPORTS**: `37` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L72) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L72) *** @@ -578,7 +578,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](h > **STOP\_SIGN**: `13` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L48) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L48) *** @@ -586,7 +586,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](h > **STREET\_SIGN**: `12` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L47) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L47) *** @@ -594,7 +594,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](h > **SUITCASE**: `33` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L68) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L68) *** @@ -602,7 +602,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](h > **SURFBOARD**: `42` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L76) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L76) *** @@ -610,7 +610,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](h > **TEDDY\_BEAR**: `88` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L122) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L122) *** @@ -618,7 +618,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122]( > **TENNIS\_RACKET**: `43` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L77) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L77) *** @@ -626,7 +626,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](h > **TIE**: `32` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L67) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L67) *** @@ -634,7 +634,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](h > **TOASTER**: `80` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L114) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L114) *** @@ -642,7 +642,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114]( > **TOILET**: `70` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L104) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L104) *** @@ -650,7 +650,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104]( > **TOOTHBRUSH**: `90` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L124) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L124) *** @@ -658,7 +658,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124]( > **TRAFFIC\_LIGHT**: `10` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L45) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L45) *** @@ -666,7 +666,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](h > **TRAIN**: `7` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L42) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L42) *** @@ -674,7 +674,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](h > **TRUCK**: `8` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L43) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L43) *** @@ -682,7 +682,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](h > **TV**: `72` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L106) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L106) *** @@ -690,7 +690,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106]( > **UMBRELLA**: `28` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L63) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L63) *** @@ -698,7 +698,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](h > **VASE**: `86` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L120) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L120) *** @@ -706,7 +706,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120]( > **WINDOW**: `68` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L102) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L102) *** @@ -714,7 +714,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102]( > **WINE\_GLASS**: `46` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L80) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L80) *** @@ -722,4 +722,4 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](h > **ZEBRA**: `24` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L59) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L59) diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md index 36fdbbd86..e684e0e70 100644 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -1,6 +1,6 @@ # Enumeration: DeeplabLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5]( > **AEROPLANE**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7]( > **ARGMAX**: `21` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27] > **BACKGROUND**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) *** @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6]( > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) *** @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8]( > **BIRD**: `3` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) *** @@ -48,7 +48,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9]( > **BOAT**: `4` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) *** @@ -56,7 +56,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10] > **BOTTLE**: `5` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) *** @@ -64,7 +64,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11] > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) *** @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12] > **CAR**: `7` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) *** @@ -80,7 +80,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13] > **CAT**: `8` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) *** @@ -88,7 +88,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14] > **CHAIR**: `9` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) *** @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15] > **COW**: `10` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) *** @@ -104,7 +104,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16] > **DININGTABLE**: `11` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) *** @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17] > **DOG**: `12` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) *** @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18] > **HORSE**: `13` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) *** @@ -128,7 +128,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19] > **MOTORBIKE**: `14` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) *** @@ -136,7 +136,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20] > **PERSON**: `15` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) *** @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21] > **POTTEDPLANT**: `16` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) *** @@ -152,7 +152,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22] > **SHEEP**: `17` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) *** @@ -160,7 +160,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23] > **SOFA**: `18` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) *** @@ -168,7 +168,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24] > **TRAIN**: `19` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) *** @@ -176,4 +176,4 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25] > **TVMONITOR**: `20` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md index 228dc0eab..5f19a1251 100644 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -1,6 +1,6 @@ # Enumeration: RnExecutorchErrorCode -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https: > **AccessFailed**: `34` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](http > **DelegateInvalidCompatibility**: `48` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](http > **DelegateInvalidHandle**: `50` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) *** @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](http > **DelegateMemoryAllocationFailed**: `49` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) *** @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](http > **DownloadInterrupted**: `118` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) Thrown when the number of downloaded files is unexpected, due to download interruptions. @@ -50,7 +50,7 @@ Thrown when the number of downloaded files is unexpected, due to download interr > **EndOfMethod**: `3` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](http > **FileReadFailed**: `114` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. @@ -68,7 +68,7 @@ Thrown when a file read operation failed. This could be invalid image url passed > **FileWriteFailed**: `103` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) An error ocurred when saving a file. This could be, for instance a result image from an image model. @@ -78,7 +78,7 @@ An error ocurred when saving a file. This could be, for instance a result image > **Internal**: `1` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) *** @@ -86,7 +86,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](http > **InvalidArgument**: `18` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) *** @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](http > **InvalidConfig**: `112` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. @@ -104,7 +104,7 @@ Thrown when config parameters passed to a model are invalid. For example, when L > **InvalidExternalData**: `36` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) *** @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](http > **InvalidModelOutput**: `115` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) Thrown when the size of model output is unexpected. @@ -122,7 +122,7 @@ Thrown when the size of model output is unexpected. > **InvalidModelSource**: `255` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) Thrown when the type of model source passed by the user is invalid. @@ -132,7 +132,7 @@ Thrown when the type of model source passed by the user is invalid. > **InvalidProgram**: `35` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) *** @@ -140,7 +140,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](http > **InvalidState**: `2` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) *** @@ -148,7 +148,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](http > **InvalidType**: `19` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) *** @@ -156,7 +156,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](http > **InvalidUserInput**: `117` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). @@ -166,7 +166,7 @@ Thrown when the input passed to our APIs is invalid, for example when passing an > **LanguageNotSupported**: `105` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. @@ -176,7 +176,7 @@ Thrown when a language is passed to a multi-language model that is not supported > **MemoryAllocationFailed**: `33` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) *** @@ -184,7 +184,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](http > **MissingDataChunk**: `161` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) Thrown when streaming transcription is attempted but audio data chunk is missing. @@ -194,7 +194,7 @@ Thrown when streaming transcription is attempted but audio data chunk is missing > **ModelGenerating**: `104` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. @@ -204,7 +204,7 @@ Thrown when a user tries to run a model that is currently processing. It is only > **ModuleNotLoaded**: `102` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. @@ -214,7 +214,7 @@ Thrown when a user tries to run a model that is not yet downloaded or loaded int > **MultilingualConfiguration**: `160` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. @@ -224,7 +224,7 @@ Thrown when there's a configuration mismatch between multilingual and language s > **NotFound**: `32` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) *** @@ -232,7 +232,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](http > **NotImplemented**: `17` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) *** @@ -240,7 +240,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](http > **NotSupported**: `16` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) *** @@ -248,7 +248,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](http > **Ok**: `0` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) *** @@ -256,7 +256,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](http > **OperatorMissing**: `20` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) *** @@ -264,7 +264,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](http > **OutOfResources**: `37` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) *** @@ -272,7 +272,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](http > **ResourceFetcherAlreadyOngoing**: `183` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) Thrown when trying to resume a download that is already ongoing. @@ -282,7 +282,7 @@ Thrown when trying to resume a download that is already ongoing. > **ResourceFetcherAlreadyPaused**: `182` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) Thrown when trying to pause a download that is already paused. @@ -292,7 +292,7 @@ Thrown when trying to pause a download that is already paused. > **ResourceFetcherDownloadFailed**: `180` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. @@ -302,7 +302,7 @@ Thrown when a resource fails to download. This could be due to invalid URL, or f > **ResourceFetcherDownloadInProgress**: `181` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) Thrown when a user tries to trigger a download that's already in progress. @@ -312,7 +312,7 @@ Thrown when a user tries to trigger a download that's already in progress. > **ResourceFetcherMissingUri**: `185` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) Thrown when required URI information is missing for a download operation. @@ -322,7 +322,7 @@ Thrown when required URI information is missing for a download operation. > **ResourceFetcherNotActive**: `184` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) Thrown when trying to pause, resume, or cancel a download that is not active. @@ -332,7 +332,7 @@ Thrown when trying to pause, resume, or cancel a download that is not active. > **StreamingInProgress**: `163` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) Thrown when trying to start a new streaming session while another is already in progress. @@ -342,7 +342,7 @@ Thrown when trying to start a new streaming session while another is already in > **StreamingNotStarted**: `162` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) Thrown when trying to stop or insert data into a stream that hasn't been started. @@ -352,7 +352,7 @@ Thrown when trying to stop or insert data into a stream that hasn't been started > **ThreadPoolError**: `113` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) Thrown when React Native ExecuTorch threadpool problem occurs. @@ -362,7 +362,7 @@ Thrown when React Native ExecuTorch threadpool problem occurs. > **UnexpectedNumInputs**: `97` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) Thrown when the number of passed inputs to the model is different than the model metadata specifies. @@ -372,7 +372,7 @@ Thrown when the number of passed inputs to the model is different than the model > **UnknownError**: `101` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. @@ -382,6 +382,6 @@ An umbrella-error that is thrown usually when something unexpected happens, for > **WrongDimensions**: `116` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md index c2f0d5f12..b3749c068 100644 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -1,6 +1,6 @@ # Enumeration: ScalarType -Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L13) +Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L13) Enum representing the scalar types of tensors. @@ -10,7 +10,7 @@ Enum representing the scalar types of tensors. > **BITS16**: `22` -Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L28) +Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L28) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://gi > **BOOL**: `11` -Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L22) +Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L22) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://gi > **BYTE**: `0` -Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L14) +Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L14) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://gi > **CHAR**: `1` -Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L15) +Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L15) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://gi > **DOUBLE**: `7` -Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L21) +Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L21) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://gi > **FLOAT**: `6` -Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L20) +Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L20) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://gi > **FLOAT8E4M3FN**: `24` -Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L30) +Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L30) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://gi > **FLOAT8E4M3FNUZ**: `26` -Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L32) +Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L32) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://gi > **FLOAT8E5M2**: `23` -Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L29) +Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L29) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://gi > **FLOAT8E5M2FNUZ**: `25` -Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L31) +Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L31) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://gi > **HALF**: `5` -Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L19) +Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L19) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://gi > **INT**: `3` -Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L17) +Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L17) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://gi > **LONG**: `4` -Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L18) +Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L18) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://gi > **QINT32**: `14` -Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L25) +Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L25) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://gi > **QINT8**: `12` -Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L23) +Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L23) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://gi > **QUINT2X4**: `17` -Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L27) +Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L27) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://gi > **QUINT4X2**: `16` -Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L26) +Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L26) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://gi > **QUINT8**: `13` -Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L24) +Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L24) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://gi > **SHORT**: `2` -Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L16) +Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L16) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://gi > **UINT16**: `27` -Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L33) +Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L33) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://gi > **UINT32**: `28` -Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L34) +Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L34) *** @@ -178,4 +178,4 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://gi > **UINT64**: `29` -Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L35) +Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L35) diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md index fa6269ad0..6e61a84fd 100644 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -2,7 +2,7 @@ > **DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT**(`structuredOutputSchema`): `string` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) ## Parameters diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md index 9f31e4c79..687e5c30c 100644 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -2,7 +2,7 @@ > **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> -Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/llm.ts#L81) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/llm.ts#L81) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md index f678fa3cc..efc121e3c 100644 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -2,7 +2,7 @@ > **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` -Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/llm.ts#L50) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/llm.ts#L50) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md index 4fef03761..d9be62d48 100644 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -2,7 +2,7 @@ > **useClassification**(`ClassificationConfiguration`): [`ClassificationType`](../interfaces/ClassificationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L11) React hook for managing a Classification model instance. diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md index 96f6abd20..122fb5ec9 100644 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -2,7 +2,7 @@ > **useExecutorchModule**(`executorchModuleConfiguration`): [`ExecutorchModuleType`](../interfaces/ExecutorchModuleType.md) -Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L11) React hook for managing an arbitrary Executorch module instance. diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md index 3ab4c79f6..3ba04c50f 100644 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -2,7 +2,7 @@ > **useImageEmbeddings**(`ImageEmbeddingsConfiguration`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L11) React hook for managing an Image Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md index 69e0fa6c1..e99941043 100644 --- a/docs/docs/06-api-reference/functions/useImageSegmentation.md +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -2,7 +2,7 @@ > **useImageSegmentation**(`ImageSegmentationConfiguration`): [`ImageSegmentationType`](../interfaces/ImageSegmentationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L11) React hook for managing an Image Segmentation model instance. diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md index eebaddcf4..bc6f51ab3 100644 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -2,7 +2,7 @@ > **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L20) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L18) React hook for managing a Large Language Model (LLM) instance. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md index 2655135d3..6e271f649 100644 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -1,33 +1,21 @@ # Function: useOCR() -> **useOCR**(`__namedParameters`): `OCRModule` +> **useOCR**(`OCRConfiguration`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L12) -## Parameters - -### \_\_namedParameters - -#### model - -\{ `detectorSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `language`: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"`; `recognizerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); \} - -#### model.detectorSource +React hook for managing an OCR instance. -[`ResourceSource`](../type-aliases/ResourceSource.md) - -#### model.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"` - -#### model.recognizerSource +## Parameters -[`ResourceSource`](../type-aliases/ResourceSource.md) +### OCRConfiguration -#### preventLoad? +[`OCRProps`](../interfaces/OCRProps.md) -`boolean` = `false` +Configuration object containing `model` sources and optional `preventLoad` flag. ## Returns -`OCRModule` +[`OCRType`](../interfaces/OCRType.md) + +Ready to use OCR model. diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md index 6d83789f6..bf7d54e9a 100644 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -2,7 +2,7 @@ > **useObjectDetection**(`ObjectDetectionConfiguration`): [`ObjectDetectionType`](../interfaces/ObjectDetectionType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L11) React hook for managing an Object Detection model instance. diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md index 4075be2da..d590708ce 100644 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -2,7 +2,7 @@ > **useSpeechToText**(`speechToTextConfiguration`): [`SpeechToTextType`](../interfaces/SpeechToTextType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) React hook for managing a Speech to Text (STT) instance. diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md index e381b0ca5..c8e0e53fe 100644 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -1,51 +1,21 @@ # Function: useStyleTransfer() -> **useStyleTransfer**(`__namedParameters`): `object` +> **useStyleTransfer**(`StyleTransferConfiguration`): [`StyleTransferType`](../interfaces/StyleTransferType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L10) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L11) -## Parameters - -### \_\_namedParameters - -`Props` - -## Returns - -### downloadProgress - -> **downloadProgress**: `number` - -Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. - -### error - -> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` +React hook for managing a Style Transfer model instance. -Contains the error message if the model failed to load. - -### forward() - -> **forward**: (...`input`) => `Promise`\<`string`\> - -#### Parameters - -##### input - -...\[`string`\] - -#### Returns - -`Promise`\<`string`\> +## Parameters -### isGenerating +### StyleTransferConfiguration -> **isGenerating**: `boolean` +[`StyleTransferProps`](../interfaces/StyleTransferProps.md) -Indicates whether the model is currently generating a response. +Configuration object containing `model` source and optional `preventLoad` flag. -### isReady +## Returns -> **isReady**: `boolean` +[`StyleTransferType`](../interfaces/StyleTransferType.md) -Indicates whether the model is ready. +Ready to use Style Transfer model. diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md index d2e15de71..a12fd0b6f 100644 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -2,7 +2,7 @@ > **useTextEmbeddings**(`TextEmbeddingsConfiguration`): [`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) React hook for managing a Text Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md index a0b097b4a..01458c61b 100644 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -1,45 +1,21 @@ # Function: useTextToImage() -> **useTextToImage**(`__namedParameters`): `TextToImageType` +> **useTextToImage**(`TextToImageConfiguration`): [`TextToImageType`](../interfaces/TextToImageType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L21) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L13) -## Parameters - -### \_\_namedParameters - -#### inferenceCallback? - -(`stepIdx`) => `void` - -#### model - -\{ `decoderSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `encoderSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `schedulerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `tokenizerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `unetSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); \} - -#### model.decoderSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) +React hook for managing a Text to Image instance. -#### model.encoderSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -#### model.schedulerSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -#### model.tokenizerSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -#### model.unetSource +## Parameters -[`ResourceSource`](../type-aliases/ResourceSource.md) +### TextToImageConfiguration -#### preventLoad? +[`TextToImageParams`](../interfaces/TextToImageParams.md) -`boolean` = `false` +Configuration object containing `model` source, `inferenceCallback`, and optional `preventLoad` flag. ## Returns -`TextToImageType` +[`TextToImageType`](../interfaces/TextToImageType.md) + +Ready to use Text to Image model. diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md index 5264e655d..54fd038ad 100644 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -2,7 +2,7 @@ > **useTextToSpeech**(`TextToSpeechConfiguration`): [`TextToSpeechType`](../interfaces/TextToSpeechType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:18](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L18) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L18) React hook for managing Text to Speech instance. diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md index ef4b940ed..42c0ed24a 100644 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -2,7 +2,7 @@ > **useTokenizer**(`tokenizerConfiguration`): [`TokenizerType`](../interfaces/TokenizerType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) React hook for managing a Tokenizer instance. diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md index bc0bebf8c..4cde0f29c 100644 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -2,7 +2,7 @@ > **useVAD**(`VADConfiguration`): [`VADType`](../interfaces/VADType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) React hook for managing a VAD model instance. diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md index 72d1ba83a..20ec87399 100644 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -1,37 +1,21 @@ # Function: useVerticalOCR() -> **useVerticalOCR**(`__namedParameters`): `OCRModule` +> **useVerticalOCR**(`VerticalOCRConfiguration`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L15) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L12) -## Parameters - -### \_\_namedParameters - -#### independentCharacters? - -`boolean` = `false` - -#### model - -\{ `detectorSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); `language`: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"`; `recognizerSource`: [`ResourceSource`](../type-aliases/ResourceSource.md); \} +React hook for managing a Vertical OCR instance. -#### model.detectorSource - -[`ResourceSource`](../type-aliases/ResourceSource.md) - -#### model.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"` - -#### model.recognizerSource +## Parameters -[`ResourceSource`](../type-aliases/ResourceSource.md) +### VerticalOCRConfiguration -#### preventLoad? +[`VerticalOCRProps`](../interfaces/VerticalOCRProps.md) -`boolean` = `false` +Configuration object containing `model` sources, optional `independentCharacters` and `preventLoad` flag. ## Returns -`OCRModule` +[`OCRType`](../interfaces/OCRType.md) + +Ready to use Vertical OCR model. diff --git a/docs/docs/06-api-reference/index.md b/docs/docs/06-api-reference/index.md index cf0eced8c..e6224515d 100644 --- a/docs/docs/06-api-reference/index.md +++ b/docs/docs/06-api-reference/index.md @@ -22,6 +22,7 @@ - [StyleTransferModule](classes/StyleTransferModule.md) - [TextEmbeddingsModule](classes/TextEmbeddingsModule.md) - [TextToImageModule](classes/TextToImageModule.md) +- [TextToSpeechModule](classes/TextToSpeechModule.md) - [TokenizerModule](classes/TokenizerModule.md) - [VADModule](classes/VADModule.md) - [VerticalOCRModule](classes/VerticalOCRModule.md) @@ -43,18 +44,25 @@ - [ImageSegmentationType](interfaces/ImageSegmentationType.md) - [KokoroConfig](interfaces/KokoroConfig.md) - [KokoroVoiceExtras](interfaces/KokoroVoiceExtras.md) +- [LLMConfig](interfaces/LLMConfig.md) - [LLMType](interfaces/LLMType.md) - [Message](interfaces/Message.md) - [ObjectDetectionProps](interfaces/ObjectDetectionProps.md) - [ObjectDetectionType](interfaces/ObjectDetectionType.md) - [OCRDetection](interfaces/OCRDetection.md) +- [OCRProps](interfaces/OCRProps.md) +- [OCRType](interfaces/OCRType.md) - [Point](interfaces/Point.md) - [Segment](interfaces/Segment.md) - [SpeechToTextModelConfig](interfaces/SpeechToTextModelConfig.md) - [SpeechToTextType](interfaces/SpeechToTextType.md) +- [StyleTransferProps](interfaces/StyleTransferProps.md) +- [StyleTransferType](interfaces/StyleTransferType.md) - [TensorPtr](interfaces/TensorPtr.md) - [TextEmbeddingsProps](interfaces/TextEmbeddingsProps.md) - [TextEmbeddingsType](interfaces/TextEmbeddingsType.md) +- [TextToImageParams](interfaces/TextToImageParams.md) +- [TextToImageType](interfaces/TextToImageType.md) - [TextToSpeechConfig](interfaces/TextToSpeechConfig.md) - [TextToSpeechInput](interfaces/TextToSpeechInput.md) - [TextToSpeechProps](interfaces/TextToSpeechProps.md) @@ -65,6 +73,7 @@ - [ToolsConfig](interfaces/ToolsConfig.md) - [VADProps](interfaces/VADProps.md) - [VADType](interfaces/VADType.md) +- [VerticalOCRProps](interfaces/VerticalOCRProps.md) - [VoiceConfig](interfaces/VoiceConfig.md) ## Type Aliases diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md index 321210463..9350b9e52 100644 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -1,6 +1,6 @@ # Interface: Bbox -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L12) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L12) Represents a bounding box for a detected object in an image. @@ -10,7 +10,7 @@ Represents a bounding box for a detected object in an image. > **x1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L13) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L13) The x-coordinate of the bottom-left corner of the bounding box. @@ -20,7 +20,7 @@ The x-coordinate of the bottom-left corner of the bounding box. > **x2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L14) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L14) The x-coordinate of the top-right corner of the bounding box. @@ -30,7 +30,7 @@ The x-coordinate of the top-right corner of the bounding box. > **y1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L15) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L15) The y-coordinate of the bottom-left corner of the bounding box. @@ -40,6 +40,6 @@ The y-coordinate of the bottom-left corner of the bounding box. > **y2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L16) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L16) The y-coordinate of the top-right corner of the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md index cfd2eaf89..228939536 100644 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -1,6 +1,6 @@ # Interface: ChatConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L154) +Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L168) Object configuring chat management. @@ -10,7 +10,7 @@ Object configuring chat management. > **contextWindowLength**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:163](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L163) +Defined in: [packages/react-native-executorch/src/types/llm.ts:170](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L170) The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. @@ -20,7 +20,7 @@ The number of messages from the current conversation that the model will use to > **initialMessageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:158](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L158) +Defined in: [packages/react-native-executorch/src/types/llm.ts:169](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L169) An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. @@ -30,6 +30,6 @@ An array of `Message` objects that represent the conversation history. This can > **systemPrompt**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L168) +Defined in: [packages/react-native-executorch/src/types/llm.ts:171](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L171) Often used to tell the model what is its purpose, for example - "Be a helpful translator". diff --git a/docs/docs/06-api-reference/interfaces/ClassificationProps.md b/docs/docs/06-api-reference/interfaces/ClassificationProps.md index 3a91f5eff..64dbb213c 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationProps.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationProps.md @@ -1,6 +1,6 @@ # Interface: ClassificationProps -Defined in: packages/react-native-executorch/src/types/classification.ts:11 +Defined in: [packages/react-native-executorch/src/types/classification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L11) Props for the `useClassification` hook. @@ -10,7 +10,7 @@ Props for the `useClassification` hook. > **model**: `object` -Defined in: packages/react-native-executorch/src/types/classification.ts:12 +Defined in: [packages/react-native-executorch/src/types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: packages/react-native-executorch/src/types/classification.ts:13 +Defined in: [packages/react-native-executorch/src/types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ClassificationType.md b/docs/docs/06-api-reference/interfaces/ClassificationType.md index 75d80f324..5b893ac33 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationType.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationType.md @@ -1,6 +1,6 @@ # Interface: ClassificationType -Defined in: packages/react-native-executorch/src/types/classification.ts:20 +Defined in: [packages/react-native-executorch/src/types/classification.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L20) Return type for the `useClassification` hook. Manages the state and operations for Computer Vision image classification. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image classification. > **downloadProgress**: `number` -Defined in: packages/react-native-executorch/src/types/classification.ts:39 +Defined in: [packages/react-native-executorch/src/types/classification.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: packages/react-native-executorch/src/types/classification.ts:24 +Defined in: [packages/react-native-executorch/src/types/classification.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during classification. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: packages/react-native-executorch/src/types/classification.ts:47 +Defined in: [packages/react-native-executorch/src/types/classification.ts:47](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L47) Executes the model's forward pass to classify the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: packages/react-native-executorch/src/types/classification.ts:34 +Defined in: [packages/react-native-executorch/src/types/classification.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L34) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: packages/react-native-executorch/src/types/classification.ts:29 +Defined in: [packages/react-native-executorch/src/types/classification.ts:29](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L29) Indicates whether the classification model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md index 82c033f68..192170d88 100644 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -1,6 +1,6 @@ # Interface: DecodingOptions -Defined in: [packages/react-native-executorch/src/types/stt.ts:167](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L167) +Defined in: [packages/react-native-executorch/src/types/stt.ts:169](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L169) Options for decoding speech to text. @@ -10,6 +10,6 @@ Options for decoding speech to text. > `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:171](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L171) +Defined in: [packages/react-native-executorch/src/types/stt.ts:170](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L170) Optional language code to guide the transcription. diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md index 844a3a605..5dee19f9d 100644 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -1,6 +1,6 @@ # Interface: Detection -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L26) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L26) Represents a detected object within an image, including its bounding box, label, and confidence score. @@ -10,7 +10,7 @@ Represents a detected object within an image, including its bounding box, label, > **bbox**: [`Bbox`](Bbox.md) -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L27) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L27) The bounding box of the detected object, defined by its top-left (x1, y1) and bottom-right (x2, y2) coordinates. @@ -20,7 +20,7 @@ The bounding box of the detected object, defined by its top-left (x1, y1) and bo > **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L28) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L28) The class label of the detected object, represented as a key from the `CocoLabel` enum. @@ -30,6 +30,6 @@ The class label of the detected object, represented as a key from the `CocoLabel > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L29) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L29) The confidence score of the detection, typically ranging from 0 to 1. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md index d7b5cd966..c139caa0a 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleProps -Defined in: packages/react-native-executorch/src/types/executorchModule.ts:10 +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L10) Props for the `useExecutorchModule` hook. @@ -10,7 +10,7 @@ Props for the `useExecutorchModule` hook. > **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: packages/react-native-executorch/src/types/executorchModule.ts:11 +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L11) The source of the ExecuTorch model binary. @@ -20,6 +20,6 @@ The source of the ExecuTorch model binary. > `optional` **preventLoad**: `boolean` -Defined in: packages/react-native-executorch/src/types/executorchModule.ts:12 +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L12) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md index bca85c568..bffc00767 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleType -Defined in: packages/react-native-executorch/src/types/executorchModule.ts:19 +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L19) Return type for the `useExecutorchModule` hook. Manages the state and core execution methods for a general ExecuTorch model. @@ -11,7 +11,7 @@ Manages the state and core execution methods for a general ExecuTorch model. > **downloadProgress**: `number` -Defined in: packages/react-native-executorch/src/types/executorchModule.ts:38 +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L38) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: packages/react-native-executorch/src/types/executorchModule.ts:23 +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L23) Contains the error object if the model failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`inputTensor`) => `Promise`\<[`TensorPtr`](TensorPtr.md)[]\> -Defined in: packages/react-native-executorch/src/types/executorchModule.ts:46 +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L46) Executes the model's forward pass with the provided input tensors. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another request. > **isGenerating**: `boolean` -Defined in: packages/react-native-executorch/src/types/executorchModule.ts:33 +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:33](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L33) Indicates whether the model is currently processing a forward pass. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing a forward pass. > **isReady**: `boolean` -Defined in: packages/react-native-executorch/src/types/executorchModule.ts:28 +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L28) Indicates whether the ExecuTorch model binary has successfully loaded into memory and is ready for inference. diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md index 5558956d2..922238020 100644 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -1,6 +1,6 @@ # Interface: GenerationConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:194](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L194) +Defined in: [packages/react-native-executorch/src/types/llm.ts:195](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L195) Object configuring generation settings. @@ -10,7 +10,7 @@ Object configuring generation settings. > `optional` **batchTimeInterval**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:213](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L213) +Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L199) Upper limit on the time interval between consecutive token batches. @@ -20,7 +20,7 @@ Upper limit on the time interval between consecutive token batches. > `optional` **outputTokenBatchSize**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:208](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L208) +Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L198) Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). @@ -30,7 +30,7 @@ Soft upper limit on the number of tokens in each token batch (in certain cases t > `optional` **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L198) +Defined in: [packages/react-native-executorch/src/types/llm.ts:196](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L196) Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. @@ -40,6 +40,6 @@ Scales output logits by the inverse of temperature. Controls the randomness / cr > `optional` **topp**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:203](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L203) +Defined in: [packages/react-native-executorch/src/types/llm.ts:197](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L197) Only samples from the smallest set of tokens whose cumulative probability exceeds topp. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md index 82a637b1e..4de3735c1 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsProps -Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:11 +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L11) Props for the `useImageEmbeddings` hook. @@ -10,7 +10,7 @@ Props for the `useImageEmbeddings` hook. > **model**: `object` -Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:12 +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:13 +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md index 22b9cc74b..32944a4c4 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsType -Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:20 +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L20) Return type for the `useImageEmbeddings` hook. Manages the state and operations for generating image embeddings (feature vectors) used in Computer Vision tasks. @@ -11,7 +11,7 @@ Manages the state and operations for generating image embeddings (feature vector > **downloadProgress**: `number` -Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:39 +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:24 +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during embedding generation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:47 +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:47](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L47) Executes the model's forward pass to generate embeddings (a feature vector) for the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:34 +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L34) Indicates whether the model is currently generating embeddings for an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently generating embeddings for an image. > **isReady**: `boolean` -Defined in: packages/react-native-executorch/src/types/imageEmbeddings.ts:29 +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:29](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L29) Indicates whether the image embeddings model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md index 9e51f966f..ecea4d4c2 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md @@ -1,6 +1,6 @@ # Interface: ImageSegmentationProps -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:37](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L37) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:37](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L37) Props for the `useImageSegmentation` hook. @@ -10,7 +10,7 @@ Props for the `useImageSegmentation` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L38) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:38](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L38) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:39](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L39) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L39) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md index 951e05de3..60e428415 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md @@ -1,6 +1,6 @@ # Interface: ImageSegmentationType -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L46) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L46) Return type for the `useImageSegmentation` hook. Manages the state and operations for Computer Vision image segmentation (e.g., DeepLab). @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image segmentation (e.g., D > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:65](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L65) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:65](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L65) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:50](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L50) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:50](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L50) Contains the error object if the model failed to load, download, or encountered a runtime error during segmentation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `classesOfInterest?`, `resize?`) => `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:75](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L75) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:75](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L75) Executes the model's forward pass to perform semantic segmentation on the provided image. @@ -71,7 +71,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L60) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L60) Indicates whether the model is currently processing an image. @@ -81,6 +81,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:55](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/imageSegmentation.ts#L55) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:55](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L55) Indicates whether the segmentation model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/KokoroConfig.md b/docs/docs/06-api-reference/interfaces/KokoroConfig.md index fef23c156..dde13e0d1 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroConfig.md +++ b/docs/docs/06-api-reference/interfaces/KokoroConfig.md @@ -1,6 +1,6 @@ # Interface: KokoroConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:34](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L34) +Defined in: [packages/react-native-executorch/src/types/tts.ts:43](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L43) Kokoro model configuration. Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. @@ -11,7 +11,9 @@ Only the core Kokoro model sources, as phonemizer sources are included in voice > **durationPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:36](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L36) +Defined in: [packages/react-native-executorch/src/types/tts.ts:45](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L45) + +source to Kokoro's duration predictor model binary *** @@ -19,7 +21,9 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:36](https://githu > **synthesizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:37](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L37) +Defined in: [packages/react-native-executorch/src/types/tts.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L46) + +source to Kokoro's synthesizer model binary *** @@ -27,4 +31,6 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:37](https://githu > **type**: `"kokoro"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:35](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L35) +Defined in: [packages/react-native-executorch/src/types/tts.ts:44](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L44) + +model type identifier diff --git a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md index a5185ae5e..6d0668984 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md +++ b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md @@ -1,6 +1,8 @@ # Interface: KokoroVoiceExtras -Defined in: [packages/react-native-executorch/src/types/tts.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L25) +Defined in: [packages/react-native-executorch/src/types/tts.ts:30](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L30) + +Kokoro-specific voice extra props ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:25](https://githu > **lexiconSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:27](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L27) +Defined in: [packages/react-native-executorch/src/types/tts.ts:32](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L32) + +source to Kokoro's lexicon binary *** @@ -16,4 +20,6 @@ Defined in: [packages/react-native-executorch/src/types/tts.ts:27](https://githu > **taggerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L26) +Defined in: [packages/react-native-executorch/src/types/tts.ts:31](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L31) + +source to Kokoro's tagger model binary diff --git a/docs/docs/06-api-reference/interfaces/LLMConfig.md b/docs/docs/06-api-reference/interfaces/LLMConfig.md new file mode 100644 index 000000000..961294ebf --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/LLMConfig.md @@ -0,0 +1,55 @@ +# Interface: LLMConfig + +Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L93) + +Configuration object for initializing and customizing a Large Language Model (LLM) instance. + +## Properties + +### chatConfig? + +> `optional` **chatConfig**: `Partial`\<[`ChatConfig`](ChatConfig.md)\> + +Defined in: [packages/react-native-executorch/src/types/llm.ts:103](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L103) + +Object configuring chat management, contains following properties: + +`systemPrompt` - Often used to tell the model what is its purpose, for example - "Be a helpful translator". + +`initialMessageHistory` - An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. + +`contextWindowLength` - The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. + +*** + +### generationConfig? + +> `optional` **generationConfig**: [`GenerationConfig`](GenerationConfig.md) + +Defined in: [packages/react-native-executorch/src/types/llm.ts:127](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L127) + +Object configuring generation settings. + +`outputTokenBatchSize` - Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). + +`batchTimeInterval` - Upper limit on the time interval between consecutive token batches. + +`temperature` - Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. + +`topp` - Only samples from the smallest set of tokens whose cumulative probability exceeds topp. + +*** + +### toolsConfig? + +> `optional` **toolsConfig**: [`ToolsConfig`](ToolsConfig.md) + +Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L114) + +Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: + +`tools` - List of objects defining tools. + +`executeToolCallback` - Function that accepts `ToolCall`, executes tool and returns the string to model. + +`displayToolCalls` - If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md index 1b9ebc1b3..b62a3a15c 100644 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -1,6 +1,6 @@ # Interface: LLMType -Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L6) +Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L6) React hook for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ React hook for managing a Large Language Model (LLM) instance. > **configure**: (`configuration`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L48) +Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L48) Configures chat and tool calling. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -19,45 +19,9 @@ See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM ##### configuration -Configuration object containing `chatConfig`, `toolsConfig`, and `generationConfig`. - -###### chatConfig? - -`Partial`\<[`ChatConfig`](ChatConfig.md)\> - -Object configuring chat management, contains following properties: - -`systemPrompt` - Often used to tell the model what is its purpose, for example - "Be a helpful translator". - -`initialMessageHistory` - An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. - -`contextWindowLength` - The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. - -###### generationConfig? - -[`GenerationConfig`](GenerationConfig.md) - -Object configuring generation settings. +[`LLMConfig`](LLMConfig.md) -`outputTokenBatchSize` - Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). - -`batchTimeInterval` - Upper limit on the time interval between consecutive token batches. - -`temperature` - Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. - -`topp` - Only samples from the smallest set of tokens whose cumulative probability exceeds topp. - -###### toolsConfig? - -[`ToolsConfig`](ToolsConfig.md) - -Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: - -`tools` - List of objects defining tools. - -`executeToolCallback` - Function that accepts `ToolCall`, executes tool and returns the string to model. - -`displayToolCalls` - If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. +Configuration object containing `chatConfig`, `toolsConfig`, and `generationConfig`. #### Returns @@ -69,7 +33,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > **deleteMessage**: (`index`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L114) +Defined in: [packages/react-native-executorch/src/types/llm.ts:82](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L82) Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. @@ -91,7 +55,7 @@ The index of the message to delete from history. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L35) +Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L35) Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. @@ -101,7 +65,7 @@ Represents the download progress as a value between 0 and 1, indicating the exte > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L40) +Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L40) Contains the error message if the model failed to load. @@ -111,7 +75,7 @@ Contains the error message if the model failed to load. > **generate**: (`messages`, `tools?`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:100](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L100) +Defined in: [packages/react-native-executorch/src/types/llm.ts:67](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L67) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -139,7 +103,7 @@ Optional array of tools that can be used during generation. > **getGeneratedTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L93) +Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L59) Returns the number of tokens generated so far in the current generation. @@ -155,7 +119,7 @@ The count of generated tokens. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:119](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L119) +Defined in: [packages/react-native-executorch/src/types/llm.ts:87](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L87) Function to interrupt the current inference. @@ -169,7 +133,7 @@ Function to interrupt the current inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L30) +Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L30) Indicates whether the model is currently generating a response. @@ -179,7 +143,7 @@ Indicates whether the model is currently generating a response. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L25) +Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L25) Indicates whether the model is ready. @@ -189,7 +153,7 @@ Indicates whether the model is ready. > **messageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L10) +Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L10) History containing all messages in conversation. This field is updated after model responds to sendMessage. @@ -199,7 +163,7 @@ History containing all messages in conversation. This field is updated after mod > **response**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L15) +Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L15) State of the generated response. This field is updated with each token generated by the model. @@ -209,7 +173,7 @@ State of the generated response. This field is updated with each token generated > **sendMessage**: (`message`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:107](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L107) +Defined in: [packages/react-native-executorch/src/types/llm.ts:75](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L75) Function to add user message to conversation. After model responds, `messageHistory` will be updated with both user message and model response. @@ -232,6 +196,6 @@ The message string to send. > **token**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L20) +Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L20) The most recently generated token. diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md index c9f41e77e..1ffb02558 100644 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -1,6 +1,6 @@ # Interface: Message -Defined in: [packages/react-native-executorch/src/types/llm.ts:130](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L130) +Defined in: [packages/react-native-executorch/src/types/llm.ts:141](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L141) Represents a message in the conversation. @@ -10,7 +10,7 @@ Represents a message in the conversation. > **content**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:139](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L139) +Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L143) Content of the message. @@ -20,6 +20,6 @@ Content of the message. > **role**: [`MessageRole`](../type-aliases/MessageRole.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:134](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L134) +Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L142) Role of the message sender of type `MessageRole`. diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md index 2694b24c2..bb638915b 100644 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -1,6 +1,9 @@ # Interface: OCRDetection -Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L3) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L13) + +OCRDetection represents a single detected text instance in an image, +including its bounding box, recognized text, and confidence score. ## Properties @@ -8,7 +11,9 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:3](https://github > **bbox**: [`Point`](Point.md)[] -Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L4) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L14) + +An array of points defining the bounding box around the detected text. *** @@ -16,7 +21,9 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:4](https://github > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L6) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L16) + +The confidence score of the OCR detection, ranging from 0 to 1. *** @@ -24,4 +31,6 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:6](https://github > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L5) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L15) + +The recognized text within the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/OCRProps.md b/docs/docs/06-api-reference/interfaces/OCRProps.md new file mode 100644 index 000000000..fc40660a5 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/OCRProps.md @@ -0,0 +1,48 @@ +# Interface: OCRProps + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:33](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L33) + +Configuration properties for the `useOCR` hook. + +## Extended by + +- [`VerticalOCRProps`](VerticalOCRProps.md) + +## Properties + +### model + +> **model**: `object` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L37) + +Object containing the necessary model sources and configuration for the OCR pipeline. + +#### detectorSource + +> **detectorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +`ResourceSource` that specifies the location of the text detector model binary. + +#### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +The language configuration enum for the OCR model (e.g., English, Polish, etc.). + +#### recognizerSource + +> **recognizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +`ResourceSource` that specifies the location of the text recognizer model binary. + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L58) + +Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. +Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/OCRType.md b/docs/docs/06-api-reference/interfaces/OCRType.md new file mode 100644 index 000000000..7cd77240a --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/OCRType.md @@ -0,0 +1,74 @@ +# Interface: OCRType + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:76](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L76) + +Return type for the `useOCR` hook. +Manages the state and operations for Optical Character Recognition (OCR). + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:95](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L95) + +Represents the total download progress of the model binaries as a value between 0 and 1. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L80) + +Contains the error object if the models failed to load, download, or encountered a runtime error during recognition. + +*** + +### forward() + +> **forward**: (`imageSource`) => `Promise`\<[`OCRDetection`](OCRDetection.md)[]\> + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L103) + +Executes the OCR pipeline (detection and recognition) on the provided image. + +#### Parameters + +##### imageSource + +`string` + +A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. + +#### Returns + +`Promise`\<[`OCRDetection`](OCRDetection.md)[]\> + +A Promise that resolves to the OCR results (typically containing the recognized text strings and their bounding boxes). + +#### Throws + +If the models are not loaded or are currently processing another image. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:90](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L90) + +Indicates whether the model is currently processing an image. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:85](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L85) + +Indicates whether both detector and recognizer models are loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md index c67b3077d..23f8a6b7a 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionProps -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:135](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L135) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:135](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L135) Props for the `useObjectDetection` hook. @@ -10,7 +10,7 @@ Props for the `useObjectDetection` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:136](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L136) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:136](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L136) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:137](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L137) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:137](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L137) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md index baa51b37f..7d027dc5d 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionType -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:144](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L144) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:144](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L144) Return type for the `useObjectDetection` hook. Manages the state and operations for Computer Vision object detection tasks. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision object detection tasks. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:163](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L163) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:163](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L163) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:148](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L148) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:148](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L148) Contains the error object if the model failed to load, download, or encountered a runtime error during detection. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `detectionThreshold?`) => `Promise`\<[`Detection`](Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:172](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L172) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:172](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L172) Executes the model's forward pass to detect objects within the provided image. @@ -65,7 +65,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:158](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L158) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:158](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L158) Indicates whether the model is currently processing an image. @@ -75,6 +75,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:153](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/objectDetection.ts#L153) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:153](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L153) Indicates whether the object detection model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/Point.md b/docs/docs/06-api-reference/interfaces/Point.md index 527fac294..c2dc4bee1 100644 --- a/docs/docs/06-api-reference/interfaces/Point.md +++ b/docs/docs/06-api-reference/interfaces/Point.md @@ -1,6 +1,8 @@ # Interface: Point -Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L9) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L25) + +Point represents a coordinate in 2D space. ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:9](https://github > **x**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L10) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L26) + +The x-coordinate of the point. *** @@ -16,4 +20,6 @@ Defined in: [packages/react-native-executorch/src/types/ocr.ts:10](https://githu > **y**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L11) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L27) + +The y-coordinate of the point. diff --git a/docs/docs/06-api-reference/interfaces/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index 14ff242e8..5b128f4c4 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,6 @@ # Interface: Segment -Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L22) +Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L22) Represents a detected audio segment with start and end timestamps. @@ -10,7 +10,7 @@ Represents a detected audio segment with start and end timestamps. > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:31](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L31) +Defined in: [packages/react-native-executorch/src/types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L24) End time of the segment in seconds. @@ -20,6 +20,6 @@ End time of the segment in seconds. > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L26) +Defined in: [packages/react-native-executorch/src/types/vad.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L23) Start time of the segment in seconds. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md index 2be4723ac..1f2192224 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextModelConfig -Defined in: [packages/react-native-executorch/src/types/stt.ts:177](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L177) +Defined in: [packages/react-native-executorch/src/types/stt.ts:176](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L176) Configuration for Speech to Text model. @@ -10,7 +10,7 @@ Configuration for Speech to Text model. > **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:191](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L191) +Defined in: [packages/react-native-executorch/src/types/stt.ts:190](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L190) A string that specifies the location of a `.pte` file for the decoder. @@ -20,7 +20,7 @@ A string that specifies the location of a `.pte` file for the decoder. > **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:186](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L186) +Defined in: [packages/react-native-executorch/src/types/stt.ts:185](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L185) A string that specifies the location of a `.pte` file for the encoder. @@ -30,7 +30,7 @@ A string that specifies the location of a `.pte` file for the encoder. > **isMultilingual**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:181](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L181) +Defined in: [packages/react-native-executorch/src/types/stt.ts:180](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L180) A boolean flag indicating whether the model supports multiple languages. @@ -40,6 +40,6 @@ A boolean flag indicating whether the model supports multiple languages. > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:196](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L196) +Defined in: [packages/react-native-executorch/src/types/stt.ts:195](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L195) A string that specifies the location to the tokenizer for the model. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md index f8d03cd79..21bf0efe7 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextType -Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L7) +Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L7) React hook for managing Speech to Text (STT) instance. @@ -10,7 +10,7 @@ React hook for managing Speech to Text (STT) instance. > **committedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L32) +Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L32) Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. @@ -21,7 +21,7 @@ Useful for displaying stable results during streaming. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L26) +Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L26) Tracks the progress of the model download process. @@ -31,7 +31,7 @@ Tracks the progress of the model download process. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L11) +Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L11) Contains the error message if the model failed to load. @@ -41,7 +41,7 @@ Contains the error message if the model failed to load. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L21) +Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L21) Indicates whether the model is currently processing an inference. @@ -51,7 +51,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L16) +Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L16) Indicates whether the model has successfully loaded and is ready for inference. @@ -61,7 +61,7 @@ Indicates whether the model has successfully loaded and is ready for inference. > **nonCommittedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L38) +Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L38) Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. @@ -72,7 +72,7 @@ Useful for displaying live, partial results during streaming. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L53) +Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L53) Runs the decoder of the model. Passing `number[]` is deprecated. @@ -102,7 +102,7 @@ A promise resolving to the decoded text. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L45) +Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L45) Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. @@ -126,7 +126,7 @@ A promise resolving to the encoded data. > **stream**(`options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L71) +Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L71) Starts a streaming transcription process. Use in combination with streamInsert to feed audio chunks and streamStop to end the stream. @@ -152,7 +152,7 @@ The final transcription string. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L78) +Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L78) Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Passing `number[]` is deprecated. @@ -175,7 +175,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L83) +Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L83) Stops the ongoing streaming transcription process. @@ -189,7 +189,7 @@ Stops the ongoing streaming transcription process. > **transcribe**(`waveform`, `options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L62) +Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L62) Starts a transcription process for a given input array, which should be a waveform at 16kHz. Passing `number[]` is deprecated. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md new file mode 100644 index 000000000..0a59d2e2a --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md @@ -0,0 +1,29 @@ +# Interface: StyleTransferProps + +Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:11 + +Configuration properties for the `useStyleTransfer` hook. + +## Properties + +### model + +> **model**: `object` + +Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:12 + +Object containing the `modelSource` for the style transfer model. + +#### modelSource + +> **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:13 + +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 new file mode 100644 index 000000000..28a63f20c --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/StyleTransferType.md @@ -0,0 +1,74 @@ +# Interface: StyleTransferType + +Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:20 + +Return type for the `useStyleTransfer` hook. +Manages the state and operations for applying artistic style transfer to images. + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:39 + +Represents the download progress of the model binary as a value between 0 and 1. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:24 + +Contains the error object if the model failed to load, download, or encountered a runtime error during style transfer. + +*** + +### forward() + +> **forward**: (`imageSource`) => `Promise`\<`string`\> + +Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:47 + +Executes the model's forward pass to apply the specific artistic style to the provided image. + +#### Parameters + +##### imageSource + +`string` + +A string representing the input image source (e.g., a file path, URI, or base64 string) to be stylized. + +#### Returns + +`Promise`\<`string`\> + +A Promise that resolves to a string containing the stylized image (typically as a base64 string or a file URI). + +#### Throws + +If the model is not loaded or is currently processing another image. + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:34 + +Indicates whether the model is currently processing an image. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:29 + +Indicates whether the style transfer model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md index 2299da15e..47b483595 100644 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -1,6 +1,8 @@ # Interface: TensorPtr -Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L51) +Defined in: [packages/react-native-executorch/src/types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L61) + +Represents a pointer to a tensor, including its data buffer, size dimensions, and scalar type. ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:51](https://gi > **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L52) +Defined in: [packages/react-native-executorch/src/types/common.ts:62](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L62) + +The data buffer of the tensor. *** @@ -16,7 +20,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:52](https://gi > **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L54) +Defined in: [packages/react-native-executorch/src/types/common.ts:64](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L64) + +The scalar type of the tensor, as defined in the `ScalarType` enum. *** @@ -24,4 +30,6 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:54](https://gi > **sizes**: `number`[] -Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L53) +Defined in: [packages/react-native-executorch/src/types/common.ts:63](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L63) + +An array representing the size of each dimension of the tensor. diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md index 4a1aba11f..95894a9fa 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:40](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L40) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:45](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L45) Props for the useTextEmbeddings hook. @@ -10,26 +10,24 @@ Props for the useTextEmbeddings hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:41](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L41) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L46) + +An object containing the model and tokenizer sources. #### modelSource > **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -`ResourceSource` that specifies the location of the model binary. - #### tokenizerSource > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -`ResourceSource` pointing to the JSON file which contains the tokenizer. - *** ### preventLoad? > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:56](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L56) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L50) 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 1ba529aee..e11871ef7 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) React hook state and methods for managing a Text Embeddings model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Text Embeddings model instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) Tracks the progress of the model download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the model download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) Contains the error message if the model failed to load or during inference. @@ -30,7 +30,7 @@ Contains the error message if the model failed to load or during inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) Indicates whether the model is currently generating embeddings. @@ -40,7 +40,7 @@ Indicates whether the model is currently generating embeddings. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) Indicates whether the embeddings model has successfully loaded and is ready for inference. @@ -50,10 +50,9 @@ Indicates whether the embeddings model has successfully loaded and is ready for > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) Runs the text embeddings model on the provided input string. -* #### Parameters diff --git a/docs/docs/06-api-reference/interfaces/TextToImageParams.md b/docs/docs/06-api-reference/interfaces/TextToImageParams.md new file mode 100644 index 000000000..248bbd728 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TextToImageParams.md @@ -0,0 +1,79 @@ +# Interface: TextToImageParams + +Defined in: packages/react-native-executorch/src/types/tti.ts:7 + +Configuration properties for the `useTextToImage` hook. + +## Properties + +### inferenceCallback()? + +> `optional` **inferenceCallback**: (`stepIdx`) => `void` + +Defined in: packages/react-native-executorch/src/types/tti.ts:29 + +Optional callback function that is triggered after each diffusion inference step. +Useful for updating a progress bar during image generation. + +#### Parameters + +##### stepIdx + +`number` + +The index of the current inference step. + +#### Returns + +`void` + +*** + +### model + +> **model**: `object` + +Defined in: packages/react-native-executorch/src/types/tti.ts:11 + +Object containing the required model sources for the diffusion pipeline. + +#### decoderSource + +> **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Source for the VAE decoder model binary, used to decode the final image. + +#### encoderSource + +> **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Source for the text encoder model binary. + +#### schedulerSource + +> **schedulerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Source for the diffusion scheduler binary/config. + +#### tokenizerSource + +> **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Source for the text tokenizer binary/config. + +#### unetSource + +> **unetSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +Source for the UNet (noise predictor) model binary. + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: packages/react-native-executorch/src/types/tti.ts:35 + +Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. +Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageType.md b/docs/docs/06-api-reference/interfaces/TextToImageType.md new file mode 100644 index 000000000..fa99b1815 --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/TextToImageType.md @@ -0,0 +1,106 @@ +# Interface: TextToImageType + +Defined in: packages/react-native-executorch/src/types/tti.ts:42 + +Return type for the `useTextToImage` hook. +Manages the state and operations for generating images from text prompts using a diffusion model pipeline. + +## Properties + +### downloadProgress + +> **downloadProgress**: `number` + +Defined in: packages/react-native-executorch/src/types/tti.ts:61 + +Represents the total download progress of all the model binaries combined, as a value between 0 and 1. + +*** + +### error + +> **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` + +Defined in: packages/react-native-executorch/src/types/tti.ts:46 + +Contains the error object if any of the pipeline models failed to load, download, or encountered a runtime error. + +*** + +### generate() + +> **generate**: (`input`, `imageSize?`, `numSteps?`, `seed?`) => `Promise`\<`string`\> + +Defined in: packages/react-native-executorch/src/types/tti.ts:72 + +Runs the diffusion pipeline to generate an image from the provided text prompt. + +#### Parameters + +##### input + +`string` + +The text prompt describing the desired image. + +##### imageSize? + +`number` + +Optional. The target width and height of the generated image (e.g., 512 for 512x512). Defaults to the model's standard size if omitted. + +##### numSteps? + +`number` + +Optional. The number of denoising steps for the diffusion process. More steps generally yield higher quality at the cost of generation time. + +##### seed? + +`number` + +Optional. A random seed for reproducible generation. + +#### Returns + +`Promise`\<`string`\> + +A Promise that resolves to a string representing the generated image (e.g., base64 string or file URI). + +#### Throws + +If the model is not loaded or is currently generating another image. + +*** + +### interrupt() + +> **interrupt**: () => `void` + +Defined in: packages/react-native-executorch/src/types/tti.ts:82 + +Interrupts the currently active image generation process at the next available inference step. + +#### Returns + +`void` + +*** + +### isGenerating + +> **isGenerating**: `boolean` + +Defined in: packages/react-native-executorch/src/types/tti.ts:56 + +Indicates whether the model is currently generating an image. + +*** + +### isReady + +> **isReady**: `boolean` + +Defined in: packages/react-native-executorch/src/types/tti.ts:51 + +Indicates whether the entire diffusion pipeline is loaded into memory and ready for generation. diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md index 5e843276f..ab3c5afb7 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:47](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L47) +Defined in: [packages/react-native-executorch/src/types/tts.ts:56](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L56) General Text to Speech module configuration @@ -14,7 +14,7 @@ General Text to Speech module configuration > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L48) +Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L57) a selected T2S model @@ -24,6 +24,6 @@ a selected T2S model > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:49](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L49) +Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L58) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md index 07980c579..9a049b3ef 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:69](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L69) +Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L78) Text to Speech module input definition @@ -14,7 +14,7 @@ Text to Speech module input definition > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:71](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L71) +Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L80) optional speed argument - the higher it is, the faster the speech becomes @@ -24,6 +24,6 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:70](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L70) +Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L79) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md index 237630003..c4f504f37 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechProps -Defined in: [packages/react-native-executorch/src/types/tts.ts:59](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L59) +Defined in: [packages/react-native-executorch/src/types/tts.ts:68](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L68) Props for the useTextToSpeech hook. @@ -14,7 +14,7 @@ Props for the useTextToSpeech hook. > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L48) +Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L57) a selected T2S model @@ -28,7 +28,7 @@ a selected T2S model > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L60) +Defined in: [packages/react-native-executorch/src/types/tts.ts:69](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L69) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. @@ -38,7 +38,7 @@ Boolean that can prevent automatic model loading (and downloading the data if yo > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:49](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L49) +Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L58) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md index fd2e1b572..9002d9128 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechStreamingInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:133](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L133) +Defined in: [packages/react-native-executorch/src/types/tts.ts:142](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L142) Text to Speech streaming input definition @@ -19,7 +19,7 @@ Callbacks can be both synchronous or asynchronous. > `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:134](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L134) +Defined in: [packages/react-native-executorch/src/types/tts.ts:143](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L143) Called when streaming begins @@ -33,7 +33,7 @@ Called when streaming begins > `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:136](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L136) +Defined in: [packages/react-native-executorch/src/types/tts.ts:145](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L145) Called when streaming ends @@ -47,7 +47,7 @@ Called when streaming ends > `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:135](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L135) +Defined in: [packages/react-native-executorch/src/types/tts.ts:144](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L144) Called after each audio chunk gets calculated. @@ -67,7 +67,7 @@ Called after each audio chunk gets calculated. > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:71](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L71) +Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L80) optional speed argument - the higher it is, the faster the speech becomes @@ -81,7 +81,7 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:70](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L70) +Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L79) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md index 4bae59bd6..a70520b31 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechType -Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L78) +Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L87) Return type for the `useTextToSpeech` hook. Manages the state and operations for Text-to-Speech generation. @@ -11,7 +11,7 @@ Manages the state and operations for Text-to-Speech generation. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:97](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L97) +Defined in: [packages/react-native-executorch/src/types/tts.ts:106](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L106) Represents the download progress of the model and voice assets as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model and voice assets as a value betwee > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tts.ts:82](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L82) +Defined in: [packages/react-native-executorch/src/types/tts.ts:91](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L91) Contains the error object if the model failed to load or encountered an error during inference. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load or encountered an error du > **forward**: (`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:105](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L105) +Defined in: [packages/react-native-executorch/src/types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L114) Runs the model to convert the provided text into speech audio in a single pass. * @@ -60,7 +60,7 @@ If the model is not loaded or is currently generating. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:92](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L92) +Defined in: [packages/react-native-executorch/src/types/tts.ts:101](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L101) Indicates whether the model is currently generating audio. @@ -70,7 +70,7 @@ Indicates whether the model is currently generating audio. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L87) +Defined in: [packages/react-native-executorch/src/types/tts.ts:96](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L96) Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. @@ -80,7 +80,7 @@ Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. > **stream**: (`input`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L114) +Defined in: [packages/react-native-executorch/src/types/tts.ts:123](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L123) Streams the generated audio data incrementally. This is optimal for real-time playback, allowing audio to start playing before the full text is synthesized. @@ -110,7 +110,7 @@ If the model is not loaded or is currently generating. > **streamStop**: () => `void` -Defined in: [packages/react-native-executorch/src/types/tts.ts:119](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L119) +Defined in: [packages/react-native-executorch/src/types/tts.ts:128](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L128) Interrupts and stops the currently active audio generation stream. diff --git a/docs/docs/06-api-reference/interfaces/TokenizerType.md b/docs/docs/06-api-reference/interfaces/TokenizerType.md index efcb6753e..3839846ed 100644 --- a/docs/docs/06-api-reference/interfaces/TokenizerType.md +++ b/docs/docs/06-api-reference/interfaces/TokenizerType.md @@ -1,6 +1,6 @@ # Interface: TokenizerType -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L6) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L6) React hook state and methods for managing a Tokenizer instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Tokenizer instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L25) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L25) Tracks the progress of the tokenizer download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the tokenizer download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L10) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L10) Contains the error message if the tokenizer failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the tokenizer failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L20) Indicates whether the tokenizer is currently processing data. @@ -40,7 +40,7 @@ Indicates whether the tokenizer is currently processing data. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L15) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L15) Indicates whether the tokenizer has successfully loaded and is ready for use. @@ -50,7 +50,7 @@ Indicates whether the tokenizer has successfully loaded and is ready for use. > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:32](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L32) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:33](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L33) Converts an array of token IDs into a string. @@ -64,6 +64,8 @@ An array or `number[]` of token IDs to decode. ##### skipSpecialTokens +Optional boolean to indicate whether special tokens should be skipped during decoding. + `boolean` | `undefined` #### Returns @@ -78,7 +80,7 @@ A promise resolving to the decoded text string. > **encode**(`text`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L39) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L40) Converts a string into an array of token IDs. @@ -102,7 +104,7 @@ A promise resolving to an array `number[]` containing the encoded token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:45](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L45) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L46) Returns the size of the tokenizer's vocabulary. @@ -118,7 +120,7 @@ A promise resolving to the vocabulary size. > **idToToken**(`id`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:52](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L52) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:53](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L53) Returns the token associated to the ID. @@ -142,7 +144,7 @@ A promise resolving to the token string representation. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:59](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tokenizer.ts#L59) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L60) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md index c18b570c9..2cdcb5963 100644 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -1,6 +1,8 @@ # Interface: ToolCall -Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L142) +Defined in: [packages/react-native-executorch/src/types/llm.ts:152](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L152) + +Represents a tool call made by the model. ## Properties @@ -8,7 +10,9 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://gith > **arguments**: `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L144) +Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L154) + +The arguments passed to the tool. *** @@ -16,4 +20,6 @@ Defined in: [packages/react-native-executorch/src/types/llm.ts:144](https://gith > **toolName**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L143) +Defined in: [packages/react-native-executorch/src/types/llm.ts:153](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L153) + +The name of the tool being called. diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md index 82c165a85..cee924c09 100644 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -1,6 +1,6 @@ # Interface: ToolsConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:174](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L174) +Defined in: [packages/react-native-executorch/src/types/llm.ts:181](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L181) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. @@ -10,7 +10,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > `optional` **displayToolCalls**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:188](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L188) +Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L184) If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. @@ -20,7 +20,7 @@ If set to true, JSON tool calls will be displayed in chat. If false, only answer > **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L183) +Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L183) Function that accepts `ToolCall`, executes tool and returns the string to model. @@ -40,6 +40,6 @@ Function that accepts `ToolCall`, executes tool and returns the string to model. > **tools**: `Object`[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:178](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L178) +Defined in: [packages/react-native-executorch/src/types/llm.ts:182](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L182) List of objects defining tools. diff --git a/docs/docs/06-api-reference/interfaces/VADProps.md b/docs/docs/06-api-reference/interfaces/VADProps.md index 75df093ba..7c604be4c 100644 --- a/docs/docs/06-api-reference/interfaces/VADProps.md +++ b/docs/docs/06-api-reference/interfaces/VADProps.md @@ -1,6 +1,6 @@ # Interface: VADProps -Defined in: [packages/react-native-executorch/src/types/vad.ts:7](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L7) +Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L11) Props for the useVAD hook. @@ -10,9 +10,9 @@ Props for the useVAD hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L11) +Defined in: [packages/react-native-executorch/src/types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L12) -`ResourceSource` that specifies the location of the VAD model binary. +An object containing the model source. #### modelSource @@ -24,6 +24,6 @@ Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://githu > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L16) +Defined in: [packages/react-native-executorch/src/types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/VADType.md b/docs/docs/06-api-reference/interfaces/VADType.md index 31b131fd7..d3199af92 100644 --- a/docs/docs/06-api-reference/interfaces/VADType.md +++ b/docs/docs/06-api-reference/interfaces/VADType.md @@ -1,6 +1,6 @@ # Interface: VADType -Defined in: [packages/react-native-executorch/src/types/vad.ts:37](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L37) +Defined in: [packages/react-native-executorch/src/types/vad.ts:30](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L30) React hook state and methods for managing a Voice Activity Detection (VAD) model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Voice Activity Detection (VAD) model > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:56](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L56) +Defined in: [packages/react-native-executorch/src/types/vad.ts:49](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L49) Represents the download progress as a value between 0 and 1. @@ -20,7 +20,7 @@ Represents the download progress as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/vad.ts:41](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L41) +Defined in: [packages/react-native-executorch/src/types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L34) Contains the error message if the VAD model failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the VAD model failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:51](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L51) +Defined in: [packages/react-native-executorch/src/types/vad.ts:44](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L44) Indicates whether the model is currently processing an inference. @@ -40,7 +40,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L46) +Defined in: [packages/react-native-executorch/src/types/vad.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L39) Indicates whether the VAD model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the VAD model has successfully loaded and is ready for inferen > **forward**(`waveform`): `Promise`\<[`Segment`](Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/types/vad.ts:64](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/vad.ts#L64) +Defined in: [packages/react-native-executorch/src/types/vad.ts:57](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L57) Runs the Voice Activity Detection model on the provided audio waveform. diff --git a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md new file mode 100644 index 000000000..65f523e3b --- /dev/null +++ b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md @@ -0,0 +1,67 @@ +# Interface: VerticalOCRProps + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:64](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L64) + +Configuration properties for the `useVerticalOCR` hook. + +## Extends + +- [`OCRProps`](OCRProps.md) + +## Properties + +### independentCharacters? + +> `optional` **independentCharacters**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:69](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L69) + +Boolean indicating whether to treat each character independently during recognition. +Defaults to `false`. + +*** + +### model + +> **model**: `object` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L37) + +Object containing the necessary model sources and configuration for the OCR pipeline. + +#### detectorSource + +> **detectorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +`ResourceSource` that specifies the location of the text detector model binary. + +#### language + +> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` + +The language configuration enum for the OCR model (e.g., English, Polish, etc.). + +#### recognizerSource + +> **recognizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) + +`ResourceSource` that specifies the location of the text recognizer model binary. + +#### Inherited from + +[`OCRProps`](OCRProps.md).[`model`](OCRProps.md#model) + +*** + +### preventLoad? + +> `optional` **preventLoad**: `boolean` + +Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L58) + +Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. +Defaults to `false`. + +#### Inherited from + +[`OCRProps`](OCRProps.md).[`preventLoad`](OCRProps.md#preventload) diff --git a/docs/docs/06-api-reference/interfaces/VoiceConfig.md b/docs/docs/06-api-reference/interfaces/VoiceConfig.md index 017184d22..91c4af134 100644 --- a/docs/docs/06-api-reference/interfaces/VoiceConfig.md +++ b/docs/docs/06-api-reference/interfaces/VoiceConfig.md @@ -1,6 +1,6 @@ # Interface: VoiceConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L18) +Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L18) Voice configuration @@ -12,7 +12,7 @@ So far in Kokoro, each voice is directly associated with a language. > `optional` **extra**: [`KokoroVoiceExtras`](KokoroVoiceExtras.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L21) +Defined in: [packages/react-native-executorch/src/types/tts.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L21) an optional extra sources or properties related to specific voice @@ -22,7 +22,7 @@ an optional extra sources or properties related to specific voice > **lang**: [`TextToSpeechLanguage`](../type-aliases/TextToSpeechLanguage.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L19) +Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L19) speaker's language @@ -32,6 +32,6 @@ speaker's language > **voiceSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L20) a source to a binary file with voice embedding diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md index 683613aee..3b7a6f4aa 100644 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -2,4 +2,4 @@ > **LLMTool** = `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:149](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L149) +Defined in: [packages/react-native-executorch/src/types/llm.ts:159](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L159) diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md index 1e8220ec8..0ca6b8487 100644 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -2,6 +2,6 @@ > **MessageRole** = `"user"` \| `"assistant"` \| `"system"` -Defined in: [packages/react-native-executorch/src/types/llm.ts:125](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L125) +Defined in: [packages/react-native-executorch/src/types/llm.ts:133](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L133) Roles that a message sender can have. diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md index c8a40bb4d..57be01894 100644 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -2,4 +2,6 @@ > **OCRLanguage** = keyof *typeof* `symbols` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/ocr.ts#L14) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:109](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L109) + +Enumeration of supported OCR languages based on available symbol sets. diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md index 858dfb26b..140c96b19 100644 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -2,6 +2,6 @@ > **ResourceSource** = `string` \| `number` \| `object` -Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L8) +Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L8) Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md index 551281453..129ba28ec 100644 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -2,4 +2,4 @@ > **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/stt.ts#L87) +Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L87) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md index 2940e2aa4..a2ea26485 100644 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -2,4 +2,6 @@ > **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` -Defined in: [packages/react-native-executorch/src/types/common.ts:38](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/common.ts#L38) +Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L41) + +Represents the data buffer of a tensor, which can be one of several typed array formats. diff --git a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md index 2f8050be3..49ccaf7b1 100644 --- a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md @@ -2,4 +2,4 @@ > **TextToSpeechLanguage** = `"en-us"` \| `"en-gb"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:5](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/tts.ts#L5) +Defined in: [packages/react-native-executorch/src/types/tts.ts:5](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L5) diff --git a/docs/docs/06-api-reference/typedoc-sidebar.cjs b/docs/docs/06-api-reference/typedoc-sidebar.cjs index 943f2fb67..16f0f6d2b 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:"Enumerations",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/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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/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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleProps",label:"ExecutorchModuleProps"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleType",label:"ExecutorchModuleType"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsProps",label:"ImageEmbeddingsProps"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsType",label:"ImageEmbeddingsType"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationProps",label:"ImageSegmentationProps"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationType",label:"ImageSegmentationType"},{type:"doc",id:"06-api-reference/interfaces/KokoroConfig",label:"KokoroConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroVoiceExtras",label:"KokoroVoiceExtras"},{type:"doc",id:"06-api-reference/interfaces/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/Point",label:"Point"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextType",label:"SpeechToTextType"},{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/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/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/VADProps",label:"VADProps"},{type:"doc",id:"06-api-reference/interfaces/VADType",label:"VADType"},{type:"doc",id:"06-api-reference/interfaces/VoiceConfig",label:"VoiceConfig"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_MEDIUM",label:"KOKORO_MEDIUM"},{type:"doc",id:"06-api-reference/variables/KOKORO_SMALL",label:"KOKORO_SMALL"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; +const typedocSidebar = {items:[{type:"category",label:"Enumerations",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/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleProps",label:"ExecutorchModuleProps"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleType",label:"ExecutorchModuleType"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsProps",label:"ImageEmbeddingsProps"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsType",label:"ImageEmbeddingsType"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationProps",label:"ImageSegmentationProps"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationType",label:"ImageSegmentationType"},{type:"doc",id:"06-api-reference/interfaces/KokoroConfig",label:"KokoroConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroVoiceExtras",label:"KokoroVoiceExtras"},{type:"doc",id:"06-api-reference/interfaces/LLMConfig",label:"LLMConfig"},{type:"doc",id:"06-api-reference/interfaces/LLMType",label:"LLMType"},{type:"doc",id:"06-api-reference/interfaces/Message",label:"Message"},{type:"doc",id:"06-api-reference/interfaces/ObjectDetectionProps",label:"ObjectDetectionProps"},{type:"doc",id:"06-api-reference/interfaces/ObjectDetectionType",label:"ObjectDetectionType"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/OCRProps",label:"OCRProps"},{type:"doc",id:"06-api-reference/interfaces/OCRType",label:"OCRType"},{type:"doc",id:"06-api-reference/interfaces/Point",label:"Point"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/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/TextToImageParams",label:"TextToImageParams"},{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/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/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:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_MEDIUM",label:"KOKORO_MEDIUM"},{type:"doc",id:"06-api-reference/variables/KOKORO_SMALL",label:"KOKORO_SMALL"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; 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 ea3e1f241..99d79d9a7 100644 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MINILM\_L6\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L408) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L408) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md index 6d789c891..acd708062 100644 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MPNET\_BASE\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L413) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L413) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md index 4bb35969b..37f791526 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_256**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L442) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L442) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index d8a42eb97..761558eab 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_512**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L434) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L434) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index b670b5a86..a0e8469d8 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_IMAGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md index 21b34f37a..12df10961 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_TEXT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L428) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L428) ## 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 ae66b3c08..b0bf841c4 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: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L385) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L385) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md index 04423c5f7..9c1bbe533 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_CHAT\_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md index f2441886f..52e5251b8 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_CONTEXT\_WINDOW\_LENGTH**: `5` = `5` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md index e62a1ef36..c3580f6b8 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_MESSAGE\_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md index 2bf615ee0..6764af3c2 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_SYSTEM\_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) 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 c265c77bd..83dfc6d6f 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -2,7 +2,7 @@ > `const` **EFFICIENTNET\_V2\_S**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L260) ## 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 81bb4ffda..944d2c57b 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -2,7 +2,7 @@ > `const` **FSMN\_VAD**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L453) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L453) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md index c52b54822..fed09996f 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L108) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L108) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md index 605b6837f..2ef5a26ee 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L114) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L114) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md index 4f31c7385..c04ecc8a7 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L120) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L120) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md index 8d88ee689..96f1d8a6b 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L126) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L126) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md index 39624558f..6f2daea19 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L132) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L132) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md index 269c6b268..c98b1a373 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L138) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L138) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md index 402e038d2..4c8e42e49 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_MEDIUM**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/models.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/models.ts#L22) A standard Kokoro instance which processes the text in batches of maximum 128 tokens. diff --git a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md index 3c4969bdd..57a84b3a2 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/models.ts#L13) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/models.ts#L13) A Kokoro model instance which processes the text in batches of maximum 64 tokens. Uses significant less memory than the medium model, but could produce diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md index 77a8fa408..37535f7ca 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_HEART**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L21) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md index 75c8033ab..38bd36ef4 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_RIVER**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L26) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L26) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md index 3e31e6ac2..0489efc0e 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_SARAH**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L31) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L31) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md index 234d52128..6b32569f7 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_ADAM**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L36) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L36) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md index 775f0051a..2d44119a3 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_MICHAEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L41) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md index 364efda06..c381fbc15 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_SANTA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L46) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md index cc38520d8..af2b64516 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BF\_EMMA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L51) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L51) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md index 317a7df41..a588bcf66 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BM\_DANIEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/tts/voices.ts#L56) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L56) 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 ce0d7b6f5..a2c470e73 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L34) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L34) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md index add43e9bd..8ae022f82 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L40) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L40) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md index cba6c20f4..14a005eda 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L46) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md index bfd7085e1..82553bb71 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L16) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L16) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md index 1df915d6b..73be4a7b6 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L22) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md index a99e859c3..f7a1b72dd 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L28) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L28) ## 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 d18090b17..6384dcfa3 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MINILM\_L6\_COS\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L418) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L418) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md index 0f91c1b9c..2300c06b7 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MPNET\_BASE\_DOT\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md index e69514a6c..f40b238fa 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L41) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md index bcf19a6f0..330fbdd03 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L47) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L47) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md index 5b12d4372..05ff1b545 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L53) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L53) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md index 0259f6c68..de356982f 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L362) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L362) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md index 0adc8d192..0cbe13fbf 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L59) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L59) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md index cd6ca4ba5..f1b29fbe3 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L65) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L65) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md index 0d23f1d73..b6a370c92 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L71) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L71) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md index e098ba40e..462c7961d 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L83) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L83) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md index 55b5fe737..7943130a2 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L77) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L77) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md index 937233380..30665e091 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L98) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L98) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md index 00f14ce9a..a8f3bffe5 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L164) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L164) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md index 6eee7b2a7..ad8092468 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L104) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L104) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md index acb5ca261..2d7f90919 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L116) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L116) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md index 7b7d47904..fb5c439cc 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L122) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L122) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md index b032324bc..f11a69728 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L284) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md index c9f51a72e..52eca02ed 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L134) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L134) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md index 76752459e..3a57c9739 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L146) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L146) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md index 33cd5e10a..f05eafea3 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L152) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L152) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md index decb0bb49..0a84f6271 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L128) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L128) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md index 498689384..b3a95d6fc 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L170) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L170) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md index ac2ce5ee5..6e9a1cbd4 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L188) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L188) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md index d0f0709ec..9409ed197 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L176) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L176) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md index fd4592a5d..d9d9938aa 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L182) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L182) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md index 6c6270d7d..ca8bcb031 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L158) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L158) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md index b5d8b5fbc..7c870bd5b 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L194) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L194) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md index 4752bf061..877099d96 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md index e07a1a521..597996235 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md index 1edb948fc..0be5f8ae9 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md index f0ff693c1..79b9ff919 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md index 51fbe6eeb..e0038adb9 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md index d02693c13..9a47cdd69 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L236) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L236) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md index 6e72c137f..15a4001bc 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md index 733ccbb3a..0063de0f8 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L254) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L254) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md index 12d607555..fe8e3ea88 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md index 0cba62984..15ae0459e 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md index d022ee7ef..3230c0cf4 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L272) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L272) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md index e64455bc9..77b843e4e 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L278) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L278) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md index e351bca5e..7dd27ea12 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L260) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md index 66405c6a3..d48f82d4e 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L266) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L266) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md index 9dfa309af..d2e4abcb8 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L290) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L290) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md index d9bb2565f..2420c1a71 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L296) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L296) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md index 8dc2d22a8..5c16acd41 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L302) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md index a2681d235..c59e8bc81 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L308) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L308) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md index 95bb68d21..79b0e3352 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L314) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L314) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md index 5f70dda76..5d0e69d7a 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L320) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L320) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md index c4474ff7b..411d96cb9 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L326) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L326) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md index f3d259516..b0b4643ab 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L332) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L332) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md index 2d0ce51fe..6f78a0c2e 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L341) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L341) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md index 856ab33af..9aa4e16c7 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L89) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L89) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md index dcd7c4a85..f279b61dc 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L350) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L350) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md index cd2ea6faf..019d6f558 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L356) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L356) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md index 0a2ddfb2d..13a2c20dc 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L140) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L140) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md index 98cea6b8a..95b6bc2da 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L374) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L374) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md index 3a655ce64..0e715347e 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md index f6da55d80..8a0283a5b 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L380) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L380) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md index cc99838f4..992578c51 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L398) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L398) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md index c84ad7ac2..94feae3ad 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md index 77fddf2e1..4f64fda2a 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L386) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L386) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md index aee9a01aa..911d4e203 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L404) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L404) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md index 5df46ee4d..c2c0e68b0 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L410) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L410) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md index 5d9f09021..312150c1e 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L416) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L416) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md index 19b1a56b0..430ab12d7 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L422) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L422) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md index fff92f5ea..3413e545d 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L110) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L110) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md index 3c5aa3c3b..fd1839504 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md index 50d9b1b73..6fe465db0 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md index 30d9ab491..ed01684d4 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md index b47e8e9b4..08a85b75a 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md index 96203ae57..be8636aaa 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md index ebe740508..fb1350dfb 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md index 5b74b81b7..035ebdf64 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md index 09a412786..c9755ff13 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md index 8e39e784e..22757c8c7 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L62) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L62) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md index 69b3c1f47..7829532b4 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L68) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L68) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md index 7e5591305..390138241 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L74) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L74) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md index afbdabfdf..f7818e232 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L80) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L80) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index d408b4443..95dd30a44 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L86) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L86) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md index 221a7dfcc..077a505b6 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L92) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L92) ## 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 e3dc4d270..071d6fb30 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L154) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L154) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md index 1cb07b717..c113cf486 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L160) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L160) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md index b2d7b1588..9fcce2d45 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L178) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L178) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md index 99c8e0af3..4cebcd5ee 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L184) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L184) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md index 7fd237ae0..9b602cdb2 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L166) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L166) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md index f1e999bed..f61987edd 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L172) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L172) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md index 049f31104..986195adb 100644 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -2,7 +2,7 @@ > `const` **SPECIAL\_TOKENS**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:216](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/types/llm.ts#L216) +Defined in: [packages/react-native-executorch/src/types/llm.ts:202](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L202) ## Type Declaration 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 8e9ad1ab0..27ad3e496 100644 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `const` **SSDLITE\_320\_MOBILENET\_V3\_LARGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L267) ## 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 a03737823..618f48830 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_CANDY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L289) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L289) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md index 1c7c7b2a9..7d97cb4c7 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_MOSAIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L293) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L293) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md index 6094f0028..ba92ef027 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_RAIN\_PRINCESS**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md index c8b9a55be..5d56a87b7 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_UDNIE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L301) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L301) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md index 5fdb7d348..5f3aa2e2c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L42) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L42) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md index c61f333f5..c449786d8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L48) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L48) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md index 7177cb879..684562714 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L54) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L54) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md index 3de37a23d..666d75762 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L363) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L363) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md index d043e65d7..5be79bc98 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L60) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L60) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md index 3d4d8fdf6..6f299d296 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L66) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L66) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md index a3e56cd3c..995b21df9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L72) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L72) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md index 144aa04a6..bfcb6ce81 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L84) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L84) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md index 2661a941a..cddd219e7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L78) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L78) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md index 2a62eb692..d3139dd3d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L99) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L99) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md index b80096e32..a99629e0f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L165) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L165) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md index b96af5a11..6219b5418 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L105) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L105) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md index d3cc13fe0..97b65e8f2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L117) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L117) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md index 1bac72447..35c36274f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L123) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L123) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md index 12e54b2f9..6c7825716 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L285) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L285) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md index 91e05db1b..19640e79a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L135) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L135) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md index 3ea9dc7ce..4b3fbb441 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L147) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L147) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md index 576a91582..52dd9cb57 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L153) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L153) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md index 57e48396d..ac876020a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L129) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L129) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md index 6a3d274aa..c8e154511 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L171) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L171) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md index 12f3c02c4..8a95e4e73 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L189) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L189) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md index 8ee6ae18d..5a2f7f56a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L177) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L177) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md index 69ee73bad..694ebd448 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L183) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L183) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md index 95361eeb1..d20218413 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L159) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L159) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md index c96737ab0..137ed751b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L195) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L195) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md index 61674f12a..34b4bfd91 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L201) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L201) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md index ed758dc9f..18c78622b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L213) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L213) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md index f25d0d550..6480eb3dc 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L207) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L207) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md index f09fbd506..72f887390 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L219) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L219) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md index a156ad3ec..a883ce960 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L225) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L225) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md index 595d3112c..3b76770c0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L237) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L237) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md index 46b87d3c3..fc5b3a56a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L231) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L231) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md index 2086be94f..944f05964 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L255) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L255) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md index f26bf1dff..957ec6921 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L243) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L243) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md index 2c85e55d2..a3576573f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L249) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L249) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md index 387301b62..74c9e8994 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L273) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L273) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md index aebe48e15..b9027b128 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L279) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L279) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md index 65ab380ac..3619244a7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L261) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L261) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md index c58f8cccf..431106d86 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L267) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md index 08fc05b29..2fa3a7624 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L291) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L291) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md index a88fa0867..f396343a3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md index d43204109..5fabeac71 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L303) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L303) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md index e556921d5..fed3d3a7b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L309) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L309) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md index 5e48401e1..0f8c052e0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L315) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L315) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md index 39d474dab..6fc357ad4 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L321) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L321) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md index 2ebf32f64..6176edf39 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L327) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L327) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md index bc85c72b5..569add400 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L336) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L336) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md index 1b646076c..e8dacbc7f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L345) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L345) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md index 6f21d9a16..156f48cc2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L93) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L93) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md index a1143e7f9..e2a066a2b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L351) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L351) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md index 3a320f2c8..d39c60239 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L357) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L357) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md index b671bbc2d..6f61333dd 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L141) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L141) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md index 58a0d07ab..98c6b89d8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md index b2e957c9e..8b7053b83 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L369) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L369) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md index 2ae4336c7..d6ed5955a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L381) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L381) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md index 51a8c4f65..8d08c4517 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L399) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L399) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md index 11b32d2eb..a8253a729 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L393) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L393) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md index 892655a88..91b99b309 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L387) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L387) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md index 88e826692..ba450ada9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L405) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L405) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md index 6242eeed1..f49a85182 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L411) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L411) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md index 36f3a5f18..e465f4a14 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L417) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L417) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md index 0a076cc0b..690ad457c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md index ab1b59969..abdea7f87 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/ocr/models.ts#L111) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L111) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md index 30e4a6085..17310b687 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md index 88311902c..a98a0f0a0 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L347) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L347) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md index 105c50beb..cd6ce3cc7 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md index ae995e365..2753d44c7 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L354) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L354) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md index 844c79f2c..ce8832772 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L361) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L361) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md index c11241fa8..91ffc66f2 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L333) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L333) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md index 35f278425..c4710df21 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/constants/modelUrls.ts#L340) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L340) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md index 99b4f369e..4b5652710 100644 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -2,7 +2,7 @@ > `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] -Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/ac6840354d6a7d08dd7f9e5b0ae0fc23eca7922d/packages/react-native-executorch/src/utils/llm.ts#L9) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/llm.ts#L9) ## Parameters diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts b/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts index 1790023c3..e93716039 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts @@ -1,28 +1,18 @@ import { useEffect, useState } from 'react'; -import { ResourceSource } from '../../types/common'; -import { OCRDetection, OCRLanguage } from '../../types/ocr'; +import { OCRProps, OCRType } from '../../types/ocr'; import { OCRController } from '../../controllers/OCRController'; import { RnExecutorchError } from '../../errors/errorUtils'; -interface OCRModule { - error: RnExecutorchError | null; - isReady: boolean; - isGenerating: boolean; - forward: (imageSource: string) => Promise; - downloadProgress: number; -} - +/** + * React hook for managing an OCR instance. + * + * @param OCRConfiguration - Configuration object containing `model` sources and optional `preventLoad` flag. + * @returns Ready to use OCR model. + */ export const useOCR = ({ model, preventLoad = false, -}: { - model: { - detectorSource: ResourceSource; - recognizerSource: ResourceSource; - language: OCRLanguage; - }; - preventLoad?: boolean; -}): OCRModule => { +}: OCRProps): OCRType => { const [error, setError] = useState(null); const [isReady, setIsReady] = useState(false); const [isGenerating, setIsGenerating] = useState(false); 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 6ad168934..fab7803ca 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts @@ -1,13 +1,14 @@ -import { ResourceSource } from '../../types/common'; import { useModule } from '../useModule'; import { StyleTransferModule } from '../../modules/computer_vision/StyleTransferModule'; +import { StyleTransferProps, StyleTransferType } from '../../types/styleTransfer'; -interface Props { - model: { modelSource: ResourceSource }; - preventLoad?: boolean; -} - -export const useStyleTransfer = ({ model, preventLoad = false }: Props) => +/** + * React hook for managing a Style Transfer model instance. + * + * @param StyleTransferConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. + * @returns Ready to use Style Transfer model. + */ +export const useStyleTransfer = ({ model, preventLoad = false }: StyleTransferProps): StyleTransferType => useModule({ module: StyleTransferModule, model, diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts b/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts index b33fe59f0..2533f98a9 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts @@ -1,38 +1,20 @@ import { useCallback, useEffect, useState } from 'react'; import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; -import { ResourceSource } from '../../types/common'; import { TextToImageModule } from '../../modules/computer_vision/TextToImageModule'; +import { TextToImageParams, TextToImageType } from '../../types/tti'; -interface TextToImageType { - isReady: boolean; - isGenerating: boolean; - downloadProgress: number; - error: RnExecutorchError | null; - generate: ( - input: string, - imageSize?: number, - numSteps?: number, - seed?: number - ) => Promise; - interrupt: () => void; -} - +/** + * React hook for managing a Text to Image instance. + * + * @param TextToImageConfiguration - Configuration object containing `model` source, `inferenceCallback`, and optional `preventLoad` flag. + * @returns Ready to use Text to Image model. + */ export const useTextToImage = ({ model, inferenceCallback, preventLoad = false, -}: { - model: { - tokenizerSource: ResourceSource; - schedulerSource: ResourceSource; - encoderSource: ResourceSource; - unetSource: ResourceSource; - decoderSource: ResourceSource; - }; - inferenceCallback?: (stepIdx: number) => void; - preventLoad?: boolean; -}): TextToImageType => { +}: TextToImageParams): TextToImageType => { const [isReady, setIsReady] = useState(false); const [isGenerating, setIsGenerating] = useState(false); const [downloadProgress, setDownloadProgress] = useState(0); diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts b/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts index bf7da6e03..ca60d8330 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts @@ -1,30 +1,19 @@ import { useEffect, useState } from 'react'; -import { ResourceSource } from '../../types/common'; -import { OCRDetection, OCRLanguage } from '../../types/ocr'; +import { OCRType, VerticalOCRProps } from '../../types/ocr'; import { VerticalOCRController } from '../../controllers/VerticalOCRController'; import { RnExecutorchError } from '../../errors/errorUtils'; -interface OCRModule { - error: RnExecutorchError | null; - isReady: boolean; - isGenerating: boolean; - forward: (imageSource: string) => Promise; - downloadProgress: number; -} - +/** + * React hook for managing a Vertical OCR instance. + * + * @param VerticalOCRConfiguration - Configuration object containing `model` sources, optional `independentCharacters` and `preventLoad` flag. + * @returns Ready to use Vertical OCR model. + */ export const useVerticalOCR = ({ model, independentCharacters = false, preventLoad = false, -}: { - model: { - detectorSource: ResourceSource; - recognizerSource: ResourceSource; - language: OCRLanguage; - }; - independentCharacters?: boolean; - preventLoad?: boolean; -}): OCRModule => { +}: VerticalOCRProps): OCRType => { const [error, setError] = useState(null); const [isReady, setIsReady] = useState(false); const [isGenerating, setIsGenerating] = useState(false); diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts index 5544c65f5..804fddd89 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts @@ -1,12 +1,10 @@ import { useCallback, useEffect, useState } from 'react'; import { ResourceSource } from '../../types/common'; import { - ChatConfig, - GenerationConfig, + LLMConfig, LLMTool, LLMType, Message, - ToolsConfig, } from '../../types/llm'; import { LLMController } from '../../controllers/LLMController'; import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; @@ -99,11 +97,7 @@ export const useLLM = ({ chatConfig, toolsConfig, generationConfig, - }: { - chatConfig?: Partial; - toolsConfig?: ToolsConfig; - generationConfig?: GenerationConfig; - }) => + }: LLMConfig) => controllerInstance.configure({ chatConfig, toolsConfig, diff --git a/packages/react-native-executorch/src/index.ts b/packages/react-native-executorch/src/index.ts index 4ae321b69..a42881f45 100644 --- a/packages/react-native-executorch/src/index.ts +++ b/packages/react-native-executorch/src/index.ts @@ -104,6 +104,7 @@ export * from './modules/computer_vision/TextToImageModule'; export * from './modules/natural_language_processing/LLMModule'; export * from './modules/natural_language_processing/SpeechToTextModule'; +export * from './modules/natural_language_processing/TextToSpeechModule'; export * from './modules/natural_language_processing/TextEmbeddingsModule'; export * from './modules/natural_language_processing/TokenizerModule'; export * from './modules/natural_language_processing/VADModule'; @@ -128,6 +129,8 @@ export * from './types/tokenizer'; export * from './types/executorchModule'; export * from './types/classification'; export * from './types/imageEmbeddings'; +export * from './types/styleTransfer'; +export * from './types/tti'; // constants export * from './constants/modelUrls'; diff --git a/packages/react-native-executorch/src/modules/BaseModule.ts b/packages/react-native-executorch/src/modules/BaseModule.ts index 4d5b00ad0..2ea7306b1 100644 --- a/packages/react-native-executorch/src/modules/BaseModule.ts +++ b/packages/react-native-executorch/src/modules/BaseModule.ts @@ -2,6 +2,9 @@ import { ResourceSource } from '../types/common'; import { TensorPtr } from '../types/common'; export abstract class BaseModule { + /** + * Native module instance + */ nativeModule: any = null; abstract load( @@ -10,14 +13,31 @@ export abstract class BaseModule { ...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. + * + * @param inputTensor - Array of input tensors. + * @returns Array of output tensors. + */ protected async forwardET(inputTensor: TensorPtr[]): Promise { return await this.nativeModule.forward(inputTensor); } + /** + * Gets the input shape for a given method and index. + * + * @param methodName method name + * @param index index of the argument which shape is requested + * @returns The input shape as an array of numbers. + */ async getInputShape(methodName: string, index: number): Promise { return this.nativeModule.getInputShape(methodName, index); } + /** + * Unloads the model from memory. + */ delete() { if (this.nativeModule !== null) { this.nativeModule.unload(); diff --git a/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts b/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts index 6cf3bbc03..ab1041e6f 100644 --- a/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts +++ b/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts @@ -6,6 +6,13 @@ import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; export class ExecutorchModule extends BaseModule { + /** + * Loads the model, where `modelSource` is a string, number, or object that specifies the location of the model binary. + * Optionally accepts a download progress callback. + * + * @param modelSource - Source of the model to be loaded. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( modelSource: ResourceSource, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -23,6 +30,13 @@ export class ExecutorchModule extends BaseModule { this.nativeModule = global.loadExecutorchModule(paths[0] || ''); } + /** + * Executes the model's forward pass, where input is an array of `TensorPtr` objects. + * If the inference is successful, an array of tensor pointers is returned. + * + * @param inputTensor - Array of input tensor pointers. + * @returns An array of output tensor pointers. + */ async forward(inputTensor: TensorPtr[]): Promise { return await this.forwardET(inputTensor); } diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts index d4b46f4cd..0cf8bb400 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts @@ -1,23 +1,39 @@ import { LLMController } from '../../controllers/LLMController'; import { ResourceSource } from '../../types/common'; import { - ChatConfig, - GenerationConfig, + LLMConfig, LLMTool, Message, - ToolsConfig, } from '../../types/llm'; +/** + * Module for managing a Large Language Model (LLM) instance. + */ export class LLMModule { private controller: LLMController; + /** + * Creates a new instance of LLMModule with optional callbacks. + * @param optionalCallbacks - Object containing optional callbacks. + * + * @returns A new LLMModule instance. + */ constructor({ tokenCallback, responseCallback, messageHistoryCallback, }: { + /** + * Optional callback invoked on every token batch (`string`). + */ tokenCallback?: (token: string) => void; + /** + * Optional callback invoked on every response update (`string`). + */ responseCallback?: (response: string) => void; + /** + * Optional callback invoked on message history updates (`Message[]`). + */ messageHistoryCallback?: (messageHistory: Message[]) => void; } = {}) { this.controller = new LLMController({ @@ -27,6 +43,15 @@ export class LLMModule { }); } + /** + * Loads the LLM model and tokenizer. + * + * @param model - Object containing model, tokenizer, and tokenizer config sources. + * @param model.modelSource - `ResourceSource` that specifies the location of the model binary. + * @param model.tokenizerSource - `ResourceSource` pointing to the JSON file which contains the tokenizer. + * @param model.tokenizerConfigSource - `ResourceSource` pointing to the JSON file which contains the tokenizer config. + * @param onDownloadProgressCallback - Optional callback to track download progress (value between 0 and 1). + */ async load( model: { modelSource: ResourceSource; @@ -41,6 +66,11 @@ export class LLMModule { }); } + /** + * Sets new token callback invoked on every token batch. + * + * @param tokenCallback - Callback function to handle new tokens. + */ setTokenCallback({ tokenCallback, }: { @@ -49,46 +79,93 @@ export class LLMModule { this.controller.setTokenCallback(tokenCallback); } + /** + * Configures chat and tool calling and generation settings. + * See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. + * + * @param configuration - Configuration object containing `chatConfig`, `toolsConfig`, and `generationConfig`. + */ configure({ chatConfig, toolsConfig, generationConfig, - }: { - chatConfig?: Partial; - toolsConfig?: ToolsConfig; - generationConfig?: GenerationConfig; - }) { + }: LLMConfig) { this.controller.configure({ chatConfig, toolsConfig, generationConfig }); } + /** + * Runs model inference with raw input string. + * You need to provide entire conversation and prompt (in correct format and with special tokens!) in input string to this method. + * It doesn't manage conversation context. It is intended for users that need access to the model itself without any wrapper. + * If you want a simple chat with model the consider using `sendMessage` + * + * @param input - Raw input string containing the prompt and conversation history. + * @returns The generated response as a string. + */ async forward(input: string): Promise { await this.controller.forward(input); return this.controller.response; } + /** + * Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. + * + * @param messages - Array of messages representing the chat history. + * @param tools - Optional array of tools that can be used during generation. + * @returns The generated response as a string. + */ async generate(messages: Message[], tools?: LLMTool[]): Promise { await this.controller.generate(messages, tools); return this.controller.response; } + /** + * Method to add user message to conversation. + * After model responds it will call `messageHistoryCallback()` containing both user message and model response. + * It also returns them. + * + * @param message - The message string to send. + * @returns - Updated message history including the new user message and model response. + */ async sendMessage(message: string): Promise { await this.controller.sendMessage(message); return this.controller.messageHistory; } + /** + * Deletes all messages starting with message on `index` position. + * After deletion it will call `messageHistoryCallback()` containing new history. + * It also returns it. + * + * @param index - The index of the message to delete from history. + * @returns - Updated message history after deletion. + */ deleteMessage(index: number): Message[] { this.controller.deleteMessage(index); return this.controller.messageHistory; } + /** + * Interrupts model generation. It may return one more token after interrupt. + */ interrupt() { this.controller.interrupt(); } + /** + * Returns the number of tokens generated in the last response. + * + * @returns The count of generated tokens. + */ getGeneratedTokenCount() { return this.controller.getGeneratedTokenCount(); } + /** + * Method to delete the model from memory. + * Note you cannot delete model while it's generating. + * You need to interrupt it first and make sure model stopped generation. + */ delete() { this.controller.delete(); } diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts index 26c3aa1e6..0c5e61be3 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts @@ -4,6 +4,9 @@ import { ResourceFetcher } from '../../utils/ResourceFetcher'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; +/** + * Module for Speech to Text (STT) functionalities. + */ export class SpeechToTextModule { private nativeModule: any; @@ -14,6 +17,13 @@ export class SpeechToTextModule { ignoreBOM: true, }); + /** + * Loads the model specified by the config object. + * `onDownloadProgressCallback` allows you to monitor the current progress of the model download. + * + * @param model - Configuration object containing model sources. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ public async load( model: SpeechToTextModelConfig, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -48,10 +58,20 @@ export class SpeechToTextModule { ); } + /** + * Unloads the model from memory. + */ public delete(): void { this.nativeModule.unload(); } + /** + * Runs the encoding part of the model on the provided waveform. + * Returns the encoded waveform as a Float32Array. Passing `number[]` is deprecated. + * + * @param waveform - The input audio waveform. + * @returns The encoded output. + */ public async encode( waveform: Float32Array | number[] ): Promise { @@ -93,7 +113,9 @@ export class SpeechToTextModule { } /** - * Transcribes audio using the Whisper model. + * Starts a transcription process for a given input array (16kHz waveform). + * For multilingual models, specify the language in `options`. + * Returns the transcription as a string. Passing `number[]` is deprecated. * * @param waveform - The Float32Array audio data. * @param options - Decoding options including language. @@ -118,6 +140,14 @@ export class SpeechToTextModule { return this.textDecoder.decode(new Uint8Array(transcriptionBytes)); } + /** + * Starts a streaming transcription session. + * Yields objects with `committed` and `nonCommitted` transcriptions. + * Use with `streamInsert` and `streamStop` to control the stream. + * + * @param options - Decoding options including language. + * @returns An async generator yielding transcription updates. + */ public async *stream( options: DecodingOptions = {} ): AsyncGenerator<{ committed: string; nonCommitted: string }> { @@ -173,6 +203,11 @@ export class SpeechToTextModule { } } + /** + * Inserts a new audio chunk into the streaming transcription session. Passing `number[]` is deprecated. + * + * @param waveform - The audio chunk to insert. + */ public streamInsert(waveform: Float32Array | number[]): void { if (Array.isArray(waveform)) { Logger.info( @@ -183,6 +218,9 @@ export class SpeechToTextModule { this.nativeModule.streamInsert(waveform); } + /** + * Stops the current streaming transcription session. + */ public streamStop(): void { this.nativeModule.streamStop(); } 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 173909b33..51e280db0 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 @@ -4,7 +4,19 @@ import { BaseModule } from '../BaseModule'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; +/** + * Module for generating text embeddings from input text. + */ export class TextEmbeddingsModule extends BaseModule { + + /** + * Loads the model and tokenizer specified by the config object. + * + * @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). + */ async load( model: { modelSource: ResourceSource; tokenizerSource: ResourceSource }, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -32,6 +44,12 @@ export class TextEmbeddingsModule extends BaseModule { this.nativeModule = global.loadTextEmbeddings(modelPath, tokenizerPath); } + /** + * Executes the model's forward pass, where `input` is a text that will be embedded. + * + * @param input - The text string to embed. + * @returns A Float32Array containing the vector embeddings. + */ async forward(input: string): Promise { return new Float32Array(await this.nativeModule.generate(input)); } diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts index 18b7e9106..9df06e966 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts @@ -8,9 +8,22 @@ import { VoiceConfig, } from '../../types/tts'; +/** + * Module for Text to Speech (TTS) functionalities. + */ export class TextToSpeechModule { + /** + * Native module instance + */ nativeModule: any = null; + /** + * Loads the model and voice assets specified by the config object. + * `onDownloadProgressCallback` allows you to monitor the current progress. + * + * @param config - Configuration object containing `model` source, `voice` and optional `preventLoad`. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ public async load( config: TextToSpeechConfig, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -73,6 +86,14 @@ export class TextToSpeechModule { ); } + /** + * Synthesizes the provided text into speech. + * Returns a promise that resolves to the full audio waveform as a `Float32Array`. + * + * @param text The input text to be synthesized. + * @param speed Optional speed multiplier for the speech synthesis (default is 1.0). + * @returns A promise resolving to the synthesized audio waveform. + */ public async forward(text: string, speed: number = 1.0) { if (this.nativeModule == null) throw new RnExecutorchError( @@ -82,6 +103,12 @@ export class TextToSpeechModule { return await this.nativeModule.generate(text, speed); } + /** + * Starts a streaming synthesis session. Yields audio chunks as they are generated. + * + * @param input - Input object containing text and optional speed. + * @returns An async generator yielding Float32Array audio chunks. + */ public async *stream({ text, speed }: TextToSpeechStreamingInput) { // Stores computed audio segments const queue: Float32Array[] = []; @@ -124,10 +151,16 @@ export class TextToSpeechModule { } } + /** + * Stops the streaming process if there is any ongoing. + */ public streamStop(): void { this.nativeModule.streamStop(); } + /** + * Unloads the model from memory. + */ delete() { if (this.nativeModule !== null) { this.nativeModule.unload(); diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts index 2dd35e048..a2a6ca822 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts @@ -4,8 +4,18 @@ import { RnExecutorchError } from '../../errors/errorUtils'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; export class TokenizerModule { + /** + * Native module instance + */ nativeModule: any; + /** + * Loads the tokenizer from the specified source. + * `tokenizerSource` is a string that points to the location of the tokenizer JSON file. + * + * @param tokenizer - Object containing `tokenizerSource`. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( tokenizer: { tokenizerSource: ResourceSource }, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -24,10 +34,23 @@ export class TokenizerModule { this.nativeModule = global.loadTokenizerModule(path); } - async encode(s: string) { - return await this.nativeModule.encode(s); + /** + * Converts a string into an array of token IDs. + * + * @param input - The input string to be tokenized. + * @returns An array of token IDs. + */ + async encode(input: string) { + return await this.nativeModule.encode(input); } + /** + * Converts an array of token IDs into a string. + * + * @param tokens - Array of token IDs to be decoded. + * @param skipSpecialTokens - Whether to skip special tokens during decoding (default: true). + * @returns The decoded string. + */ async decode(tokens: number[], skipSpecialTokens: boolean = true) { if (tokens.length === 0) { return ''; @@ -35,14 +58,31 @@ export class TokenizerModule { return await this.nativeModule.decode(tokens, skipSpecialTokens); } + /** + * Returns the size of the tokenizer's vocabulary. + * + * @returns The vocabulary size. + */ async getVocabSize(): Promise { return await this.nativeModule.getVocabSize(); } + /** + * Returns the token associated to the ID. + * + * @param tokenId - ID of the token. + * @returns The token string associated to ID. + */ async idToToken(tokenId: number): Promise { return this.nativeModule.idToToken(tokenId); } + /** + * Returns the ID associated to the token. + * + * @param token - The token string. + * @returns The ID associated to the token. + */ async tokenToId(token: string): Promise { return await this.nativeModule.tokenToId(token); } 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 43a3c9eee..f239979f9 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 @@ -6,6 +6,13 @@ import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; export class VADModule extends BaseModule { + /** + * 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`. + * + * @param model - Object containing `modelSource`. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( model: { modelSource: ResourceSource }, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -23,6 +30,12 @@ export class VADModule extends BaseModule { this.nativeModule = global.loadVAD(paths[0] || ''); } + /** + * Executes the model's forward pass, where `waveform` is a Float32Array representing the audio signal. + * + * @param waveform - The input audio waveform as a Float32Array. + * @returns A promise resolving to an array of detected speech segments. + */ async forward(waveform: Float32Array): Promise { if (this.nativeModule == null) throw new RnExecutorchError( diff --git a/packages/react-native-executorch/src/types/common.ts b/packages/react-native-executorch/src/types/common.ts index 06cb64a4f..088ed4d43 100644 --- a/packages/react-native-executorch/src/types/common.ts +++ b/packages/react-native-executorch/src/types/common.ts @@ -35,6 +35,9 @@ export enum ScalarType { UINT64 = 29, } +/** + * Represents the data buffer of a tensor, which can be one of several typed array formats. + */ export type TensorBuffer = | ArrayBuffer | Float32Array @@ -48,6 +51,13 @@ export type TensorBuffer = | BigInt64Array | BigUint64Array; +/** + * Represents a pointer to a tensor, including its data buffer, size dimensions, and scalar type. + * + * @property {TensorBuffer} dataPtr - The data buffer of the tensor. + * @property {number[]} sizes - An array representing the size of each dimension of the tensor. + * @property {ScalarType} scalarType - The scalar type of the tensor, as defined in the `ScalarType` enum. + */ export interface TensorPtr { dataPtr: TensorBuffer; sizes: number[]; diff --git a/packages/react-native-executorch/src/types/llm.ts b/packages/react-native-executorch/src/types/llm.ts index e15d36020..7ccd9339b 100644 --- a/packages/react-native-executorch/src/types/llm.ts +++ b/packages/react-native-executorch/src/types/llm.ts @@ -43,57 +43,24 @@ export interface LLMType { * Configures chat and tool calling. * See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. * - * @param configuration - Configuration object containing `chatConfig`, `toolsConfig`, and `generationConfig`. + * @param {LLMConfig} configuration - Configuration object containing `chatConfig`, `toolsConfig`, and `generationConfig`. */ configure: ({ chatConfig, toolsConfig, generationConfig, - }: { - /** - * Object configuring chat management, contains following properties: - * - * `systemPrompt` - Often used to tell the model what is its purpose, for example - "Be a helpful translator". - * - * `initialMessageHistory` - An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. - * - * `contextWindowLength` - The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. - */ - chatConfig?: Partial; - - /** - * Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: - * - * `tools` - List of objects defining tools. - * - * `executeToolCallback` - Function that accepts `ToolCall`, executes tool and returns the string to model. - * - * `displayToolCalls` - If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. - */ - toolsConfig?: ToolsConfig; - - /** - * Object configuring generation settings. - * - * `outputTokenBatchSize` - Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). - * - * `batchTimeInterval` - Upper limit on the time interval between consecutive token batches. - * - * `temperature` - Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. - * - * `topp` - Only samples from the smallest set of tokens whose cumulative probability exceeds topp. - */ - generationConfig?: GenerationConfig; - }) => void; + }: LLMConfig) => void; /** * Returns the number of tokens generated so far in the current generation. + * * @returns The count of generated tokens. */ getGeneratedTokenCount: () => number; /** * Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. + * * @param messages - Array of messages representing the chat history. * @param tools - Optional array of tools that can be used during generation. */ @@ -102,14 +69,15 @@ export interface LLMType { /** * Function to add user message to conversation. * After model responds, `messageHistory` will be updated with both user message and model response. + * * @param message - The message string to send. */ sendMessage: (message: string) => Promise; /** * Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. + * * @param index - The index of the message to delete from history. - * @returns */ deleteMessage: (index: number) => void; @@ -119,6 +87,46 @@ export interface LLMType { interrupt: () => void; } +/** + * Configuration object for initializing and customizing a Large Language Model (LLM) instance. + */ +export interface LLMConfig { + /** + * Object configuring chat management, contains following properties: + * + * `systemPrompt` - Often used to tell the model what is its purpose, for example - "Be a helpful translator". + * + * `initialMessageHistory` - An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. + * + * `contextWindowLength` - The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. + */ + chatConfig?: Partial; + + /** + * Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: + * + * `tools` - List of objects defining tools. + * + * `executeToolCallback` - Function that accepts `ToolCall`, executes tool and returns the string to model. + * + * `displayToolCalls` - If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. + */ + toolsConfig?: ToolsConfig; + + /** + * Object configuring generation settings. + * + * `outputTokenBatchSize` - Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). + * + * `batchTimeInterval` - Upper limit on the time interval between consecutive token batches. + * + * `temperature` - Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. + * + * `topp` - Only samples from the smallest set of tokens whose cumulative probability exceeds topp. + */ + generationConfig?: GenerationConfig; +}; + /** * Roles that a message sender can have. */ @@ -126,19 +134,21 @@ export type MessageRole = 'user' | 'assistant' | 'system'; /** * Represents a message in the conversation. + * + * @property {MessageRole} role - Role of the message sender of type `MessageRole`. + * @property {string} content - Content of the message. */ export interface Message { - /** - * Role of the message sender of type `MessageRole`. - */ role: MessageRole; - - /** - * Content of the message. - */ content: string; } +/** + * Represents a tool call made by the model. + * + * @property {string} toolName - The name of the tool being called. + * @property {Object} arguments - The arguments passed to the tool. + */ export interface ToolCall { toolName: string; arguments: Object; @@ -150,66 +160,42 @@ export type LLMTool = Object; /** * Object configuring chat management. + * + * @property {Message[]} initialMessageHistory - An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. + * @property {number} contextWindowLength - The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. + * @property {string} systemPrompt - Often used to tell the model what is its purpose, for example - "Be a helpful translator". */ export interface ChatConfig { - /** - * An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. - */ initialMessageHistory: Message[]; - - /** - * The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. - */ contextWindowLength: number; - - /** - * Often used to tell the model what is its purpose, for example - "Be a helpful translator". - */ systemPrompt: string; } /** * Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. + * + * @property {LLMTool[]} tools - List of objects defining tools. + * @property {(call: ToolCall) => Promise} executeToolCallback - Function that accepts `ToolCall`, executes tool and returns the string to model. + * @property {boolean} [displayToolCalls] - If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. */ export interface ToolsConfig { - /** - * List of objects defining tools. - */ tools: LLMTool[]; - - /** - * Function that accepts `ToolCall`, executes tool and returns the string to model. - */ executeToolCallback: (call: ToolCall) => Promise; - - /** - * If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. - */ displayToolCalls?: boolean; } /** * Object configuring generation settings. + * + * @property {number} [temperature] - Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. + * @property {number} [topp] - Only samples from the smallest set of tokens whose cumulative probability exceeds topp. + * @property {number} [outputTokenBatchSize] - Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). + * @property {number} [batchTimeInterval] - Upper limit on the time interval between consecutive token batches. */ export interface GenerationConfig { - /** - * Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. - */ temperature?: number; - - /** - * Only samples from the smallest set of tokens whose cumulative probability exceeds topp. - */ topp?: number; - - /** - * Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). - */ outputTokenBatchSize?: number; - - /** - * Upper limit on the time interval between consecutive token batches. - */ batchTimeInterval?: number; } diff --git a/packages/react-native-executorch/src/types/ocr.ts b/packages/react-native-executorch/src/types/ocr.ts index 6b8b72efd..b6cc490e8 100644 --- a/packages/react-native-executorch/src/types/ocr.ts +++ b/packages/react-native-executorch/src/types/ocr.ts @@ -1,14 +1,109 @@ import { symbols } from '../constants/ocr/symbols'; +import { RnExecutorchError } from '../errors/errorUtils'; +import { ResourceSource } from './common'; +/** + * OCRDetection represents a single detected text instance in an image, + * including its bounding box, recognized text, and confidence score. + * + * @property {Point[]} bbox - An array of points defining the bounding box around the detected text. + * @property {string} text - The recognized text within the bounding box. + * @property {number} score - The confidence score of the OCR detection, ranging from 0 to 1. + */ export interface OCRDetection { bbox: Point[]; text: string; score: number; } +/** + * Point represents a coordinate in 2D space. + * + * @property {number} x - The x-coordinate of the point. + * @property {number} y - The y-coordinate of the point. + */ export interface Point { x: number; y: number; } +/** + * Configuration properties for the `useOCR` hook. + */ +export interface OCRProps { + /** + * Object containing the necessary model sources and configuration for the OCR pipeline. + */ + model: { + /** + * `ResourceSource` that specifies the location of the text detector model binary. + */ + detectorSource: ResourceSource; + + /** + * `ResourceSource` that specifies the location of the text recognizer model binary. + */ + recognizerSource: ResourceSource; + + /** + * The language configuration enum for the OCR model (e.g., English, Polish, etc.). + */ + language: OCRLanguage; + }; + + /** + * Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. + * Defaults to `false`. + */ + preventLoad?: boolean; +} + +/** + * Configuration properties for the `useVerticalOCR` hook. + */ +export interface VerticalOCRProps extends OCRProps { + /** + * Boolean indicating whether to treat each character independently during recognition. + * Defaults to `false`. + */ + independentCharacters?: boolean; +}; + +/** + * Return type for the `useOCR` hook. + * Manages the state and operations for Optical Character Recognition (OCR). + */ +export interface OCRType { + /** + * Contains the error object if the models failed to load, download, or encountered a runtime error during recognition. + */ + error: RnExecutorchError | null; + + /** + * Indicates whether both detector and recognizer models are loaded and ready to process images. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently processing an image. + */ + isGenerating: boolean; + + /** + * Represents the total download progress of the model binaries as a value between 0 and 1. + */ + downloadProgress: number; + + /** + * Executes the OCR pipeline (detection and recognition) on the provided image. + * @param imageSource - A string representing the image source (e.g., a file path, URI, or base64 string) to be processed. + * @returns A Promise that resolves to the OCR results (typically containing the recognized text strings and their bounding boxes). + * @throws {RnExecutorchError} If the models are not loaded or are currently processing another image. + */ + forward: (imageSource: string) => Promise; +} + +/** + * Enumeration of supported OCR languages based on available symbol sets. + */ export type OCRLanguage = keyof typeof symbols; diff --git a/packages/react-native-executorch/src/types/stt.ts b/packages/react-native-executorch/src/types/stt.ts index 3b2dc7da4..233b51ac5 100644 --- a/packages/react-native-executorch/src/types/stt.ts +++ b/packages/react-native-executorch/src/types/stt.ts @@ -163,11 +163,10 @@ export type SpeechToTextLanguage = /** * Options for decoding speech to text. + * + * @property {SpeechToTextLanguage} [language] - Optional language code to guide the transcription. */ export interface DecodingOptions { - /** - * Optional language code to guide the transcription. - */ language?: SpeechToTextLanguage; } diff --git a/packages/react-native-executorch/src/types/styleTransfer.ts b/packages/react-native-executorch/src/types/styleTransfer.ts new file mode 100644 index 000000000..9eb74a65b --- /dev/null +++ b/packages/react-native-executorch/src/types/styleTransfer.ts @@ -0,0 +1,48 @@ +import { RnExecutorchError } from "../errors/errorUtils"; +import { ResourceSource } from "./common"; + +/** + * Configuration properties for the `useStyleTransfer` hook. + * + * @property {Object} model - Object containing the `modelSource` for the style transfer 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: { modelSource: ResourceSource }; + preventLoad?: boolean; +} + +/** + * Return type for the `useStyleTransfer` hook. + * Manages the state and operations for applying artistic style transfer to images. + */ +export interface StyleTransferType { + /** + * Contains the error object if the model failed to load, download, or encountered a runtime error during style transfer. + */ + error: RnExecutorchError | null; + + /** + * Indicates whether the style transfer model is loaded and ready to process images. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently processing an image. + */ + isGenerating: boolean; + + /** + * Represents the download progress of the model binary as a value between 0 and 1. + */ + downloadProgress: number; + + /** + * Executes the model's forward pass to apply the specific artistic style to the provided image. + * @param imageSource - A string representing the input image source (e.g., a file path, URI, or base64 string) to be stylized. + * @returns A Promise that resolves to a string containing the stylized image (typically as a base64 string or a file URI). + * @throws {RnExecutorchError} If the model is not loaded or is currently processing another image. + */ + forward: (imageSource: string) => Promise; +} \ No newline at end of file diff --git a/packages/react-native-executorch/src/types/textEmbeddings.ts b/packages/react-native-executorch/src/types/textEmbeddings.ts index 1f28893fc..3e8892c51 100644 --- a/packages/react-native-executorch/src/types/textEmbeddings.ts +++ b/packages/react-native-executorch/src/types/textEmbeddings.ts @@ -27,7 +27,7 @@ export interface TextEmbeddingsType { /** * Runs the text embeddings model on the provided input string. - * * @param input - The text string to embed. + * @param input - The text string to embed. * @returns A promise resolving to a Float32Array containing the vector embeddings. * @throws {RnExecutorchError} If the model is not loaded or is currently processing another request. */ @@ -36,22 +36,16 @@ export interface TextEmbeddingsType { /** * Props for the useTextEmbeddings hook. + * + * @property {Object} model - An object containing the model and tokenizer sources. + * @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 { model: { - /** - * `ResourceSource` that specifies the location of the model binary. - */ modelSource: ResourceSource; - - /** - * `ResourceSource` pointing to the JSON file which contains the tokenizer. - */ tokenizerSource: ResourceSource; }; - - /** - * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. - */ preventLoad?: boolean; } \ No newline at end of file diff --git a/packages/react-native-executorch/src/types/tokenizer.ts b/packages/react-native-executorch/src/types/tokenizer.ts index 64798ec5b..5afdbb258 100644 --- a/packages/react-native-executorch/src/types/tokenizer.ts +++ b/packages/react-native-executorch/src/types/tokenizer.ts @@ -27,6 +27,7 @@ export interface TokenizerType { /** * Converts an array of token IDs into a string. * @param tokens - An array or `number[]` of token IDs to decode. + * @param skipSpecialTokens - Optional boolean to indicate whether special tokens should be skipped during decoding. * @returns A promise resolving to the decoded text string. */ decode(tokens: number[], skipSpecialTokens: boolean | undefined): Promise; diff --git a/packages/react-native-executorch/src/types/tti.ts b/packages/react-native-executorch/src/types/tti.ts new file mode 100644 index 000000000..bf434c987 --- /dev/null +++ b/packages/react-native-executorch/src/types/tti.ts @@ -0,0 +1,83 @@ +import { RnExecutorchError } from '../errors/errorUtils'; +import { ResourceSource } from '../types/common'; + +/** + * Configuration properties for the `useTextToImage` hook. + */ +export interface TextToImageParams { + /** + * Object containing the required model sources for the diffusion pipeline. + */ + model: { + /** Source for the text tokenizer binary/config. */ + tokenizerSource: ResourceSource; + /** Source for the diffusion scheduler binary/config. */ + schedulerSource: ResourceSource; + /** Source for the text encoder model binary. */ + encoderSource: ResourceSource; + /** Source for the UNet (noise predictor) model binary. */ + unetSource: ResourceSource; + /** Source for the VAE decoder model binary, used to decode the final image. */ + decoderSource: ResourceSource; + }; + + /** + * Optional callback function that is triggered after each diffusion inference step. + * Useful for updating a progress bar during image generation. + * @param stepIdx - The index of the current inference step. + */ + inferenceCallback?: (stepIdx: number) => void; + + /** + * Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. + * Defaults to `false`. + */ + preventLoad?: boolean; +} + +/** + * Return type for the `useTextToImage` hook. + * Manages the state and operations for generating images from text prompts using a diffusion model pipeline. + */ +export interface TextToImageType { + /** + * Contains the error object if any of the pipeline models failed to load, download, or encountered a runtime error. + */ + error: RnExecutorchError | null; + + /** + * Indicates whether the entire diffusion pipeline is loaded into memory and ready for generation. + */ + isReady: boolean; + + /** + * Indicates whether the model is currently generating an image. + */ + isGenerating: boolean; + + /** + * Represents the total download progress of all the model binaries combined, as a value between 0 and 1. + */ + downloadProgress: number; + + /** + * Runs the diffusion pipeline to generate an image from the provided text prompt. + * @param input - The text prompt describing the desired image. + * @param [imageSize] - Optional. The target width and height of the generated image (e.g., 512 for 512x512). Defaults to the model's standard size if omitted. + * @param [numSteps] - Optional. The number of denoising steps for the diffusion process. More steps generally yield higher quality at the cost of generation time. + * @param [seed] - Optional. A random seed for reproducible generation. + * @returns A Promise that resolves to a string representing the generated image (e.g., base64 string or file URI). + * @throws {RnExecutorchError} If the model is not loaded or is currently generating another image. + */ + generate: ( + input: string, + imageSize?: number, + numSteps?: number, + seed?: number + ) => Promise; + + /** + * Interrupts the currently active image generation process at the next available inference step. + */ + interrupt: () => void; +} \ No newline at end of file diff --git a/packages/react-native-executorch/src/types/tts.ts b/packages/react-native-executorch/src/types/tts.ts index a75b28ef4..8ab666fe3 100644 --- a/packages/react-native-executorch/src/types/tts.ts +++ b/packages/react-native-executorch/src/types/tts.ts @@ -21,7 +21,12 @@ export interface VoiceConfig { extra?: KokoroVoiceExtras; // ... add more possible types } -// Kokoro-specific voice extra props +/** + * Kokoro-specific voice extra props + * + * @property {ResourceSource} taggerSource - source to Kokoro's tagger model binary + * @property {ResourceSource} lexiconSource - source to Kokoro's lexicon binary + */ export interface KokoroVoiceExtras { taggerSource: ResourceSource; lexiconSource: ResourceSource; @@ -30,6 +35,10 @@ export interface KokoroVoiceExtras { /** * Kokoro model configuration. * Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. + * + * @property {'kokoro'} type - model type identifier + * @property {ResourceSource} durationPredictorSource - source to Kokoro's duration predictor model binary + * @property {ResourceSource} synthesizerSource - source to Kokoro's synthesizer model binary */ export interface KokoroConfig { type: 'kokoro'; diff --git a/packages/react-native-executorch/src/types/vad.ts b/packages/react-native-executorch/src/types/vad.ts index 40b1fb66d..0d0d36fb7 100644 --- a/packages/react-native-executorch/src/types/vad.ts +++ b/packages/react-native-executorch/src/types/vad.ts @@ -3,31 +3,24 @@ import { RnExecutorchError } from '../errors/errorUtils'; /** * Props for the useVAD hook. + * + * @property {Object} model - An object containing the model source. + * @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 { - /** - * `ResourceSource` that specifies the location of the VAD model binary. - */ model: { modelSource: ResourceSource }; - - /** - * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. - */ preventLoad?: boolean; } /** * Represents a detected audio segment with start and end timestamps. + * + * @property {number} start - Start time of the segment in seconds. + * @property {number} end - End time of the segment in seconds. */ export interface Segment { - /** - * Start time of the segment in seconds. - */ start: number; - - /** - * End time of the segment in seconds. - */ end: number; } From 8aadf865181ee36f48080f1f6795504cc5cb9553 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Tue, 27 Jan 2026 12:03:45 +0100 Subject: [PATCH 11/15] Add new typed modules --- .../classes/ClassificationModule.md | 29 ++- .../classes/ExecutorchModule.md | 14 +- .../classes/ImageEmbeddingsModule.md | 14 +- .../classes/ImageSegmentationModule.md | 14 +- .../06-api-reference/classes/LLMModule.md | 24 +-- .../06-api-reference/classes/OCRModule.md | 10 +- .../classes/ObjectDetectionModule.md | 14 +- .../classes/ResourceFetcher.md | 20 +- .../classes/RnExecutorchError.md | 8 +- .../classes/SpeechToTextModule.md | 18 +- .../classes/StyleTransferModule.md | 14 +- .../classes/TextEmbeddingsModule.md | 14 +- .../classes/TextToImageModule.md | 18 +- .../classes/TextToSpeechModule.md | 14 +- .../classes/TokenizerModule.md | 16 +- .../06-api-reference/classes/VADModule.md | 14 +- .../classes/VerticalOCRModule.md | 10 +- .../enumerations/CocoLabel.md | 182 +++++++++--------- .../enumerations/DeeplabLabel.md | 46 ++--- .../enumerations/RnExecutorchErrorCode.md | 86 ++++----- .../enumerations/ScalarType.md | 46 ++--- .../DEFAULT_STRUCTURED_OUTPUT_PROMPT.md | 2 +- .../fixAndValidateStructuredOutput.md | 2 +- .../functions/getStructuredOutputPrompt.md | 2 +- .../functions/useClassification.md | 2 +- .../functions/useExecutorchModule.md | 2 +- .../functions/useImageEmbeddings.md | 2 +- .../functions/useImageSegmentation.md | 2 +- .../docs/06-api-reference/functions/useLLM.md | 2 +- .../docs/06-api-reference/functions/useOCR.md | 2 +- .../functions/useObjectDetection.md | 2 +- .../functions/useSpeechToText.md | 2 +- .../functions/useStyleTransfer.md | 2 +- .../functions/useTextEmbeddings.md | 2 +- .../functions/useTextToImage.md | 2 +- .../functions/useTextToSpeech.md | 2 +- .../functions/useTokenizer.md | 2 +- .../docs/06-api-reference/functions/useVAD.md | 2 +- .../functions/useVerticalOCR.md | 2 +- docs/docs/06-api-reference/interfaces/Bbox.md | 10 +- .../06-api-reference/interfaces/ChatConfig.md | 8 +- .../interfaces/ClassificationProps.md | 6 +- .../interfaces/ClassificationType.md | 12 +- .../interfaces/DecodingOptions.md | 4 +- .../06-api-reference/interfaces/Detection.md | 8 +- .../interfaces/ExecutorchModuleProps.md | 6 +- .../interfaces/ExecutorchModuleType.md | 12 +- .../interfaces/GenerationConfig.md | 10 +- .../interfaces/ImageEmbeddingsProps.md | 6 +- .../interfaces/ImageEmbeddingsType.md | 12 +- .../interfaces/ImageSegmentationProps.md | 6 +- .../interfaces/ImageSegmentationType.md | 12 +- .../interfaces/KokoroConfig.md | 8 +- .../interfaces/KokoroVoiceExtras.md | 6 +- .../06-api-reference/interfaces/LLMConfig.md | 8 +- .../06-api-reference/interfaces/LLMType.md | 28 +-- .../06-api-reference/interfaces/Message.md | 6 +- .../interfaces/OCRDetection.md | 8 +- .../06-api-reference/interfaces/OCRProps.md | 6 +- .../06-api-reference/interfaces/OCRType.md | 12 +- .../interfaces/ObjectDetectionProps.md | 6 +- .../interfaces/ObjectDetectionType.md | 12 +- .../docs/06-api-reference/interfaces/Point.md | 6 +- .../06-api-reference/interfaces/Segment.md | 6 +- .../interfaces/SpeechToTextModelConfig.md | 10 +- .../interfaces/SpeechToTextType.md | 26 +-- .../interfaces/StyleTransferProps.md | 6 +- .../interfaces/StyleTransferType.md | 12 +- .../06-api-reference/interfaces/TensorPtr.md | 8 +- .../interfaces/TextEmbeddingsProps.md | 6 +- .../interfaces/TextEmbeddingsType.md | 12 +- .../interfaces/TextToImageParams.md | 8 +- .../interfaces/TextToImageType.md | 14 +- .../interfaces/TextToSpeechConfig.md | 6 +- .../interfaces/TextToSpeechInput.md | 6 +- .../interfaces/TextToSpeechProps.md | 8 +- .../interfaces/TextToSpeechStreamingInput.md | 12 +- .../interfaces/TextToSpeechType.md | 16 +- .../interfaces/TokenizerType.md | 20 +- .../06-api-reference/interfaces/ToolCall.md | 6 +- .../interfaces/ToolsConfig.md | 8 +- .../06-api-reference/interfaces/VADProps.md | 6 +- .../06-api-reference/interfaces/VADType.md | 12 +- .../interfaces/VerticalOCRProps.md | 8 +- .../interfaces/VoiceConfig.md | 8 +- .../06-api-reference/type-aliases/LLMTool.md | 2 +- .../type-aliases/MessageRole.md | 2 +- .../type-aliases/OCRLanguage.md | 2 +- .../type-aliases/ResourceSource.md | 2 +- .../type-aliases/SpeechToTextLanguage.md | 2 +- .../type-aliases/TensorBuffer.md | 2 +- .../type-aliases/TextToSpeechLanguage.md | 2 +- .../variables/ALL_MINILM_L6_V2.md | 2 +- .../variables/ALL_MPNET_BASE_V2.md | 2 +- .../variables/BK_SDM_TINY_VPRED_256.md | 2 +- .../variables/BK_SDM_TINY_VPRED_512.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 2 +- .../variables/DEEPLAB_V3_RESNET50.md | 2 +- .../variables/DEFAULT_CHAT_CONFIG.md | 2 +- .../DEFAULT_CONTEXT_WINDOW_LENGTH.md | 2 +- .../variables/DEFAULT_MESSAGE_HISTORY.md | 2 +- .../variables/DEFAULT_SYSTEM_PROMPT.md | 2 +- .../variables/EFFICIENTNET_V2_S.md | 2 +- .../06-api-reference/variables/FSMN_VAD.md | 2 +- .../variables/HAMMER2_1_0_5B.md | 2 +- .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_1_5B.md | 2 +- .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_3B.md | 2 +- .../variables/HAMMER2_1_3B_QUANTIZED.md | 2 +- .../variables/KOKORO_MEDIUM.md | 2 +- .../variables/KOKORO_SMALL.md | 2 +- .../variables/KOKORO_VOICE_AF_HEART.md | 2 +- .../variables/KOKORO_VOICE_AF_RIVER.md | 2 +- .../variables/KOKORO_VOICE_AF_SARAH.md | 2 +- .../variables/KOKORO_VOICE_AM_ADAM.md | 2 +- .../variables/KOKORO_VOICE_AM_MICHAEL.md | 2 +- .../variables/KOKORO_VOICE_AM_SANTA.md | 2 +- .../variables/KOKORO_VOICE_BF_EMMA.md | 2 +- .../variables/KOKORO_VOICE_BM_DANIEL.md | 2 +- .../06-api-reference/variables/LLAMA3_2_1B.md | 2 +- .../variables/LLAMA3_2_1B_QLORA.md | 2 +- .../variables/LLAMA3_2_1B_SPINQUANT.md | 2 +- .../06-api-reference/variables/LLAMA3_2_3B.md | 2 +- .../variables/LLAMA3_2_3B_QLORA.md | 2 +- .../variables/LLAMA3_2_3B_SPINQUANT.md | 2 +- .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 2 +- .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 2 +- .../06-api-reference/variables/OCR_ABAZA.md | 2 +- .../06-api-reference/variables/OCR_ADYGHE.md | 2 +- .../variables/OCR_AFRIKAANS.md | 2 +- .../variables/OCR_ALBANIAN.md | 2 +- .../06-api-reference/variables/OCR_AVAR.md | 2 +- .../variables/OCR_AZERBAIJANI.md | 2 +- .../variables/OCR_BELARUSIAN.md | 2 +- .../06-api-reference/variables/OCR_BOSNIAN.md | 2 +- .../variables/OCR_BULGARIAN.md | 2 +- .../06-api-reference/variables/OCR_CHECHEN.md | 2 +- .../variables/OCR_CROATIAN.md | 2 +- .../06-api-reference/variables/OCR_CZECH.md | 2 +- .../06-api-reference/variables/OCR_DANISH.md | 2 +- .../06-api-reference/variables/OCR_DARGWA.md | 2 +- .../06-api-reference/variables/OCR_DUTCH.md | 2 +- .../06-api-reference/variables/OCR_ENGLISH.md | 2 +- .../variables/OCR_ESTONIAN.md | 2 +- .../06-api-reference/variables/OCR_FRENCH.md | 2 +- .../06-api-reference/variables/OCR_GERMAN.md | 2 +- .../variables/OCR_HUNGARIAN.md | 2 +- .../variables/OCR_ICELANDIC.md | 2 +- .../variables/OCR_INDONESIAN.md | 2 +- .../06-api-reference/variables/OCR_INGUSH.md | 2 +- .../06-api-reference/variables/OCR_IRISH.md | 2 +- .../06-api-reference/variables/OCR_ITALIAN.md | 2 +- .../variables/OCR_JAPANESE.md | 2 +- .../06-api-reference/variables/OCR_KANNADA.md | 2 +- .../variables/OCR_KARBADIAN.md | 2 +- .../06-api-reference/variables/OCR_KOREAN.md | 2 +- .../06-api-reference/variables/OCR_KURDISH.md | 2 +- .../06-api-reference/variables/OCR_LAK.md | 2 +- .../06-api-reference/variables/OCR_LATIN.md | 2 +- .../06-api-reference/variables/OCR_LATVIAN.md | 2 +- .../variables/OCR_LEZGHIAN.md | 2 +- .../variables/OCR_LITHUANIAN.md | 2 +- .../06-api-reference/variables/OCR_MALAY.md | 2 +- .../06-api-reference/variables/OCR_MALTESE.md | 2 +- .../06-api-reference/variables/OCR_MAORI.md | 2 +- .../variables/OCR_MONGOLIAN.md | 2 +- .../variables/OCR_NORWEGIAN.md | 2 +- .../06-api-reference/variables/OCR_OCCITAN.md | 2 +- .../06-api-reference/variables/OCR_PALI.md | 2 +- .../06-api-reference/variables/OCR_POLISH.md | 2 +- .../variables/OCR_PORTUGUESE.md | 2 +- .../variables/OCR_ROMANIAN.md | 2 +- .../06-api-reference/variables/OCR_RUSSIAN.md | 2 +- .../variables/OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/OCR_SERBIAN_LATIN.md | 2 +- .../variables/OCR_SIMPLIFIED_CHINESE.md | 2 +- .../06-api-reference/variables/OCR_SLOVAK.md | 2 +- .../variables/OCR_SLOVENIAN.md | 2 +- .../06-api-reference/variables/OCR_SPANISH.md | 2 +- .../06-api-reference/variables/OCR_SWAHILI.md | 2 +- .../06-api-reference/variables/OCR_SWEDISH.md | 2 +- .../variables/OCR_TABASSARAN.md | 2 +- .../06-api-reference/variables/OCR_TAGALOG.md | 2 +- .../06-api-reference/variables/OCR_TAJIK.md | 2 +- .../06-api-reference/variables/OCR_TELUGU.md | 2 +- .../06-api-reference/variables/OCR_TURKISH.md | 2 +- .../variables/OCR_UKRAINIAN.md | 2 +- .../06-api-reference/variables/OCR_UZBEK.md | 2 +- .../variables/OCR_VIETNAMESE.md | 2 +- .../06-api-reference/variables/OCR_WELSH.md | 2 +- .../variables/PHI_4_MINI_4B.md | 2 +- .../variables/PHI_4_MINI_4B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_0_5B.md | 2 +- .../variables/QWEN2_5_0_5B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_1_5B.md | 2 +- .../variables/QWEN2_5_1_5B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN2_5_3B.md | 2 +- .../variables/QWEN2_5_3B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_0_6B.md | 2 +- .../variables/QWEN3_0_6B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_1_7B.md | 2 +- .../variables/QWEN3_1_7B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_4B.md | 2 +- .../variables/QWEN3_4B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_135M.md | 2 +- .../variables/SMOLLM2_1_135M_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_1_7B.md | 2 +- .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_360M.md | 2 +- .../variables/SMOLLM2_1_360M_QUANTIZED.md | 2 +- .../variables/SPECIAL_TOKENS.md | 2 +- .../SSDLITE_320_MOBILENET_V3_LARGE.md | 2 +- .../variables/STYLE_TRANSFER_CANDY.md | 2 +- .../variables/STYLE_TRANSFER_MOSAIC.md | 2 +- .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 2 +- .../variables/STYLE_TRANSFER_UDNIE.md | 2 +- .../variables/VERTICAL_OCR_ABAZA.md | 2 +- .../variables/VERTICAL_OCR_ADYGHE.md | 2 +- .../variables/VERTICAL_OCR_AFRIKAANS.md | 2 +- .../variables/VERTICAL_OCR_ALBANIAN.md | 2 +- .../variables/VERTICAL_OCR_AVAR.md | 2 +- .../variables/VERTICAL_OCR_AZERBAIJANI.md | 2 +- .../variables/VERTICAL_OCR_BELARUSIAN.md | 2 +- .../variables/VERTICAL_OCR_BOSNIAN.md | 2 +- .../variables/VERTICAL_OCR_BULGARIAN.md | 2 +- .../variables/VERTICAL_OCR_CHECHEN.md | 2 +- .../variables/VERTICAL_OCR_CROATIAN.md | 2 +- .../variables/VERTICAL_OCR_CZECH.md | 2 +- .../variables/VERTICAL_OCR_DANISH.md | 2 +- .../variables/VERTICAL_OCR_DARGWA.md | 2 +- .../variables/VERTICAL_OCR_DUTCH.md | 2 +- .../variables/VERTICAL_OCR_ENGLISH.md | 2 +- .../variables/VERTICAL_OCR_ESTONIAN.md | 2 +- .../variables/VERTICAL_OCR_FRENCH.md | 2 +- .../variables/VERTICAL_OCR_GERMAN.md | 2 +- .../variables/VERTICAL_OCR_HUNGARIAN.md | 2 +- .../variables/VERTICAL_OCR_ICELANDIC.md | 2 +- .../variables/VERTICAL_OCR_INDONESIAN.md | 2 +- .../variables/VERTICAL_OCR_INGUSH.md | 2 +- .../variables/VERTICAL_OCR_IRISH.md | 2 +- .../variables/VERTICAL_OCR_ITALIAN.md | 2 +- .../variables/VERTICAL_OCR_JAPANESE.md | 2 +- .../variables/VERTICAL_OCR_KANNADA.md | 2 +- .../variables/VERTICAL_OCR_KARBADIAN.md | 2 +- .../variables/VERTICAL_OCR_KOREAN.md | 2 +- .../variables/VERTICAL_OCR_KURDISH.md | 2 +- .../variables/VERTICAL_OCR_LAK.md | 2 +- .../variables/VERTICAL_OCR_LATIN.md | 2 +- .../variables/VERTICAL_OCR_LATVIAN.md | 2 +- .../variables/VERTICAL_OCR_LEZGHIAN.md | 2 +- .../variables/VERTICAL_OCR_LITHUANIAN.md | 2 +- .../variables/VERTICAL_OCR_MALAY.md | 2 +- .../variables/VERTICAL_OCR_MALTESE.md | 2 +- .../variables/VERTICAL_OCR_MAORI.md | 2 +- .../variables/VERTICAL_OCR_MONGOLIAN.md | 2 +- .../variables/VERTICAL_OCR_NORWEGIAN.md | 2 +- .../variables/VERTICAL_OCR_OCCITAN.md | 2 +- .../variables/VERTICAL_OCR_PALI.md | 2 +- .../variables/VERTICAL_OCR_POLISH.md | 2 +- .../variables/VERTICAL_OCR_PORTUGUESE.md | 2 +- .../variables/VERTICAL_OCR_ROMANIAN.md | 2 +- .../variables/VERTICAL_OCR_RUSSIAN.md | 2 +- .../VERTICAL_OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/VERTICAL_OCR_SERBIAN_LATIN.md | 2 +- .../VERTICAL_OCR_SIMPLIFIED_CHINESE.md | 2 +- .../variables/VERTICAL_OCR_SLOVAK.md | 2 +- .../variables/VERTICAL_OCR_SLOVENIAN.md | 2 +- .../variables/VERTICAL_OCR_SPANISH.md | 2 +- .../variables/VERTICAL_OCR_SWAHILI.md | 2 +- .../variables/VERTICAL_OCR_SWEDISH.md | 2 +- .../variables/VERTICAL_OCR_TABASSARAN.md | 2 +- .../variables/VERTICAL_OCR_TAGALOG.md | 2 +- .../variables/VERTICAL_OCR_TAJIK.md | 2 +- .../variables/VERTICAL_OCR_TELUGU.md | 2 +- .../variables/VERTICAL_OCR_TURKISH.md | 2 +- .../variables/VERTICAL_OCR_UKRAINIAN.md | 2 +- .../variables/VERTICAL_OCR_UZBEK.md | 2 +- .../variables/VERTICAL_OCR_VIETNAMESE.md | 2 +- .../variables/VERTICAL_OCR_WELSH.md | 2 +- .../variables/WHISPER_BASE.md | 2 +- .../variables/WHISPER_BASE_EN.md | 2 +- .../variables/WHISPER_SMALL.md | 2 +- .../variables/WHISPER_SMALL_EN.md | 2 +- .../variables/WHISPER_TINY.md | 2 +- .../variables/WHISPER_TINY_EN.md | 2 +- .../variables/WHISPER_TINY_EN_QUANTIZED.md | 2 +- .../variables/parseToolCall.md | 2 +- 289 files changed, 763 insertions(+), 748 deletions(-) diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index 9ab799644..b2039b4c7 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,8 @@ # Class: ClassificationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L10) + +Module for image classification tasks. ## Extends @@ -26,7 +28,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Class > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +60,9 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L41) + +Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. #### Parameters @@ -66,17 +70,21 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Class `string` +The image source to be classified. + #### Returns `Promise`\<`any`\> +The classification result. + *** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -105,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -139,12 +147,17 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L18) + +Loads the model, where `modelSource` is a string that specifies the location of the model binary. +To track the download progress, supply a callback function `onDownloadProgressCallback`. #### Parameters ##### model +Object containing `modelSource`. + ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) @@ -153,6 +166,8 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Class (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index c370eb9ff..20126d727 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -1,6 +1,6 @@ # Class: ExecutorchModule -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L40) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L40) Executes the model's forward pass, where input is an array of `TensorPtr` objects. If the inference is successful, an array of tensor pointers is returned. @@ -83,7 +83,7 @@ An array of output tensor pointers. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -112,7 +112,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -146,7 +146,7 @@ The input shape as an array of numbers. > **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L16) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L16) Loads the model, where `modelSource` is a string, number, or object that specifies the location of the model binary. Optionally accepts a download progress callback. diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md index 3fe5bd836..bebf322e2 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: ImageEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -105,7 +105,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -139,7 +139,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md index 2b38719fb..af00558d5 100644 --- a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -1,6 +1,6 @@ # Class: ImageSegmentationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md index b71a167ca..75c743c78 100644 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -1,6 +1,6 @@ # Class: LLMModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L12) Module for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Module for managing a Large Language Model (LLM) instance. > **new LLMModule**(`optionalCallbacks`): `LLMModule` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L21) Creates a new instance of LLMModule with optional callbacks. @@ -50,7 +50,7 @@ A new LLMModule instance. > **configure**(`configuration`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) Configures chat and tool calling and generation settings. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -73,7 +73,7 @@ Configuration object containing `chatConfig`, `toolsConfig`, and `generationConf > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:169](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L169) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:169](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L169) Method to delete the model from memory. Note you cannot delete model while it's generating. @@ -89,7 +89,7 @@ You need to interrupt it first and make sure model stopped generation. > **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:143](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L143) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:143](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L143) Deletes all messages starting with message on `index` position. After deletion it will call `messageHistoryCallback()` containing new history. @@ -115,7 +115,7 @@ The index of the message to delete from history. > **forward**(`input`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:105](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L105) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:105](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L105) Runs model inference with raw input string. You need to provide entire conversation and prompt (in correct format and with special tokens!) in input string to this method. @@ -142,7 +142,7 @@ The generated response as a string. > **generate**(`messages`, `tools?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:117](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L117) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:117](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L117) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -172,7 +172,7 @@ The generated response as a string. > **getGeneratedTokenCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:160](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L160) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:160](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L160) Returns the number of tokens generated in the last response. @@ -188,7 +188,7 @@ The count of generated tokens. > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L151) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L151) Interrupts model generation. It may return one more token after interrupt. @@ -202,7 +202,7 @@ Interrupts model generation. It may return one more token after interrupt. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L55) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L55) Loads the LLM model and tokenizer. @@ -246,7 +246,7 @@ Optional callback to track download progress (value between 0 and 1). > **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:130](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L130) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:130](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L130) Method to add user message to conversation. After model responds it will call `messageHistoryCallback()` containing both user message and model response. @@ -272,7 +272,7 @@ The message string to send. > **setTokenCallback**(`tokenCallback`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) Sets new token callback invoked on every token batch. diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md index 61563ca3c..4e9855d65 100644 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -1,6 +1,6 @@ # Class: OCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **new OCRModule**(): `OCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index 4e839f275..6c2095a7b 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -1,6 +1,6 @@ # Class: ObjectDetectionModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) #### Parameters @@ -80,7 +80,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -109,7 +109,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -143,7 +143,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) #### Parameters diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md index b6f3a5bb4..47a238246 100644 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -1,6 +1,6 @@ # Class: ResourceFetcher -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](h > `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](h > `static` **cancelFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251]( > `static` **deleteResources**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278]( > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](h > `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290]( > `static` **listDownloadedFiles**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) #### Returns @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268]( > `static` **listDownloadedModels**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) #### Returns @@ -126,7 +126,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273]( > `static` **pauseFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) #### Parameters @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241]( > `static` **resumeFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) #### Parameters diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md index 2ad557e88..0dfc4ad98 100644 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -1,6 +1,6 @@ # Class: RnExecutorchError -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/errorUtils.ts#L3) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/errorUtils.ts#L3) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https: > **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/errorUtils.ts#L14) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/errorUtils.ts#L14) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https > `optional` **cause**: `unknown` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/errorUtils.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/errorUtils.ts#L12) The original cause of the error, if any. @@ -56,7 +56,7 @@ The original cause of the error, if any. > **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/errorUtils.ts#L7) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/errorUtils.ts#L7) The error code representing the type of error. diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md index adb33064b..af8d6bcf3 100644 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -1,6 +1,6 @@ # Class: SpeechToTextModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L10) Module for Speech to Text (STT) functionalities. @@ -20,7 +20,7 @@ Module for Speech to Text (STT) functionalities. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:94](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L94) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:94](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L94) Runs the decoder of the model. Passing number[] is deprecated. @@ -50,7 +50,7 @@ Decoded output. > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L64) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L64) Unloads the model from memory. @@ -64,7 +64,7 @@ Unloads the model from memory. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:75](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L75) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:75](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L75) Runs the encoding part of the model on the provided waveform. Returns the encoded waveform as a Float32Array. Passing `number[]` is deprecated. @@ -89,7 +89,7 @@ The encoded output. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27) Loads the model specified by the config object. `onDownloadProgressCallback` allows you to monitor the current progress of the model download. @@ -118,7 +118,7 @@ Optional callback to monitor download progress. > **stream**(`options`): `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L151) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L151) Starts a streaming transcription session. Yields objects with `committed` and `nonCommitted` transcriptions. @@ -144,7 +144,7 @@ An async generator yielding transcription updates. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:211](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L211) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:211](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L211) Inserts a new audio chunk into the streaming transcription session. Passing `number[]` is deprecated. @@ -166,7 +166,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:224](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L224) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:224](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L224) Stops the current streaming transcription session. @@ -180,7 +180,7 @@ Stops the current streaming transcription session. > **transcribe**(`waveform`, `options`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:124](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L124) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:124](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L124) Starts a transcription process for a given input array (16kHz waveform). For multilingual models, specify the language in `options`. diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index 732bab437..9bd0b5d23 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,6 @@ # Class: StyleTransferModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -105,7 +105,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -139,7 +139,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index 8d81802ba..a44f293cf 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: TextEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L10) Module for generating text embeddings from input text. @@ -28,7 +28,7 @@ Module for generating text embeddings from input text. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:53](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L53) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:53](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L53) Executes the model's forward pass, where `input` is a text that will be embedded. @@ -84,7 +84,7 @@ A Float32Array containing the vector embeddings. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L20) Loads the model and tokenizer specified by the config object. diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index 21bdff597..786b93fde 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -1,6 +1,6 @@ # Class: TextToImageModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) #### Parameters @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -48,7 +48,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -66,7 +66,7 @@ Unloads the model from memory. > **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) #### Parameters @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -125,7 +125,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -159,7 +159,7 @@ The input shape as an array of numbers. > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) #### Returns @@ -171,7 +171,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextToSpeechModule.md b/docs/docs/06-api-reference/classes/TextToSpeechModule.md index 64f89b456..c768413f7 100644 --- a/docs/docs/06-api-reference/classes/TextToSpeechModule.md +++ b/docs/docs/06-api-reference/classes/TextToSpeechModule.md @@ -1,6 +1,6 @@ # Class: TextToSpeechModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L14) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L14) Module for Text to Speech (TTS) functionalities. @@ -20,7 +20,7 @@ Module for Text to Speech (TTS) functionalities. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L18) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L18) Native module instance @@ -30,7 +30,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:164](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L164) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:164](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L164) Unloads the model from memory. @@ -44,7 +44,7 @@ Unloads the model from memory. > **forward**(`text`, `speed`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:97](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L97) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:97](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L97) Synthesizes the provided text into speech. Returns a promise that resolves to the full audio waveform as a `Float32Array`. @@ -75,7 +75,7 @@ A promise resolving to the synthesized audio waveform. > **load**(`config`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L27) Loads the model and voice assets specified by the config object. `onDownloadProgressCallback` allows you to monitor the current progress. @@ -104,7 +104,7 @@ Optional callback to monitor download progress. > **stream**(`input`): `AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>, `void`, `unknown`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:112](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L112) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:112](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L112) Starts a streaming synthesis session. Yields audio chunks as they are generated. @@ -128,7 +128,7 @@ An async generator yielding Float32Array audio chunks. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:157](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L157) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:157](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L157) Stops the streaming process if there is any ongoing. diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md index 3261e6231..f2ae0bed2 100644 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -1,6 +1,6 @@ # Class: TokenizerModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L10) Native module instance @@ -28,7 +28,7 @@ Native module instance > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L54) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L54) Converts an array of token IDs into a string. @@ -58,7 +58,7 @@ The decoded string. > **encode**(`input`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:43](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L43) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:43](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L43) Converts a string into an array of token IDs. @@ -82,7 +82,7 @@ An array of token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L66) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L66) Returns the size of the tokenizer's vocabulary. @@ -98,7 +98,7 @@ The vocabulary size. > **idToToken**(`tokenId`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:76](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L76) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:76](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L76) Returns the token associated to the ID. @@ -122,7 +122,7 @@ The token string associated to ID. > **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L19) Loads the tokenizer from the specified source. `tokenizerSource` is a string that points to the location of the tokenizer JSON file. @@ -153,7 +153,7 @@ Optional callback to monitor download progress. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L86) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L86) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index 743c16607..82c67f997 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -1,6 +1,6 @@ # Class: VADModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L39) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L39) Executes the model's forward pass, where `waveform` is a Float32Array representing the audio signal. @@ -82,7 +82,7 @@ A promise resolving to an array of detected speech segments. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -111,7 +111,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -145,7 +145,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L16) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L16) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md index 0308d7c7c..d62bed8f1 100644 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -1,6 +1,6 @@ # Class: VerticalOCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **new VerticalOCRModule**(): `VerticalOCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/enumerations/CocoLabel.md b/docs/docs/06-api-reference/enumerations/CocoLabel.md index 0388788ff..8ccc629d9 100644 --- a/docs/docs/06-api-reference/enumerations/CocoLabel.md +++ b/docs/docs/06-api-reference/enumerations/CocoLabel.md @@ -1,6 +1,6 @@ # Enumeration: CocoLabel -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:35](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L35) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:35](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L35) COCO dataset class labels used for object detection. @@ -10,7 +10,7 @@ COCO dataset class labels used for object detection. > **AIRPLANE**: `5` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L40) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L40) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](h > **APPLE**: `53` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L87) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L87) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](h > **BACKPACK**: `27` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L62) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L62) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](h > **BANANA**: `52` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L86) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L86) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](h > **BASEBALL**: `39` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L74) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L74) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](h > **BEAR**: `23` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L58) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L58) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](h > **BED**: `65` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L99) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L99) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](h > **BENCH**: `15` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L50) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L50) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](h > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L37) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L37) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](h > **BIRD**: `16` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L51) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L51) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](h > **BLENDER**: `83` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L117) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L117) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117]( > **BOAT**: `9` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L44) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L44) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](h > **BOOK**: `84` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L118) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L118) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118]( > **BOTTLE**: `44` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L78) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L78) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](h > **BOWL**: `51` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L85) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L85) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](h > **BROCCOLI**: `56` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L90) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L90) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](h > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L41) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L41) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](h > **CAKE**: `61` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L95) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L95) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](h > **CAR**: `3` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L38) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L38) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](h > **CARROT**: `57` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L91) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L91) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](h > **CAT**: `17` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L52) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L52) *** @@ -178,7 +178,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](h > **CELL\_PHONE**: `77` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L111) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L111) *** @@ -186,7 +186,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111]( > **CHAIR**: `62` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L96) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L96) *** @@ -194,7 +194,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](h > **CLOCK**: `85` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L119) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L119) *** @@ -202,7 +202,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119]( > **COUCH**: `63` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L97) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L97) *** @@ -210,7 +210,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](h > **COW**: `21` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L56) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L56) *** @@ -218,7 +218,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](h > **CUP**: `47` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L81) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L81) *** @@ -226,7 +226,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](h > **DESK**: `69` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L103) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L103) *** @@ -234,7 +234,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103]( > **DINING\_TABLE**: `67` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L101) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L101) *** @@ -242,7 +242,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101]( > **DOG**: `18` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L53) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L53) *** @@ -250,7 +250,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](h > **DONUT**: `60` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L94) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L94) *** @@ -258,7 +258,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](h > **DOOR**: `71` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L105) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L105) *** @@ -266,7 +266,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105]( > **ELEPHANT**: `22` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L57) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L57) *** @@ -274,7 +274,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](h > **EYE**: `30` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L65) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L65) *** @@ -282,7 +282,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](h > **FIRE\_HYDRANT**: `11` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L46) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L46) *** @@ -290,7 +290,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](h > **FORK**: `48` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L82) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L82) *** @@ -298,7 +298,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](h > **FRISBEE**: `34` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L69) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L69) *** @@ -306,7 +306,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](h > **GIRAFFE**: `25` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L60) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L60) *** @@ -314,7 +314,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](h > **HAIR\_BRUSH**: `91` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L125) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L125) *** @@ -322,7 +322,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125]( > **HAIR\_DRIER**: `89` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L123) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L123) *** @@ -330,7 +330,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123]( > **HANDBAG**: `31` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L66) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L66) *** @@ -338,7 +338,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](h > **HAT**: `26` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L61) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L61) *** @@ -346,7 +346,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](h > **HORSE**: `19` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L54) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L54) *** @@ -354,7 +354,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](h > **HOT\_DOG**: `58` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L92) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L92) *** @@ -362,7 +362,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](h > **KEYBOARD**: `76` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L110) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L110) *** @@ -370,7 +370,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110]( > **KITE**: `38` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L73) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L73) *** @@ -378,7 +378,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](h > **KNIFE**: `49` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L83) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L83) *** @@ -386,7 +386,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](h > **LAPTOP**: `73` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L107) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L107) *** @@ -394,7 +394,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107]( > **MICROWAVE**: `78` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L112) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L112) *** @@ -402,7 +402,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112]( > **MIRROR**: `66` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L100) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L100) *** @@ -410,7 +410,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100]( > **MOTORCYCLE**: `4` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L39) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L39) *** @@ -418,7 +418,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](h > **MOUSE**: `74` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L108) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L108) *** @@ -426,7 +426,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108]( > **ORANGE**: `55` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L89) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L89) *** @@ -434,7 +434,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](h > **OVEN**: `79` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L113) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L113) *** @@ -442,7 +442,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113]( > **PARKING**: `14` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L49) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L49) *** @@ -450,7 +450,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](h > **PERSON**: `1` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L36) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L36) *** @@ -458,7 +458,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](h > **PIZZA**: `59` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L93) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L93) *** @@ -466,7 +466,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](h > **PLATE**: `45` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L79) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L79) *** @@ -474,7 +474,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](h > **POTTED\_PLANT**: `64` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L98) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L98) *** @@ -482,7 +482,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](h > **REFRIGERATOR**: `82` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L116) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L116) *** @@ -490,7 +490,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116]( > **REMOTE**: `75` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L109) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L109) *** @@ -498,7 +498,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109]( > **SANDWICH**: `54` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L88) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L88) *** @@ -506,7 +506,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](h > **SCISSORS**: `87` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L121) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L121) *** @@ -514,7 +514,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121]( > **SHEEP**: `20` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L55) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L55) *** @@ -522,7 +522,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](h > **SHOE**: `29` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L64) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L64) *** @@ -530,7 +530,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](h > **SINK**: `81` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L115) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L115) *** @@ -538,7 +538,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115]( > **SKATEBOARD**: `41` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L75) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L75) *** @@ -546,7 +546,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](h > **SKIS**: `35` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L70) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L70) *** @@ -554,7 +554,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](h > **SNOWBOARD**: `36` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L71) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L71) *** @@ -562,7 +562,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](h > **SPOON**: `50` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L84) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L84) *** @@ -570,7 +570,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](h > **SPORTS**: `37` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L72) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L72) *** @@ -578,7 +578,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](h > **STOP\_SIGN**: `13` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L48) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L48) *** @@ -586,7 +586,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](h > **STREET\_SIGN**: `12` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L47) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L47) *** @@ -594,7 +594,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](h > **SUITCASE**: `33` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L68) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L68) *** @@ -602,7 +602,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](h > **SURFBOARD**: `42` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L76) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L76) *** @@ -610,7 +610,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](h > **TEDDY\_BEAR**: `88` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L122) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L122) *** @@ -618,7 +618,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122]( > **TENNIS\_RACKET**: `43` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L77) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L77) *** @@ -626,7 +626,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](h > **TIE**: `32` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L67) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L67) *** @@ -634,7 +634,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](h > **TOASTER**: `80` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L114) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L114) *** @@ -642,7 +642,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114]( > **TOILET**: `70` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L104) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L104) *** @@ -650,7 +650,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104]( > **TOOTHBRUSH**: `90` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L124) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L124) *** @@ -658,7 +658,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124]( > **TRAFFIC\_LIGHT**: `10` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L45) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L45) *** @@ -666,7 +666,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](h > **TRAIN**: `7` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L42) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L42) *** @@ -674,7 +674,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](h > **TRUCK**: `8` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L43) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L43) *** @@ -682,7 +682,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](h > **TV**: `72` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L106) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L106) *** @@ -690,7 +690,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106]( > **UMBRELLA**: `28` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L63) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L63) *** @@ -698,7 +698,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](h > **VASE**: `86` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L120) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L120) *** @@ -706,7 +706,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120]( > **WINDOW**: `68` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L102) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L102) *** @@ -714,7 +714,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102]( > **WINE\_GLASS**: `46` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L80) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L80) *** @@ -722,4 +722,4 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](h > **ZEBRA**: `24` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L59) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L59) diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md index e684e0e70..46c33b434 100644 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -1,6 +1,6 @@ # Enumeration: DeeplabLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5]( > **AEROPLANE**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7]( > **ARGMAX**: `21` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27] > **BACKGROUND**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) *** @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6]( > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) *** @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8]( > **BIRD**: `3` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) *** @@ -48,7 +48,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9]( > **BOAT**: `4` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) *** @@ -56,7 +56,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10] > **BOTTLE**: `5` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) *** @@ -64,7 +64,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11] > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) *** @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12] > **CAR**: `7` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) *** @@ -80,7 +80,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13] > **CAT**: `8` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) *** @@ -88,7 +88,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14] > **CHAIR**: `9` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) *** @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15] > **COW**: `10` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) *** @@ -104,7 +104,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16] > **DININGTABLE**: `11` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) *** @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17] > **DOG**: `12` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) *** @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18] > **HORSE**: `13` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) *** @@ -128,7 +128,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19] > **MOTORBIKE**: `14` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) *** @@ -136,7 +136,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20] > **PERSON**: `15` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) *** @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21] > **POTTEDPLANT**: `16` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) *** @@ -152,7 +152,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22] > **SHEEP**: `17` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) *** @@ -160,7 +160,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23] > **SOFA**: `18` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) *** @@ -168,7 +168,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24] > **TRAIN**: `19` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) *** @@ -176,4 +176,4 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25] > **TVMONITOR**: `20` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md index 5f19a1251..16eee3e11 100644 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -1,6 +1,6 @@ # Enumeration: RnExecutorchErrorCode -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https: > **AccessFailed**: `34` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](http > **DelegateInvalidCompatibility**: `48` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](http > **DelegateInvalidHandle**: `50` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) *** @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](http > **DelegateMemoryAllocationFailed**: `49` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) *** @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](http > **DownloadInterrupted**: `118` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) Thrown when the number of downloaded files is unexpected, due to download interruptions. @@ -50,7 +50,7 @@ Thrown when the number of downloaded files is unexpected, due to download interr > **EndOfMethod**: `3` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](http > **FileReadFailed**: `114` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. @@ -68,7 +68,7 @@ Thrown when a file read operation failed. This could be invalid image url passed > **FileWriteFailed**: `103` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) An error ocurred when saving a file. This could be, for instance a result image from an image model. @@ -78,7 +78,7 @@ An error ocurred when saving a file. This could be, for instance a result image > **Internal**: `1` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) *** @@ -86,7 +86,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](http > **InvalidArgument**: `18` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) *** @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](http > **InvalidConfig**: `112` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. @@ -104,7 +104,7 @@ Thrown when config parameters passed to a model are invalid. For example, when L > **InvalidExternalData**: `36` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) *** @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](http > **InvalidModelOutput**: `115` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) Thrown when the size of model output is unexpected. @@ -122,7 +122,7 @@ Thrown when the size of model output is unexpected. > **InvalidModelSource**: `255` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) Thrown when the type of model source passed by the user is invalid. @@ -132,7 +132,7 @@ Thrown when the type of model source passed by the user is invalid. > **InvalidProgram**: `35` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) *** @@ -140,7 +140,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](http > **InvalidState**: `2` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) *** @@ -148,7 +148,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](http > **InvalidType**: `19` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) *** @@ -156,7 +156,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](http > **InvalidUserInput**: `117` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). @@ -166,7 +166,7 @@ Thrown when the input passed to our APIs is invalid, for example when passing an > **LanguageNotSupported**: `105` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. @@ -176,7 +176,7 @@ Thrown when a language is passed to a multi-language model that is not supported > **MemoryAllocationFailed**: `33` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) *** @@ -184,7 +184,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](http > **MissingDataChunk**: `161` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) Thrown when streaming transcription is attempted but audio data chunk is missing. @@ -194,7 +194,7 @@ Thrown when streaming transcription is attempted but audio data chunk is missing > **ModelGenerating**: `104` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. @@ -204,7 +204,7 @@ Thrown when a user tries to run a model that is currently processing. It is only > **ModuleNotLoaded**: `102` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. @@ -214,7 +214,7 @@ Thrown when a user tries to run a model that is not yet downloaded or loaded int > **MultilingualConfiguration**: `160` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. @@ -224,7 +224,7 @@ Thrown when there's a configuration mismatch between multilingual and language s > **NotFound**: `32` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) *** @@ -232,7 +232,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](http > **NotImplemented**: `17` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) *** @@ -240,7 +240,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](http > **NotSupported**: `16` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) *** @@ -248,7 +248,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](http > **Ok**: `0` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) *** @@ -256,7 +256,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](http > **OperatorMissing**: `20` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) *** @@ -264,7 +264,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](http > **OutOfResources**: `37` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) *** @@ -272,7 +272,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](http > **ResourceFetcherAlreadyOngoing**: `183` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) Thrown when trying to resume a download that is already ongoing. @@ -282,7 +282,7 @@ Thrown when trying to resume a download that is already ongoing. > **ResourceFetcherAlreadyPaused**: `182` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) Thrown when trying to pause a download that is already paused. @@ -292,7 +292,7 @@ Thrown when trying to pause a download that is already paused. > **ResourceFetcherDownloadFailed**: `180` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. @@ -302,7 +302,7 @@ Thrown when a resource fails to download. This could be due to invalid URL, or f > **ResourceFetcherDownloadInProgress**: `181` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) Thrown when a user tries to trigger a download that's already in progress. @@ -312,7 +312,7 @@ Thrown when a user tries to trigger a download that's already in progress. > **ResourceFetcherMissingUri**: `185` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) Thrown when required URI information is missing for a download operation. @@ -322,7 +322,7 @@ Thrown when required URI information is missing for a download operation. > **ResourceFetcherNotActive**: `184` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) Thrown when trying to pause, resume, or cancel a download that is not active. @@ -332,7 +332,7 @@ Thrown when trying to pause, resume, or cancel a download that is not active. > **StreamingInProgress**: `163` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) Thrown when trying to start a new streaming session while another is already in progress. @@ -342,7 +342,7 @@ Thrown when trying to start a new streaming session while another is already in > **StreamingNotStarted**: `162` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) Thrown when trying to stop or insert data into a stream that hasn't been started. @@ -352,7 +352,7 @@ Thrown when trying to stop or insert data into a stream that hasn't been started > **ThreadPoolError**: `113` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) Thrown when React Native ExecuTorch threadpool problem occurs. @@ -362,7 +362,7 @@ Thrown when React Native ExecuTorch threadpool problem occurs. > **UnexpectedNumInputs**: `97` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) Thrown when the number of passed inputs to the model is different than the model metadata specifies. @@ -372,7 +372,7 @@ Thrown when the number of passed inputs to the model is different than the model > **UnknownError**: `101` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. @@ -382,6 +382,6 @@ An umbrella-error that is thrown usually when something unexpected happens, for > **WrongDimensions**: `116` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md index b3749c068..056c64a9a 100644 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -1,6 +1,6 @@ # Enumeration: ScalarType -Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L13) +Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L13) Enum representing the scalar types of tensors. @@ -10,7 +10,7 @@ Enum representing the scalar types of tensors. > **BITS16**: `22` -Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L28) +Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L28) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://gi > **BOOL**: `11` -Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L22) +Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L22) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://gi > **BYTE**: `0` -Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L14) +Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L14) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://gi > **CHAR**: `1` -Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L15) +Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L15) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://gi > **DOUBLE**: `7` -Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L21) +Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L21) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://gi > **FLOAT**: `6` -Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L20) +Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L20) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://gi > **FLOAT8E4M3FN**: `24` -Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L30) +Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L30) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://gi > **FLOAT8E4M3FNUZ**: `26` -Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L32) +Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L32) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://gi > **FLOAT8E5M2**: `23` -Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L29) +Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L29) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://gi > **FLOAT8E5M2FNUZ**: `25` -Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L31) +Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L31) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://gi > **HALF**: `5` -Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L19) +Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L19) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://gi > **INT**: `3` -Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L17) +Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L17) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://gi > **LONG**: `4` -Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L18) +Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L18) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://gi > **QINT32**: `14` -Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L25) +Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L25) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://gi > **QINT8**: `12` -Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L23) +Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L23) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://gi > **QUINT2X4**: `17` -Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L27) +Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L27) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://gi > **QUINT4X2**: `16` -Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L26) +Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L26) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://gi > **QUINT8**: `13` -Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L24) +Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L24) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://gi > **SHORT**: `2` -Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L16) +Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L16) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://gi > **UINT16**: `27` -Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L33) +Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L33) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://gi > **UINT32**: `28` -Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L34) +Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L34) *** @@ -178,4 +178,4 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://gi > **UINT64**: `29` -Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L35) +Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L35) diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md index 6e61a84fd..b4d87d81e 100644 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -2,7 +2,7 @@ > **DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT**(`structuredOutputSchema`): `string` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) ## Parameters diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md index 687e5c30c..6503c98b5 100644 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -2,7 +2,7 @@ > **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> -Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/llm.ts#L81) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/llm.ts#L81) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md index efc121e3c..9a5c62edc 100644 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -2,7 +2,7 @@ > **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` -Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/llm.ts#L50) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/llm.ts#L50) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md index d9be62d48..228f08aa2 100644 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -2,7 +2,7 @@ > **useClassification**(`ClassificationConfiguration`): [`ClassificationType`](../interfaces/ClassificationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L11) React hook for managing a Classification model instance. diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md index 122fb5ec9..106482fea 100644 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -2,7 +2,7 @@ > **useExecutorchModule**(`executorchModuleConfiguration`): [`ExecutorchModuleType`](../interfaces/ExecutorchModuleType.md) -Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L11) React hook for managing an arbitrary Executorch module instance. diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md index 3ba04c50f..fe3ef5e90 100644 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -2,7 +2,7 @@ > **useImageEmbeddings**(`ImageEmbeddingsConfiguration`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L11) React hook for managing an Image Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md index e99941043..7e8028dfe 100644 --- a/docs/docs/06-api-reference/functions/useImageSegmentation.md +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -2,7 +2,7 @@ > **useImageSegmentation**(`ImageSegmentationConfiguration`): [`ImageSegmentationType`](../interfaces/ImageSegmentationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L11) React hook for managing an Image Segmentation model instance. diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md index bc6f51ab3..725532967 100644 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -2,7 +2,7 @@ > **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L18) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L18) React hook for managing a Large Language Model (LLM) instance. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md index 6e271f649..5fee1aa06 100644 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -2,7 +2,7 @@ > **useOCR**(`OCRConfiguration`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L12) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L12) React hook for managing an OCR instance. diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md index bf7d54e9a..f378b5432 100644 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -2,7 +2,7 @@ > **useObjectDetection**(`ObjectDetectionConfiguration`): [`ObjectDetectionType`](../interfaces/ObjectDetectionType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L11) React hook for managing an Object Detection model instance. diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md index d590708ce..d3697ce66 100644 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -2,7 +2,7 @@ > **useSpeechToText**(`speechToTextConfiguration`): [`SpeechToTextType`](../interfaces/SpeechToTextType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) React hook for managing a Speech to Text (STT) instance. diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md index c8e0e53fe..094d34221 100644 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -2,7 +2,7 @@ > **useStyleTransfer**(`StyleTransferConfiguration`): [`StyleTransferType`](../interfaces/StyleTransferType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L11) React hook for managing a Style Transfer model instance. diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md index a12fd0b6f..ba77c3495 100644 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -2,7 +2,7 @@ > **useTextEmbeddings**(`TextEmbeddingsConfiguration`): [`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) React hook for managing a Text Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md index 01458c61b..25a0750af 100644 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -2,7 +2,7 @@ > **useTextToImage**(`TextToImageConfiguration`): [`TextToImageType`](../interfaces/TextToImageType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L13) React hook for managing a Text to Image instance. diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md index 54fd038ad..6ce90d878 100644 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -2,7 +2,7 @@ > **useTextToSpeech**(`TextToSpeechConfiguration`): [`TextToSpeechType`](../interfaces/TextToSpeechType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L18) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L18) React hook for managing Text to Speech instance. diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md index 42c0ed24a..dd907e724 100644 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -2,7 +2,7 @@ > **useTokenizer**(`tokenizerConfiguration`): [`TokenizerType`](../interfaces/TokenizerType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) React hook for managing a Tokenizer instance. diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md index 4cde0f29c..5f4881d98 100644 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -2,7 +2,7 @@ > **useVAD**(`VADConfiguration`): [`VADType`](../interfaces/VADType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) React hook for managing a VAD model instance. diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md index 20ec87399..846a1b2f6 100644 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -2,7 +2,7 @@ > **useVerticalOCR**(`VerticalOCRConfiguration`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L12) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L12) React hook for managing a Vertical OCR instance. diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md index 9350b9e52..9b73b939f 100644 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -1,6 +1,6 @@ # Interface: Bbox -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L12) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L12) Represents a bounding box for a detected object in an image. @@ -10,7 +10,7 @@ Represents a bounding box for a detected object in an image. > **x1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L13) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L13) The x-coordinate of the bottom-left corner of the bounding box. @@ -20,7 +20,7 @@ The x-coordinate of the bottom-left corner of the bounding box. > **x2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L14) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L14) The x-coordinate of the top-right corner of the bounding box. @@ -30,7 +30,7 @@ The x-coordinate of the top-right corner of the bounding box. > **y1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L15) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L15) The y-coordinate of the bottom-left corner of the bounding box. @@ -40,6 +40,6 @@ The y-coordinate of the bottom-left corner of the bounding box. > **y2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L16) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L16) The y-coordinate of the top-right corner of the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md index 228939536..a95f98c4f 100644 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -1,6 +1,6 @@ # Interface: ChatConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L168) +Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L168) Object configuring chat management. @@ -10,7 +10,7 @@ Object configuring chat management. > **contextWindowLength**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:170](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L170) +Defined in: [packages/react-native-executorch/src/types/llm.ts:170](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L170) The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. @@ -20,7 +20,7 @@ The number of messages from the current conversation that the model will use to > **initialMessageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:169](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L169) +Defined in: [packages/react-native-executorch/src/types/llm.ts:169](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L169) An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. @@ -30,6 +30,6 @@ An array of `Message` objects that represent the conversation history. This can > **systemPrompt**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:171](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L171) +Defined in: [packages/react-native-executorch/src/types/llm.ts:171](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L171) Often used to tell the model what is its purpose, for example - "Be a helpful translator". diff --git a/docs/docs/06-api-reference/interfaces/ClassificationProps.md b/docs/docs/06-api-reference/interfaces/ClassificationProps.md index 64dbb213c..b7ce214d5 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationProps.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationProps.md @@ -1,6 +1,6 @@ # Interface: ClassificationProps -Defined in: [packages/react-native-executorch/src/types/classification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L11) +Defined in: [packages/react-native-executorch/src/types/classification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L11) Props for the `useClassification` hook. @@ -10,7 +10,7 @@ Props for the `useClassification` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L12) +Defined in: [packages/react-native-executorch/src/types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L13) +Defined in: [packages/react-native-executorch/src/types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ClassificationType.md b/docs/docs/06-api-reference/interfaces/ClassificationType.md index 5b893ac33..043bbfe70 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationType.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationType.md @@ -1,6 +1,6 @@ # Interface: ClassificationType -Defined in: [packages/react-native-executorch/src/types/classification.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L20) +Defined in: [packages/react-native-executorch/src/types/classification.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L20) Return type for the `useClassification` hook. Manages the state and operations for Computer Vision image classification. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image classification. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/classification.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L39) +Defined in: [packages/react-native-executorch/src/types/classification.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/classification.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L24) +Defined in: [packages/react-native-executorch/src/types/classification.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during classification. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: [packages/react-native-executorch/src/types/classification.ts:47](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L47) +Defined in: [packages/react-native-executorch/src/types/classification.ts:47](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L47) Executes the model's forward pass to classify the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L34) +Defined in: [packages/react-native-executorch/src/types/classification.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L34) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:29](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/classification.ts#L29) +Defined in: [packages/react-native-executorch/src/types/classification.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L29) Indicates whether the classification model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md index 192170d88..4b6941cff 100644 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -1,6 +1,6 @@ # Interface: DecodingOptions -Defined in: [packages/react-native-executorch/src/types/stt.ts:169](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L169) +Defined in: [packages/react-native-executorch/src/types/stt.ts:169](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L169) Options for decoding speech to text. @@ -10,6 +10,6 @@ Options for decoding speech to text. > `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:170](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L170) +Defined in: [packages/react-native-executorch/src/types/stt.ts:170](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L170) Optional language code to guide the transcription. diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md index 5dee19f9d..588195459 100644 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -1,6 +1,6 @@ # Interface: Detection -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L26) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L26) Represents a detected object within an image, including its bounding box, label, and confidence score. @@ -10,7 +10,7 @@ Represents a detected object within an image, including its bounding box, label, > **bbox**: [`Bbox`](Bbox.md) -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L27) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L27) The bounding box of the detected object, defined by its top-left (x1, y1) and bottom-right (x2, y2) coordinates. @@ -20,7 +20,7 @@ The bounding box of the detected object, defined by its top-left (x1, y1) and bo > **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L28) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L28) The class label of the detected object, represented as a key from the `CocoLabel` enum. @@ -30,6 +30,6 @@ The class label of the detected object, represented as a key from the `CocoLabel > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L29) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L29) The confidence score of the detection, typically ranging from 0 to 1. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md index c139caa0a..74cc44f3e 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleProps -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L10) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L10) Props for the `useExecutorchModule` hook. @@ -10,7 +10,7 @@ Props for the `useExecutorchModule` hook. > **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L11) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L11) The source of the ExecuTorch model binary. @@ -20,6 +20,6 @@ The source of the ExecuTorch model binary. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L12) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L12) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md index bffc00767..1d5705f1e 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleType -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L19) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L19) Return type for the `useExecutorchModule` hook. Manages the state and core execution methods for a general ExecuTorch model. @@ -11,7 +11,7 @@ Manages the state and core execution methods for a general ExecuTorch model. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L38) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L38) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L23) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L23) Contains the error object if the model failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`inputTensor`) => `Promise`\<[`TensorPtr`](TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L46) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L46) Executes the model's forward pass with the provided input tensors. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another request. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:33](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L33) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:33](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L33) Indicates whether the model is currently processing a forward pass. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing a forward pass. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/executorchModule.ts#L28) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L28) Indicates whether the ExecuTorch model binary has successfully loaded into memory and is ready for inference. diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md index 922238020..38156e9b8 100644 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -1,6 +1,6 @@ # Interface: GenerationConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:195](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L195) +Defined in: [packages/react-native-executorch/src/types/llm.ts:195](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L195) Object configuring generation settings. @@ -10,7 +10,7 @@ Object configuring generation settings. > `optional` **batchTimeInterval**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L199) +Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L199) Upper limit on the time interval between consecutive token batches. @@ -20,7 +20,7 @@ Upper limit on the time interval between consecutive token batches. > `optional` **outputTokenBatchSize**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L198) +Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L198) Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). @@ -30,7 +30,7 @@ Soft upper limit on the number of tokens in each token batch (in certain cases t > `optional` **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:196](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L196) +Defined in: [packages/react-native-executorch/src/types/llm.ts:196](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L196) Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. @@ -40,6 +40,6 @@ Scales output logits by the inverse of temperature. Controls the randomness / cr > `optional` **topp**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:197](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L197) +Defined in: [packages/react-native-executorch/src/types/llm.ts:197](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L197) Only samples from the smallest set of tokens whose cumulative probability exceeds topp. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md index 4de3735c1..c887ec046 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L11) Props for the `useImageEmbeddings` hook. @@ -10,7 +10,7 @@ Props for the `useImageEmbeddings` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md index 32944a4c4..f23a21997 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L20) Return type for the `useImageEmbeddings` hook. Manages the state and operations for generating image embeddings (feature vectors) used in Computer Vision tasks. @@ -11,7 +11,7 @@ Manages the state and operations for generating image embeddings (feature vector > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L39) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during embedding generation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:47](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L47) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:47](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L47) Executes the model's forward pass to generate embeddings (a feature vector) for the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L34) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L34) Indicates whether the model is currently generating embeddings for an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently generating embeddings for an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:29](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageEmbeddings.ts#L29) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L29) Indicates whether the image embeddings model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md index ecea4d4c2..2b928af07 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md @@ -1,6 +1,6 @@ # Interface: ImageSegmentationProps -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:37](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L37) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:37](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L37) Props for the `useImageSegmentation` hook. @@ -10,7 +10,7 @@ Props for the `useImageSegmentation` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:38](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L38) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:38](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L38) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L39) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L39) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md index 60e428415..4c8174a8b 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md @@ -1,6 +1,6 @@ # Interface: ImageSegmentationType -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L46) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L46) Return type for the `useImageSegmentation` hook. Manages the state and operations for Computer Vision image segmentation (e.g., DeepLab). @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image segmentation (e.g., D > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:65](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L65) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:65](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L65) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:50](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L50) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:50](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L50) Contains the error object if the model failed to load, download, or encountered a runtime error during segmentation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `classesOfInterest?`, `resize?`) => `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:75](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L75) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:75](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L75) Executes the model's forward pass to perform semantic segmentation on the provided image. @@ -71,7 +71,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L60) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L60) Indicates whether the model is currently processing an image. @@ -81,6 +81,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:55](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/imageSegmentation.ts#L55) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:55](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L55) Indicates whether the segmentation model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/KokoroConfig.md b/docs/docs/06-api-reference/interfaces/KokoroConfig.md index dde13e0d1..123672101 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroConfig.md +++ b/docs/docs/06-api-reference/interfaces/KokoroConfig.md @@ -1,6 +1,6 @@ # Interface: KokoroConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:43](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L43) +Defined in: [packages/react-native-executorch/src/types/tts.ts:43](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L43) Kokoro model configuration. Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. @@ -11,7 +11,7 @@ Only the core Kokoro model sources, as phonemizer sources are included in voice > **durationPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:45](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L45) +Defined in: [packages/react-native-executorch/src/types/tts.ts:45](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L45) source to Kokoro's duration predictor model binary @@ -21,7 +21,7 @@ source to Kokoro's duration predictor model binary > **synthesizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tts.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L46) source to Kokoro's synthesizer model binary @@ -31,6 +31,6 @@ source to Kokoro's synthesizer model binary > **type**: `"kokoro"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:44](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L44) +Defined in: [packages/react-native-executorch/src/types/tts.ts:44](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L44) model type identifier diff --git a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md index 6d0668984..d46c01e9f 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md +++ b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md @@ -1,6 +1,6 @@ # Interface: KokoroVoiceExtras -Defined in: [packages/react-native-executorch/src/types/tts.ts:30](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L30) +Defined in: [packages/react-native-executorch/src/types/tts.ts:30](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L30) Kokoro-specific voice extra props @@ -10,7 +10,7 @@ Kokoro-specific voice extra props > **lexiconSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:32](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L32) +Defined in: [packages/react-native-executorch/src/types/tts.ts:32](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L32) source to Kokoro's lexicon binary @@ -20,6 +20,6 @@ source to Kokoro's lexicon binary > **taggerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:31](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L31) +Defined in: [packages/react-native-executorch/src/types/tts.ts:31](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L31) source to Kokoro's tagger model binary diff --git a/docs/docs/06-api-reference/interfaces/LLMConfig.md b/docs/docs/06-api-reference/interfaces/LLMConfig.md index 961294ebf..f9ef292a6 100644 --- a/docs/docs/06-api-reference/interfaces/LLMConfig.md +++ b/docs/docs/06-api-reference/interfaces/LLMConfig.md @@ -1,6 +1,6 @@ # Interface: LLMConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L93) +Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L93) Configuration object for initializing and customizing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Configuration object for initializing and customizing a Large Language Model (LL > `optional` **chatConfig**: `Partial`\<[`ChatConfig`](ChatConfig.md)\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:103](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L103) +Defined in: [packages/react-native-executorch/src/types/llm.ts:103](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L103) Object configuring chat management, contains following properties: @@ -26,7 +26,7 @@ Object configuring chat management, contains following properties: > `optional` **generationConfig**: [`GenerationConfig`](GenerationConfig.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:127](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L127) +Defined in: [packages/react-native-executorch/src/types/llm.ts:127](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L127) Object configuring generation settings. @@ -44,7 +44,7 @@ Object configuring generation settings. > `optional` **toolsConfig**: [`ToolsConfig`](ToolsConfig.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L114) +Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L114) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md index b62a3a15c..7e9a36758 100644 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -1,6 +1,6 @@ # Interface: LLMType -Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L6) +Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L6) React hook for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ React hook for managing a Large Language Model (LLM) instance. > **configure**: (`configuration`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L48) +Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L48) Configures chat and tool calling. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -33,7 +33,7 @@ Configuration object containing `chatConfig`, `toolsConfig`, and `generationConf > **deleteMessage**: (`index`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:82](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L82) +Defined in: [packages/react-native-executorch/src/types/llm.ts:82](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L82) Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. @@ -55,7 +55,7 @@ The index of the message to delete from history. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L35) +Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L35) Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. @@ -65,7 +65,7 @@ Represents the download progress as a value between 0 and 1, indicating the exte > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L40) +Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L40) Contains the error message if the model failed to load. @@ -75,7 +75,7 @@ Contains the error message if the model failed to load. > **generate**: (`messages`, `tools?`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:67](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L67) +Defined in: [packages/react-native-executorch/src/types/llm.ts:67](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L67) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -103,7 +103,7 @@ Optional array of tools that can be used during generation. > **getGeneratedTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L59) +Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L59) Returns the number of tokens generated so far in the current generation. @@ -119,7 +119,7 @@ The count of generated tokens. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:87](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L87) +Defined in: [packages/react-native-executorch/src/types/llm.ts:87](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L87) Function to interrupt the current inference. @@ -133,7 +133,7 @@ Function to interrupt the current inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L30) +Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L30) Indicates whether the model is currently generating a response. @@ -143,7 +143,7 @@ Indicates whether the model is currently generating a response. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L25) +Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L25) Indicates whether the model is ready. @@ -153,7 +153,7 @@ Indicates whether the model is ready. > **messageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L10) +Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L10) History containing all messages in conversation. This field is updated after model responds to sendMessage. @@ -163,7 +163,7 @@ History containing all messages in conversation. This field is updated after mod > **response**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L15) +Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L15) State of the generated response. This field is updated with each token generated by the model. @@ -173,7 +173,7 @@ State of the generated response. This field is updated with each token generated > **sendMessage**: (`message`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:75](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L75) +Defined in: [packages/react-native-executorch/src/types/llm.ts:75](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L75) Function to add user message to conversation. After model responds, `messageHistory` will be updated with both user message and model response. @@ -196,6 +196,6 @@ The message string to send. > **token**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L20) +Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L20) The most recently generated token. diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md index 1ffb02558..4c58ef734 100644 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -1,6 +1,6 @@ # Interface: Message -Defined in: [packages/react-native-executorch/src/types/llm.ts:141](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L141) +Defined in: [packages/react-native-executorch/src/types/llm.ts:141](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L141) Represents a message in the conversation. @@ -10,7 +10,7 @@ Represents a message in the conversation. > **content**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L143) +Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L143) Content of the message. @@ -20,6 +20,6 @@ Content of the message. > **role**: [`MessageRole`](../type-aliases/MessageRole.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L142) +Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L142) Role of the message sender of type `MessageRole`. diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md index bb638915b..d014a402b 100644 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -1,6 +1,6 @@ # Interface: OCRDetection -Defined in: [packages/react-native-executorch/src/types/ocr.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L13) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L13) OCRDetection represents a single detected text instance in an image, including its bounding box, recognized text, and confidence score. @@ -11,7 +11,7 @@ including its bounding box, recognized text, and confidence score. > **bbox**: [`Point`](Point.md)[] -Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L14) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L14) An array of points defining the bounding box around the detected text. @@ -21,7 +21,7 @@ An array of points defining the bounding box around the detected text. > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L16) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L16) The confidence score of the OCR detection, ranging from 0 to 1. @@ -31,6 +31,6 @@ The confidence score of the OCR detection, ranging from 0 to 1. > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L15) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L15) The recognized text within the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/OCRProps.md b/docs/docs/06-api-reference/interfaces/OCRProps.md index fc40660a5..e63a3bd9c 100644 --- a/docs/docs/06-api-reference/interfaces/OCRProps.md +++ b/docs/docs/06-api-reference/interfaces/OCRProps.md @@ -1,6 +1,6 @@ # Interface: OCRProps -Defined in: [packages/react-native-executorch/src/types/ocr.ts:33](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L33) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:33](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L33) Configuration properties for the `useOCR` hook. @@ -14,7 +14,7 @@ Configuration properties for the `useOCR` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L37) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L37) Object containing the necessary model sources and configuration for the OCR pipeline. @@ -42,7 +42,7 @@ The language configuration enum for the OCR model (e.g., English, Polish, etc.). > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L58) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L58) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/OCRType.md b/docs/docs/06-api-reference/interfaces/OCRType.md index 7cd77240a..67825ff44 100644 --- a/docs/docs/06-api-reference/interfaces/OCRType.md +++ b/docs/docs/06-api-reference/interfaces/OCRType.md @@ -1,6 +1,6 @@ # Interface: OCRType -Defined in: [packages/react-native-executorch/src/types/ocr.ts:76](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L76) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:76](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L76) Return type for the `useOCR` hook. Manages the state and operations for Optical Character Recognition (OCR). @@ -11,7 +11,7 @@ Manages the state and operations for Optical Character Recognition (OCR). > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:95](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L95) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:95](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L95) Represents the total download progress of the model binaries as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the total download progress of the model binaries as a value between > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L80) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L80) Contains the error object if the models failed to load, download, or encountered a runtime error during recognition. @@ -31,7 +31,7 @@ Contains the error object if the models failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<[`OCRDetection`](OCRDetection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L103) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L103) Executes the OCR pipeline (detection and recognition) on the provided image. @@ -59,7 +59,7 @@ If the models are not loaded or are currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:90](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L90) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:90](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L90) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:85](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L85) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:85](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L85) Indicates whether both detector and recognizer models are loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md index 23f8a6b7a..ad3834e7a 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionProps -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:135](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L135) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:135](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L135) Props for the `useObjectDetection` hook. @@ -10,7 +10,7 @@ Props for the `useObjectDetection` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:136](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L136) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:136](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L136) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:137](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L137) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:137](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L137) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md index 7d027dc5d..ea3ac4963 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionType -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:144](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L144) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:144](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L144) Return type for the `useObjectDetection` hook. Manages the state and operations for Computer Vision object detection tasks. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision object detection tasks. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:163](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L163) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:163](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L163) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:148](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L148) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:148](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L148) Contains the error object if the model failed to load, download, or encountered a runtime error during detection. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `detectionThreshold?`) => `Promise`\<[`Detection`](Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:172](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L172) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:172](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L172) Executes the model's forward pass to detect objects within the provided image. @@ -65,7 +65,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:158](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L158) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:158](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L158) Indicates whether the model is currently processing an image. @@ -75,6 +75,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:153](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/objectDetection.ts#L153) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:153](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L153) Indicates whether the object detection model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/Point.md b/docs/docs/06-api-reference/interfaces/Point.md index c2dc4bee1..f7efe0528 100644 --- a/docs/docs/06-api-reference/interfaces/Point.md +++ b/docs/docs/06-api-reference/interfaces/Point.md @@ -1,6 +1,6 @@ # Interface: Point -Defined in: [packages/react-native-executorch/src/types/ocr.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L25) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L25) Point represents a coordinate in 2D space. @@ -10,7 +10,7 @@ Point represents a coordinate in 2D space. > **x**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L26) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L26) The x-coordinate of the point. @@ -20,6 +20,6 @@ The x-coordinate of the point. > **y**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L27) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L27) The y-coordinate of the point. diff --git a/docs/docs/06-api-reference/interfaces/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index 5b128f4c4..ec9762074 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,6 @@ # Interface: Segment -Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L22) +Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L22) Represents a detected audio segment with start and end timestamps. @@ -10,7 +10,7 @@ Represents a detected audio segment with start and end timestamps. > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L24) +Defined in: [packages/react-native-executorch/src/types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L24) End time of the segment in seconds. @@ -20,6 +20,6 @@ End time of the segment in seconds. > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:23](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L23) +Defined in: [packages/react-native-executorch/src/types/vad.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L23) Start time of the segment in seconds. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md index 1f2192224..dfe018bd2 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextModelConfig -Defined in: [packages/react-native-executorch/src/types/stt.ts:176](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L176) +Defined in: [packages/react-native-executorch/src/types/stt.ts:176](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L176) Configuration for Speech to Text model. @@ -10,7 +10,7 @@ Configuration for Speech to Text model. > **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:190](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L190) +Defined in: [packages/react-native-executorch/src/types/stt.ts:190](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L190) A string that specifies the location of a `.pte` file for the decoder. @@ -20,7 +20,7 @@ A string that specifies the location of a `.pte` file for the decoder. > **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:185](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L185) +Defined in: [packages/react-native-executorch/src/types/stt.ts:185](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L185) A string that specifies the location of a `.pte` file for the encoder. @@ -30,7 +30,7 @@ A string that specifies the location of a `.pte` file for the encoder. > **isMultilingual**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:180](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L180) +Defined in: [packages/react-native-executorch/src/types/stt.ts:180](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L180) A boolean flag indicating whether the model supports multiple languages. @@ -40,6 +40,6 @@ A boolean flag indicating whether the model supports multiple languages. > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:195](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L195) +Defined in: [packages/react-native-executorch/src/types/stt.ts:195](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L195) A string that specifies the location to the tokenizer for the model. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md index 21bf0efe7..0b3ba0716 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextType -Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L7) +Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L7) React hook for managing Speech to Text (STT) instance. @@ -10,7 +10,7 @@ React hook for managing Speech to Text (STT) instance. > **committedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L32) +Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L32) Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. @@ -21,7 +21,7 @@ Useful for displaying stable results during streaming. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L26) +Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L26) Tracks the progress of the model download process. @@ -31,7 +31,7 @@ Tracks the progress of the model download process. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L11) +Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L11) Contains the error message if the model failed to load. @@ -41,7 +41,7 @@ Contains the error message if the model failed to load. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L21) +Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L21) Indicates whether the model is currently processing an inference. @@ -51,7 +51,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L16) +Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L16) Indicates whether the model has successfully loaded and is ready for inference. @@ -61,7 +61,7 @@ Indicates whether the model has successfully loaded and is ready for inference. > **nonCommittedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L38) +Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L38) Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. @@ -72,7 +72,7 @@ Useful for displaying live, partial results during streaming. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L53) +Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L53) Runs the decoder of the model. Passing `number[]` is deprecated. @@ -102,7 +102,7 @@ A promise resolving to the decoded text. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L45) +Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L45) Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. @@ -126,7 +126,7 @@ A promise resolving to the encoded data. > **stream**(`options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L71) +Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L71) Starts a streaming transcription process. Use in combination with streamInsert to feed audio chunks and streamStop to end the stream. @@ -152,7 +152,7 @@ The final transcription string. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L78) +Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L78) Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Passing `number[]` is deprecated. @@ -175,7 +175,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L83) +Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L83) Stops the ongoing streaming transcription process. @@ -189,7 +189,7 @@ Stops the ongoing streaming transcription process. > **transcribe**(`waveform`, `options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L62) +Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L62) Starts a transcription process for a given input array, which should be a waveform at 16kHz. Passing `number[]` is deprecated. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md index 0a59d2e2a..4a7295c4d 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md @@ -1,6 +1,6 @@ # Interface: StyleTransferProps -Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:11 +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L11) Configuration properties for the `useStyleTransfer` hook. @@ -10,7 +10,7 @@ Configuration properties for the `useStyleTransfer` hook. > **model**: `object` -Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:12 +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L12) Object containing the `modelSource` for the style transfer model. @@ -24,6 +24,6 @@ Object containing the `modelSource` for the style transfer model. > `optional` **preventLoad**: `boolean` -Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:13 +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L13) 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 28a63f20c..a32817999 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferType.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferType.md @@ -1,6 +1,6 @@ # Interface: StyleTransferType -Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:20 +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L20) Return type for the `useStyleTransfer` hook. Manages the state and operations for applying artistic style transfer to images. @@ -11,7 +11,7 @@ Manages the state and operations for applying artistic style transfer to images. > **downloadProgress**: `number` -Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:39 +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:24 +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during style transfer. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`string`\> -Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:47 +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:47](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L47) Executes the model's forward pass to apply the specific artistic style to the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:34 +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L34) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: packages/react-native-executorch/src/types/styleTransfer.ts:29 +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L29) Indicates whether the style transfer model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md index 47b483595..281569948 100644 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -1,6 +1,6 @@ # Interface: TensorPtr -Defined in: [packages/react-native-executorch/src/types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L61) +Defined in: [packages/react-native-executorch/src/types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L61) Represents a pointer to a tensor, including its data buffer, size dimensions, and scalar type. @@ -10,7 +10,7 @@ Represents a pointer to a tensor, including its data buffer, size dimensions, an > **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:62](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L62) +Defined in: [packages/react-native-executorch/src/types/common.ts:62](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L62) The data buffer of the tensor. @@ -20,7 +20,7 @@ The data buffer of the tensor. > **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:64](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L64) +Defined in: [packages/react-native-executorch/src/types/common.ts:64](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L64) The scalar type of the tensor, as defined in the `ScalarType` enum. @@ -30,6 +30,6 @@ The scalar type of the tensor, as defined in the `ScalarType` enum. > **sizes**: `number`[] -Defined in: [packages/react-native-executorch/src/types/common.ts:63](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L63) +Defined in: [packages/react-native-executorch/src/types/common.ts:63](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L63) An array representing the size of each dimension of the tensor. diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md index 95894a9fa..e41193221 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:45](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L45) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:45](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L45) Props for the useTextEmbeddings hook. @@ -10,7 +10,7 @@ Props for the useTextEmbeddings hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L46) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L46) An object containing the model and tokenizer sources. @@ -28,6 +28,6 @@ An object containing the model and tokenizer sources. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L50) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L50) 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 e11871ef7..7d30d3bc7 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) React hook state and methods for managing a Text Embeddings model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Text Embeddings model instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) Tracks the progress of the model download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the model download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) Contains the error message if the model failed to load or during inference. @@ -30,7 +30,7 @@ Contains the error message if the model failed to load or during inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) Indicates whether the model is currently generating embeddings. @@ -40,7 +40,7 @@ Indicates whether the model is currently generating embeddings. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) Indicates whether the embeddings model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the embeddings model has successfully loaded and is ready for > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) Runs the text embeddings model on the provided input string. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageParams.md b/docs/docs/06-api-reference/interfaces/TextToImageParams.md index 248bbd728..d2b008406 100644 --- a/docs/docs/06-api-reference/interfaces/TextToImageParams.md +++ b/docs/docs/06-api-reference/interfaces/TextToImageParams.md @@ -1,6 +1,6 @@ # Interface: TextToImageParams -Defined in: packages/react-native-executorch/src/types/tti.ts:7 +Defined in: [packages/react-native-executorch/src/types/tti.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L7) Configuration properties for the `useTextToImage` hook. @@ -10,7 +10,7 @@ Configuration properties for the `useTextToImage` hook. > `optional` **inferenceCallback**: (`stepIdx`) => `void` -Defined in: packages/react-native-executorch/src/types/tti.ts:29 +Defined in: [packages/react-native-executorch/src/types/tti.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L29) Optional callback function that is triggered after each diffusion inference step. Useful for updating a progress bar during image generation. @@ -33,7 +33,7 @@ The index of the current inference step. > **model**: `object` -Defined in: packages/react-native-executorch/src/types/tti.ts:11 +Defined in: [packages/react-native-executorch/src/types/tti.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L11) Object containing the required model sources for the diffusion pipeline. @@ -73,7 +73,7 @@ Source for the UNet (noise predictor) model binary. > `optional` **preventLoad**: `boolean` -Defined in: packages/react-native-executorch/src/types/tti.ts:35 +Defined in: [packages/react-native-executorch/src/types/tti.ts:35](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L35) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageType.md b/docs/docs/06-api-reference/interfaces/TextToImageType.md index fa99b1815..5e9be3a93 100644 --- a/docs/docs/06-api-reference/interfaces/TextToImageType.md +++ b/docs/docs/06-api-reference/interfaces/TextToImageType.md @@ -1,6 +1,6 @@ # Interface: TextToImageType -Defined in: packages/react-native-executorch/src/types/tti.ts:42 +Defined in: [packages/react-native-executorch/src/types/tti.ts:42](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L42) Return type for the `useTextToImage` hook. Manages the state and operations for generating images from text prompts using a diffusion model pipeline. @@ -11,7 +11,7 @@ Manages the state and operations for generating images from text prompts using a > **downloadProgress**: `number` -Defined in: packages/react-native-executorch/src/types/tti.ts:61 +Defined in: [packages/react-native-executorch/src/types/tti.ts:61](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L61) Represents the total download progress of all the model binaries combined, as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the total download progress of all the model binaries combined, as a > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: packages/react-native-executorch/src/types/tti.ts:46 +Defined in: [packages/react-native-executorch/src/types/tti.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L46) Contains the error object if any of the pipeline models failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if any of the pipeline models failed to load, download > **generate**: (`input`, `imageSize?`, `numSteps?`, `seed?`) => `Promise`\<`string`\> -Defined in: packages/react-native-executorch/src/types/tti.ts:72 +Defined in: [packages/react-native-executorch/src/types/tti.ts:72](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L72) Runs the diffusion pipeline to generate an image from the provided text prompt. @@ -77,7 +77,7 @@ If the model is not loaded or is currently generating another image. > **interrupt**: () => `void` -Defined in: packages/react-native-executorch/src/types/tti.ts:82 +Defined in: [packages/react-native-executorch/src/types/tti.ts:82](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L82) Interrupts the currently active image generation process at the next available inference step. @@ -91,7 +91,7 @@ Interrupts the currently active image generation process at the next available i > **isGenerating**: `boolean` -Defined in: packages/react-native-executorch/src/types/tti.ts:56 +Defined in: [packages/react-native-executorch/src/types/tti.ts:56](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L56) Indicates whether the model is currently generating an image. @@ -101,6 +101,6 @@ Indicates whether the model is currently generating an image. > **isReady**: `boolean` -Defined in: packages/react-native-executorch/src/types/tti.ts:51 +Defined in: [packages/react-native-executorch/src/types/tti.ts:51](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L51) Indicates whether the entire diffusion pipeline is loaded into memory and ready for generation. diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md index ab3c5afb7..9a276e1c1 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:56](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L56) +Defined in: [packages/react-native-executorch/src/types/tts.ts:56](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L56) General Text to Speech module configuration @@ -14,7 +14,7 @@ General Text to Speech module configuration > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L57) +Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L57) a selected T2S model @@ -24,6 +24,6 @@ a selected T2S model > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L58) +Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L58) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md index 9a049b3ef..2787ed0f8 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L78) +Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L78) Text to Speech module input definition @@ -14,7 +14,7 @@ Text to Speech module input definition > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L80) +Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L80) optional speed argument - the higher it is, the faster the speech becomes @@ -24,6 +24,6 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L79) +Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L79) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md index c4f504f37..bae5356dc 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechProps -Defined in: [packages/react-native-executorch/src/types/tts.ts:68](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L68) +Defined in: [packages/react-native-executorch/src/types/tts.ts:68](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L68) Props for the useTextToSpeech hook. @@ -14,7 +14,7 @@ Props for the useTextToSpeech hook. > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L57) +Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L57) a selected T2S model @@ -28,7 +28,7 @@ a selected T2S model > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:69](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L69) +Defined in: [packages/react-native-executorch/src/types/tts.ts:69](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L69) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. @@ -38,7 +38,7 @@ Boolean that can prevent automatic model loading (and downloading the data if yo > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L58) +Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L58) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md index 9002d9128..2aeaf7674 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechStreamingInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:142](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L142) +Defined in: [packages/react-native-executorch/src/types/tts.ts:142](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L142) Text to Speech streaming input definition @@ -19,7 +19,7 @@ Callbacks can be both synchronous or asynchronous. > `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:143](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L143) +Defined in: [packages/react-native-executorch/src/types/tts.ts:143](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L143) Called when streaming begins @@ -33,7 +33,7 @@ Called when streaming begins > `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:145](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L145) +Defined in: [packages/react-native-executorch/src/types/tts.ts:145](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L145) Called when streaming ends @@ -47,7 +47,7 @@ Called when streaming ends > `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:144](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L144) +Defined in: [packages/react-native-executorch/src/types/tts.ts:144](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L144) Called after each audio chunk gets calculated. @@ -67,7 +67,7 @@ Called after each audio chunk gets calculated. > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L80) +Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L80) optional speed argument - the higher it is, the faster the speech becomes @@ -81,7 +81,7 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L79) +Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L79) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md index a70520b31..6d2f8351d 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechType -Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L87) +Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L87) Return type for the `useTextToSpeech` hook. Manages the state and operations for Text-to-Speech generation. @@ -11,7 +11,7 @@ Manages the state and operations for Text-to-Speech generation. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:106](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L106) +Defined in: [packages/react-native-executorch/src/types/tts.ts:106](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L106) Represents the download progress of the model and voice assets as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model and voice assets as a value betwee > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tts.ts:91](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L91) +Defined in: [packages/react-native-executorch/src/types/tts.ts:91](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L91) Contains the error object if the model failed to load or encountered an error during inference. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load or encountered an error du > **forward**: (`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L114) +Defined in: [packages/react-native-executorch/src/types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L114) Runs the model to convert the provided text into speech audio in a single pass. * @@ -60,7 +60,7 @@ If the model is not loaded or is currently generating. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:101](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L101) +Defined in: [packages/react-native-executorch/src/types/tts.ts:101](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L101) Indicates whether the model is currently generating audio. @@ -70,7 +70,7 @@ Indicates whether the model is currently generating audio. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:96](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L96) +Defined in: [packages/react-native-executorch/src/types/tts.ts:96](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L96) Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. @@ -80,7 +80,7 @@ Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. > **stream**: (`input`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:123](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L123) +Defined in: [packages/react-native-executorch/src/types/tts.ts:123](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L123) Streams the generated audio data incrementally. This is optimal for real-time playback, allowing audio to start playing before the full text is synthesized. @@ -110,7 +110,7 @@ If the model is not loaded or is currently generating. > **streamStop**: () => `void` -Defined in: [packages/react-native-executorch/src/types/tts.ts:128](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L128) +Defined in: [packages/react-native-executorch/src/types/tts.ts:128](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L128) Interrupts and stops the currently active audio generation stream. diff --git a/docs/docs/06-api-reference/interfaces/TokenizerType.md b/docs/docs/06-api-reference/interfaces/TokenizerType.md index 3839846ed..c91c28c58 100644 --- a/docs/docs/06-api-reference/interfaces/TokenizerType.md +++ b/docs/docs/06-api-reference/interfaces/TokenizerType.md @@ -1,6 +1,6 @@ # Interface: TokenizerType -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L6) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L6) React hook state and methods for managing a Tokenizer instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Tokenizer instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L25) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L25) Tracks the progress of the tokenizer download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the tokenizer download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L10) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L10) Contains the error message if the tokenizer failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the tokenizer failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L20) Indicates whether the tokenizer is currently processing data. @@ -40,7 +40,7 @@ Indicates whether the tokenizer is currently processing data. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L15) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L15) Indicates whether the tokenizer has successfully loaded and is ready for use. @@ -50,7 +50,7 @@ Indicates whether the tokenizer has successfully loaded and is ready for use. > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:33](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L33) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:33](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L33) Converts an array of token IDs into a string. @@ -80,7 +80,7 @@ A promise resolving to the decoded text string. > **encode**(`text`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L40) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L40) Converts a string into an array of token IDs. @@ -104,7 +104,7 @@ A promise resolving to an array `number[]` containing the encoded token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L46) Returns the size of the tokenizer's vocabulary. @@ -120,7 +120,7 @@ A promise resolving to the vocabulary size. > **idToToken**(`id`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:53](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L53) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:53](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L53) Returns the token associated to the ID. @@ -144,7 +144,7 @@ A promise resolving to the token string representation. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tokenizer.ts#L60) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L60) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md index 2cdcb5963..22b083e9b 100644 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -1,6 +1,6 @@ # Interface: ToolCall -Defined in: [packages/react-native-executorch/src/types/llm.ts:152](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L152) +Defined in: [packages/react-native-executorch/src/types/llm.ts:152](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L152) Represents a tool call made by the model. @@ -10,7 +10,7 @@ Represents a tool call made by the model. > **arguments**: `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L154) +Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L154) The arguments passed to the tool. @@ -20,6 +20,6 @@ The arguments passed to the tool. > **toolName**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:153](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L153) +Defined in: [packages/react-native-executorch/src/types/llm.ts:153](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L153) The name of the tool being called. diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md index cee924c09..ec31c2026 100644 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -1,6 +1,6 @@ # Interface: ToolsConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:181](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L181) +Defined in: [packages/react-native-executorch/src/types/llm.ts:181](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L181) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. @@ -10,7 +10,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > `optional` **displayToolCalls**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L184) +Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L184) If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. @@ -20,7 +20,7 @@ If set to true, JSON tool calls will be displayed in chat. If false, only answer > **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L183) +Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L183) Function that accepts `ToolCall`, executes tool and returns the string to model. @@ -40,6 +40,6 @@ Function that accepts `ToolCall`, executes tool and returns the string to model. > **tools**: `Object`[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:182](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L182) +Defined in: [packages/react-native-executorch/src/types/llm.ts:182](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L182) List of objects defining tools. diff --git a/docs/docs/06-api-reference/interfaces/VADProps.md b/docs/docs/06-api-reference/interfaces/VADProps.md index 7c604be4c..8464fb23b 100644 --- a/docs/docs/06-api-reference/interfaces/VADProps.md +++ b/docs/docs/06-api-reference/interfaces/VADProps.md @@ -1,6 +1,6 @@ # Interface: VADProps -Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L11) +Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L11) Props for the useVAD hook. @@ -10,7 +10,7 @@ Props for the useVAD hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L12) +Defined in: [packages/react-native-executorch/src/types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L13) +Defined in: [packages/react-native-executorch/src/types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/VADType.md b/docs/docs/06-api-reference/interfaces/VADType.md index d3199af92..8c24e85a7 100644 --- a/docs/docs/06-api-reference/interfaces/VADType.md +++ b/docs/docs/06-api-reference/interfaces/VADType.md @@ -1,6 +1,6 @@ # Interface: VADType -Defined in: [packages/react-native-executorch/src/types/vad.ts:30](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L30) +Defined in: [packages/react-native-executorch/src/types/vad.ts:30](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L30) React hook state and methods for managing a Voice Activity Detection (VAD) model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Voice Activity Detection (VAD) model > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:49](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L49) +Defined in: [packages/react-native-executorch/src/types/vad.ts:49](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L49) Represents the download progress as a value between 0 and 1. @@ -20,7 +20,7 @@ Represents the download progress as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L34) +Defined in: [packages/react-native-executorch/src/types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L34) Contains the error message if the VAD model failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the VAD model failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:44](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L44) +Defined in: [packages/react-native-executorch/src/types/vad.ts:44](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L44) Indicates whether the model is currently processing an inference. @@ -40,7 +40,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:39](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L39) +Defined in: [packages/react-native-executorch/src/types/vad.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L39) Indicates whether the VAD model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the VAD model has successfully loaded and is ready for inferen > **forward**(`waveform`): `Promise`\<[`Segment`](Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/types/vad.ts:57](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/vad.ts#L57) +Defined in: [packages/react-native-executorch/src/types/vad.ts:57](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L57) Runs the Voice Activity Detection model on the provided audio waveform. diff --git a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md index 65f523e3b..1853f2bb2 100644 --- a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md +++ b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md @@ -1,6 +1,6 @@ # Interface: VerticalOCRProps -Defined in: [packages/react-native-executorch/src/types/ocr.ts:64](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L64) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:64](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L64) Configuration properties for the `useVerticalOCR` hook. @@ -14,7 +14,7 @@ Configuration properties for the `useVerticalOCR` hook. > `optional` **independentCharacters**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:69](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L69) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:69](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L69) Boolean indicating whether to treat each character independently during recognition. Defaults to `false`. @@ -25,7 +25,7 @@ Defaults to `false`. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L37) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L37) Object containing the necessary model sources and configuration for the OCR pipeline. @@ -57,7 +57,7 @@ The language configuration enum for the OCR model (e.g., English, Polish, etc.). > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L58) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L58) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/VoiceConfig.md b/docs/docs/06-api-reference/interfaces/VoiceConfig.md index 91c4af134..a09f1f9d2 100644 --- a/docs/docs/06-api-reference/interfaces/VoiceConfig.md +++ b/docs/docs/06-api-reference/interfaces/VoiceConfig.md @@ -1,6 +1,6 @@ # Interface: VoiceConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L18) +Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L18) Voice configuration @@ -12,7 +12,7 @@ So far in Kokoro, each voice is directly associated with a language. > `optional` **extra**: [`KokoroVoiceExtras`](KokoroVoiceExtras.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L21) +Defined in: [packages/react-native-executorch/src/types/tts.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L21) an optional extra sources or properties related to specific voice @@ -22,7 +22,7 @@ an optional extra sources or properties related to specific voice > **lang**: [`TextToSpeechLanguage`](../type-aliases/TextToSpeechLanguage.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L19) +Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L19) speaker's language @@ -32,6 +32,6 @@ speaker's language > **voiceSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L20) a source to a binary file with voice embedding diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md index 3b7a6f4aa..01984d53f 100644 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -2,4 +2,4 @@ > **LLMTool** = `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:159](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L159) +Defined in: [packages/react-native-executorch/src/types/llm.ts:159](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L159) diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md index 0ca6b8487..88a6c4845 100644 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -2,6 +2,6 @@ > **MessageRole** = `"user"` \| `"assistant"` \| `"system"` -Defined in: [packages/react-native-executorch/src/types/llm.ts:133](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L133) +Defined in: [packages/react-native-executorch/src/types/llm.ts:133](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L133) Roles that a message sender can have. diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md index 57be01894..b87665a9a 100644 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -2,6 +2,6 @@ > **OCRLanguage** = keyof *typeof* `symbols` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:109](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/ocr.ts#L109) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:109](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L109) Enumeration of supported OCR languages based on available symbol sets. diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md index 140c96b19..0714e4990 100644 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -2,6 +2,6 @@ > **ResourceSource** = `string` \| `number` \| `object` -Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L8) +Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L8) Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md index 129ba28ec..01b1b2faf 100644 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -2,4 +2,4 @@ > **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/stt.ts#L87) +Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L87) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md index a2ea26485..cf8d753c5 100644 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -2,6 +2,6 @@ > **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` -Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/common.ts#L41) +Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L41) Represents the data buffer of a tensor, which can be one of several typed array formats. diff --git a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md index 49ccaf7b1..edb2a3313 100644 --- a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md @@ -2,4 +2,4 @@ > **TextToSpeechLanguage** = `"en-us"` \| `"en-gb"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:5](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/tts.ts#L5) +Defined in: [packages/react-native-executorch/src/types/tts.ts:5](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L5) 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 99d79d9a7..0debd519f 100644 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MINILM\_L6\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L408) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L408) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md index acd708062..713273235 100644 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MPNET\_BASE\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L413) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L413) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md index 37f791526..b96b5758d 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_256**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L442) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L442) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index 761558eab..00719920c 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_512**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L434) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L434) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index a0e8469d8..896365d8d 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_IMAGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md index 12df10961..b312b5d19 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_TEXT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L428) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L428) ## 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 b0bf841c4..4340ebe0a 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: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L385) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L385) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md index 9c1bbe533..2625b923d 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_CHAT\_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md index 52e5251b8..f261d6127 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_CONTEXT\_WINDOW\_LENGTH**: `5` = `5` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md index c3580f6b8..53737f1e5 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_MESSAGE\_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md index 6764af3c2..787e3c8da 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_SYSTEM\_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) 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 83dfc6d6f..d8c0bceda 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -2,7 +2,7 @@ > `const` **EFFICIENTNET\_V2\_S**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L260) ## 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 944d2c57b..52545bd7b 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -2,7 +2,7 @@ > `const` **FSMN\_VAD**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L453) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L453) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md index fed09996f..c3b43a5ae 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L108) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L108) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md index 2ef5a26ee..6bdb2b9d2 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L114) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L114) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md index c04ecc8a7..49c462160 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L120) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L120) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md index 96f1d8a6b..6636e75ad 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L126) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L126) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md index 6f2daea19..409366b9d 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L132) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L132) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md index c98b1a373..26e4b977a 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L138) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L138) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md index 4c8e42e49..cc409292f 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_MEDIUM**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/models.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/models.ts#L22) A standard Kokoro instance which processes the text in batches of maximum 128 tokens. diff --git a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md index 57a84b3a2..4cac0e28b 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/models.ts#L13) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/models.ts#L13) A Kokoro model instance which processes the text in batches of maximum 64 tokens. Uses significant less memory than the medium model, but could produce diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md index 37535f7ca..a88ec622c 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_HEART**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L21) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md index 38bd36ef4..04011a5d6 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_RIVER**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L26) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L26) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md index 0489efc0e..d092c0a81 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_SARAH**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L31) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L31) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md index 6b32569f7..3aa069ef5 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_ADAM**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L36) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L36) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md index 2d44119a3..30592e17a 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_MICHAEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L41) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md index c381fbc15..ee775b3c6 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_SANTA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L46) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md index af2b64516..bc8cb5e30 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BF\_EMMA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L51) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L51) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md index a588bcf66..66f0aa6d0 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BM\_DANIEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/tts/voices.ts#L56) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L56) 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 a2c470e73..30c3fc78b 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L34) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L34) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md index 8ae022f82..77db91eae 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L40) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L40) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md index 14a005eda..48ecfd704 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L46) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md index 82553bb71..6bc5d5b77 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L16) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L16) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md index 73be4a7b6..563b382df 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L22) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md index f7a1b72dd..b376a2d0b 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L28) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L28) ## 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 6384dcfa3..3d3cfcbfc 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MINILM\_L6\_COS\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L418) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L418) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md index 2300c06b7..ef809b82e 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MPNET\_BASE\_DOT\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md index f40b238fa..082d573e2 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L41) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md index 330fbdd03..e70d933fa 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L47) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L47) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md index 05ff1b545..f9fa0f8f8 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L53) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L53) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md index de356982f..3ba1f2921 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L362) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L362) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md index 0cbe13fbf..3f71bd4cf 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L59) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L59) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md index f1b29fbe3..88fe44ce6 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L65) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L65) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md index b6a370c92..4e59d6f1c 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L71) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L71) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md index 462c7961d..79a0fae96 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L83) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L83) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md index 7943130a2..5a2b9596b 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L77) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L77) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md index 30665e091..8c05f59a2 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L98) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L98) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md index a8f3bffe5..218017501 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L164) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L164) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md index ad8092468..2a96820d7 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L104) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L104) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md index 2d7f90919..27f3157bf 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L116) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L116) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md index fb5c439cc..6727e6caa 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L122) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L122) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md index f11a69728..f0efe95a8 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L284) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md index 52eca02ed..56861e6c4 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L134) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L134) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md index 3a57c9739..8b96d1a9e 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L146) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L146) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md index f05eafea3..a6f645f4d 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L152) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L152) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md index 0a84f6271..51070f2c8 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L128) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L128) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md index b3a95d6fc..b365db1ff 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L170) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L170) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md index 6e9a1cbd4..134ff7ab5 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L188) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L188) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md index 9409ed197..81f150d2a 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L176) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L176) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md index d9d9938aa..f5ed121e2 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L182) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L182) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md index ca8bcb031..526ccb92d 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L158) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L158) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md index 7c870bd5b..40a9ce80d 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L194) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L194) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md index 877099d96..2c5b2f73b 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md index 597996235..c75c259d2 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md index 0be5f8ae9..ae53df63f 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md index 79b9ff919..e91e8e78e 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md index e0038adb9..d2344b7ba 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md index 9a47cdd69..3b2f98259 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L236) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L236) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md index 15a4001bc..06e5147d6 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md index 0063de0f8..367070c0d 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L254) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L254) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md index fe8e3ea88..a47824077 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md index 15ae0459e..60731589f 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md index 3230c0cf4..dfc0fb23d 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L272) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L272) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md index 77b843e4e..1f50686e2 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L278) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L278) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md index 7dd27ea12..89cbc8c7f 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L260) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md index d48f82d4e..355ccc987 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L266) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L266) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md index d2e4abcb8..513367a75 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L290) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L290) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md index 2420c1a71..3b8b9074e 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L296) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L296) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md index 5c16acd41..e6ebbe6f3 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L302) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md index c59e8bc81..713b968ff 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L308) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L308) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md index 79b0e3352..50335d017 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L314) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L314) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md index 5d0e69d7a..1370df61d 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L320) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L320) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md index 411d96cb9..3502ecaf8 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L326) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L326) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md index b0b4643ab..d71002412 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L332) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L332) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md index 6f78a0c2e..83917b81c 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L341) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L341) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md index 9aa4e16c7..89afdcf9d 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L89) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L89) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md index f279b61dc..77b128985 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L350) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L350) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md index 019d6f558..f1f3a6800 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L356) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L356) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md index 13a2c20dc..25ae2e260 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L140) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L140) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md index 95b6bc2da..f594f2533 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L374) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L374) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md index 0e715347e..b92e5963b 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md index 8a0283a5b..f4ad71166 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L380) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L380) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md index 992578c51..8d5dc301a 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L398) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L398) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md index 94feae3ad..6037db84f 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md index 4f64fda2a..6edac617b 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L386) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L386) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md index 911d4e203..f54a0d674 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L404) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L404) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md index c2c0e68b0..25b457a52 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L410) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L410) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md index 312150c1e..73a3f827b 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L416) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L416) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md index 430ab12d7..ea5dcde82 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L422) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L422) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md index 3413e545d..6b7c63a1c 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L110) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L110) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md index fd1839504..14fdcd34a 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md index 6fe465db0..744d6c429 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md index ed01684d4..ca1370696 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md index 08a85b75a..f0d97bfb8 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md index be8636aaa..b3f71c193 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md index fb1350dfb..5f6111226 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md index 035ebdf64..22fb424ff 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md index c9755ff13..4195fc356 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md index 22757c8c7..f688f045d 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L62) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L62) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md index 7829532b4..39fd64a7d 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L68) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L68) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md index 390138241..3ae971c7c 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L74) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L74) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md index f7818e232..10730b6d6 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L80) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L80) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index 95dd30a44..de16d8979 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L86) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L86) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md index 077a505b6..35dd40f6e 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L92) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L92) ## 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 071d6fb30..a94d29180 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L154) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L154) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md index c113cf486..226dc4680 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L160) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L160) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md index 9fcce2d45..b707d5db3 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L178) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L178) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md index 4cebcd5ee..9ebdf8a5f 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L184) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L184) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md index 9b602cdb2..295ffdd89 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L166) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L166) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md index f61987edd..9c2690b0e 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L172) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L172) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md index 986195adb..dcb31687d 100644 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -2,7 +2,7 @@ > `const` **SPECIAL\_TOKENS**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:202](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/types/llm.ts#L202) +Defined in: [packages/react-native-executorch/src/types/llm.ts:202](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L202) ## Type Declaration 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 27ad3e496..936c9dba5 100644 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `const` **SSDLITE\_320\_MOBILENET\_V3\_LARGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L267) ## 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 618f48830..1668c7cbb 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_CANDY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L289) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L289) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md index 7d97cb4c7..58445ab8e 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_MOSAIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L293) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L293) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md index ba92ef027..b97908551 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_RAIN\_PRINCESS**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md index 5d56a87b7..691e3e40e 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_UDNIE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L301) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L301) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md index 5f3aa2e2c..a53dcb944 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L42) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L42) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md index c449786d8..cac8d0722 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L48) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L48) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md index 684562714..46d667a4e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L54) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L54) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md index 666d75762..c61458fa5 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L363) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L363) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md index 5be79bc98..588dd50fc 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L60) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L60) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md index 6f299d296..17f461bc3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L66) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L66) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md index 995b21df9..ec0a7f06e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L72) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L72) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md index bfcb6ce81..c77e43769 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L84) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L84) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md index cddd219e7..7272d35bb 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L78) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L78) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md index d3139dd3d..7f818e55d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L99) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L99) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md index a99629e0f..64cd953d9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L165) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L165) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md index 6219b5418..33bccb2f9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L105) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L105) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md index 97b65e8f2..d39b51aed 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L117) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L117) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md index 35c36274f..5f473963b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L123) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L123) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md index 6c7825716..639bd73c7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L285) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L285) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md index 19640e79a..b44a9b13d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L135) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L135) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md index 4b3fbb441..cabaa4e35 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L147) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L147) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md index 52dd9cb57..33f940668 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L153) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L153) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md index ac876020a..c5670ebbc 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L129) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L129) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md index c8e154511..21f34f561 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L171) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L171) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md index 8a95e4e73..9681cf6e7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L189) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L189) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md index 5a2f7f56a..1f76e9bc6 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L177) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L177) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md index 694ebd448..d2c7c049a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L183) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L183) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md index d20218413..33ab3cf3d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L159) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L159) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md index 137ed751b..0888df169 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L195) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L195) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md index 34b4bfd91..d0a0a8f3b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L201) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L201) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md index 18c78622b..2371a0ad7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L213) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L213) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md index 6480eb3dc..be55f1ccc 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L207) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L207) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md index 72f887390..7d73c4f9d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L219) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L219) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md index a883ce960..fbbf34a3e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L225) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L225) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md index 3b76770c0..1e3004a70 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L237) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L237) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md index fc5b3a56a..f142bb111 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L231) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L231) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md index 944f05964..69bbf0b7b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L255) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L255) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md index 957ec6921..090a322e2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L243) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L243) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md index a3576573f..f42c7df30 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L249) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L249) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md index 74c9e8994..c0e2c2b31 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L273) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L273) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md index b9027b128..c066b6af6 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L279) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L279) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md index 3619244a7..d55c3ab62 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L261) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L261) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md index 431106d86..b85f8b7e7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L267) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md index 2fa3a7624..d141ac7cd 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L291) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L291) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md index f396343a3..96f223fe1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md index 5fabeac71..f93fb7088 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L303) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L303) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md index fed3d3a7b..dc5757f77 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L309) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L309) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md index 0f8c052e0..42e689d9e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L315) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L315) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md index 6fc357ad4..086e6b851 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L321) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L321) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md index 6176edf39..9272d90a3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L327) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L327) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md index 569add400..da34c72bd 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L336) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L336) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md index e8dacbc7f..19344c71d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L345) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L345) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md index 156f48cc2..a982e0a74 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L93) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L93) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md index e2a066a2b..a1fad863d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L351) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L351) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md index d39c60239..865d11730 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L357) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L357) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md index 6f61333dd..0b45d3f79 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L141) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L141) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md index 98c6b89d8..a04e56cba 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md index 8b7053b83..2847ba10e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L369) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L369) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md index d6ed5955a..776f62b2d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L381) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L381) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md index 8d08c4517..36d26c644 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L399) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L399) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md index a8253a729..b7c0e555f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L393) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L393) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md index 91b99b309..e4d5ebc8d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L387) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L387) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md index ba450ada9..777b38e1d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L405) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L405) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md index f49a85182..eed3d700b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L411) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L411) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md index e465f4a14..6ebac234e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L417) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L417) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md index 690ad457c..5de114587 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md index abdea7f87..88618b141 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/ocr/models.ts#L111) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L111) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md index 17310b687..46b5874d0 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md index a98a0f0a0..d41357628 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L347) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L347) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md index cd6ce3cc7..630890b83 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md index 2753d44c7..1e32fd83f 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L354) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L354) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md index ce8832772..8716c159d 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L361) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L361) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md index 91ffc66f2..dd3bc373a 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L333) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L333) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md index c4710df21..cb1df265b 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/constants/modelUrls.ts#L340) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L340) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md index 4b5652710..fb935f276 100644 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -2,7 +2,7 @@ > `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] -Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/520acc3881283b9238af4c444f8831911dadd9ed/packages/react-native-executorch/src/utils/llm.ts#L9) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/llm.ts#L9) ## Parameters From 378038b2ca252093c86e64cbbe998c6201d1ff7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Tue, 27 Jan 2026 12:04:34 +0100 Subject: [PATCH 12/15] Add changed *.ts files --- .../computer_vision/ClassificationModule.ts | 18 +++++++++++++++++- .../natural_language_processing/LLMModule.ts | 2 +- .../TextToSpeechModule.ts | 4 ++-- .../TokenizerModule.ts | 4 ++-- 4 files changed, 22 insertions(+), 6 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 deaabbdcd..d70c9c1c1 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts @@ -4,7 +4,17 @@ import { BaseModule } from '../BaseModule'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; +/** + * Module for image classification tasks. + */ export class ClassificationModule extends BaseModule { + /** + * 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`. + * + * @param model - Object containing `modelSource`. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( model: { modelSource: ResourceSource }, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -22,7 +32,13 @@ export class ClassificationModule extends BaseModule { this.nativeModule = global.loadClassification(paths[0] || ''); } - async forward(imageSource: string) { + /** + * Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. + * + * @param imageSource - The image source to be classified. + * @returns The classification result. + */ + async forward(imageSource: string): Promise<{ [category: string]: number }> { if (this.nativeModule == null) throw new RnExecutorchError( RnExecutorchErrorCode.ModuleNotLoaded, diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts index 0cf8bb400..4786a1eb3 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts @@ -157,7 +157,7 @@ export class LLMModule { * * @returns The count of generated tokens. */ - getGeneratedTokenCount() { + getGeneratedTokenCount(): number { return this.controller.getGeneratedTokenCount(); } diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts index 9df06e966..3caf9376c 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts @@ -94,7 +94,7 @@ export class TextToSpeechModule { * @param speed Optional speed multiplier for the speech synthesis (default is 1.0). * @returns A promise resolving to the synthesized audio waveform. */ - public async forward(text: string, speed: number = 1.0) { + public async forward(text: string, speed: number = 1.0): Promise { if (this.nativeModule == null) throw new RnExecutorchError( RnExecutorchErrorCode.ModuleNotLoaded, @@ -109,7 +109,7 @@ export class TextToSpeechModule { * @param input - Input object containing text and optional speed. * @returns An async generator yielding Float32Array audio chunks. */ - public async *stream({ text, speed }: TextToSpeechStreamingInput) { + public async *stream({ text, speed }: TextToSpeechStreamingInput): AsyncGenerator { // Stores computed audio segments const queue: Float32Array[] = []; diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts index a2a6ca822..5772ee121 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts @@ -40,7 +40,7 @@ export class TokenizerModule { * @param input - The input string to be tokenized. * @returns An array of token IDs. */ - async encode(input: string) { + async encode(input: string): Promise { return await this.nativeModule.encode(input); } @@ -51,7 +51,7 @@ export class TokenizerModule { * @param skipSpecialTokens - Whether to skip special tokens during decoding (default: true). * @returns The decoded string. */ - async decode(tokens: number[], skipSpecialTokens: boolean = true) { + async decode(tokens: number[], skipSpecialTokens: boolean = true): Promise { if (tokens.length === 0) { return ''; } From a8b0a412aa07c92692caf0b31a2b58a5f754121c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Tue, 27 Jan 2026 14:23:36 +0100 Subject: [PATCH 13/15] Add another batch of module --- .../classes/ClassificationModule.md | 18 +- .../classes/ExecutorchModule.md | 14 +- .../classes/ImageEmbeddingsModule.md | 28 ++- .../classes/ImageSegmentationModule.md | 37 +++- .../06-api-reference/classes/LLMModule.md | 24 +-- .../06-api-reference/classes/OCRModule.md | 27 ++- .../classes/ObjectDetectionModule.md | 32 ++- .../classes/ResourceFetcher.md | 20 +- .../classes/RnExecutorchError.md | 8 +- .../classes/SpeechToTextModule.md | 18 +- .../classes/StyleTransferModule.md | 14 +- .../classes/TextEmbeddingsModule.md | 14 +- .../classes/TextToImageModule.md | 18 +- .../classes/TextToSpeechModule.md | 22 +-- .../classes/TokenizerModule.md | 24 +-- .../06-api-reference/classes/VADModule.md | 14 +- .../classes/VerticalOCRModule.md | 10 +- .../enumerations/CocoLabel.md | 182 +++++++++--------- .../enumerations/DeeplabLabel.md | 46 ++--- .../enumerations/RnExecutorchErrorCode.md | 86 ++++----- .../enumerations/ScalarType.md | 46 ++--- .../DEFAULT_STRUCTURED_OUTPUT_PROMPT.md | 2 +- .../fixAndValidateStructuredOutput.md | 2 +- .../functions/getStructuredOutputPrompt.md | 2 +- .../functions/useClassification.md | 2 +- .../functions/useExecutorchModule.md | 2 +- .../functions/useImageEmbeddings.md | 2 +- .../functions/useImageSegmentation.md | 2 +- .../docs/06-api-reference/functions/useLLM.md | 2 +- .../docs/06-api-reference/functions/useOCR.md | 2 +- .../functions/useObjectDetection.md | 2 +- .../functions/useSpeechToText.md | 2 +- .../functions/useStyleTransfer.md | 2 +- .../functions/useTextEmbeddings.md | 2 +- .../functions/useTextToImage.md | 2 +- .../functions/useTextToSpeech.md | 2 +- .../functions/useTokenizer.md | 2 +- .../docs/06-api-reference/functions/useVAD.md | 2 +- .../functions/useVerticalOCR.md | 2 +- docs/docs/06-api-reference/interfaces/Bbox.md | 10 +- .../06-api-reference/interfaces/ChatConfig.md | 8 +- .../interfaces/ClassificationProps.md | 6 +- .../interfaces/ClassificationType.md | 12 +- .../interfaces/DecodingOptions.md | 4 +- .../06-api-reference/interfaces/Detection.md | 8 +- .../interfaces/ExecutorchModuleProps.md | 6 +- .../interfaces/ExecutorchModuleType.md | 12 +- .../interfaces/GenerationConfig.md | 10 +- .../interfaces/ImageEmbeddingsProps.md | 6 +- .../interfaces/ImageEmbeddingsType.md | 12 +- .../interfaces/ImageSegmentationProps.md | 6 +- .../interfaces/ImageSegmentationType.md | 12 +- .../interfaces/KokoroConfig.md | 8 +- .../interfaces/KokoroVoiceExtras.md | 6 +- .../06-api-reference/interfaces/LLMConfig.md | 8 +- .../06-api-reference/interfaces/LLMType.md | 28 +-- .../06-api-reference/interfaces/Message.md | 6 +- .../interfaces/OCRDetection.md | 8 +- .../06-api-reference/interfaces/OCRProps.md | 6 +- .../06-api-reference/interfaces/OCRType.md | 12 +- .../interfaces/ObjectDetectionProps.md | 6 +- .../interfaces/ObjectDetectionType.md | 12 +- .../docs/06-api-reference/interfaces/Point.md | 6 +- .../06-api-reference/interfaces/Segment.md | 6 +- .../interfaces/SpeechToTextModelConfig.md | 10 +- .../interfaces/SpeechToTextType.md | 26 +-- .../interfaces/StyleTransferProps.md | 6 +- .../interfaces/StyleTransferType.md | 12 +- .../06-api-reference/interfaces/TensorPtr.md | 8 +- .../interfaces/TextEmbeddingsProps.md | 6 +- .../interfaces/TextEmbeddingsType.md | 12 +- .../interfaces/TextToImageParams.md | 8 +- .../interfaces/TextToImageType.md | 14 +- .../interfaces/TextToSpeechConfig.md | 6 +- .../interfaces/TextToSpeechInput.md | 6 +- .../interfaces/TextToSpeechProps.md | 8 +- .../interfaces/TextToSpeechStreamingInput.md | 12 +- .../interfaces/TextToSpeechType.md | 16 +- .../interfaces/TokenizerType.md | 20 +- .../06-api-reference/interfaces/ToolCall.md | 6 +- .../interfaces/ToolsConfig.md | 8 +- .../06-api-reference/interfaces/VADProps.md | 6 +- .../06-api-reference/interfaces/VADType.md | 12 +- .../interfaces/VerticalOCRProps.md | 8 +- .../interfaces/VoiceConfig.md | 8 +- .../06-api-reference/type-aliases/LLMTool.md | 2 +- .../type-aliases/MessageRole.md | 2 +- .../type-aliases/OCRLanguage.md | 2 +- .../type-aliases/ResourceSource.md | 2 +- .../type-aliases/SpeechToTextLanguage.md | 2 +- .../type-aliases/TensorBuffer.md | 2 +- .../type-aliases/TextToSpeechLanguage.md | 2 +- .../variables/ALL_MINILM_L6_V2.md | 2 +- .../variables/ALL_MPNET_BASE_V2.md | 2 +- .../variables/BK_SDM_TINY_VPRED_256.md | 2 +- .../variables/BK_SDM_TINY_VPRED_512.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 2 +- .../variables/DEEPLAB_V3_RESNET50.md | 2 +- .../variables/DEFAULT_CHAT_CONFIG.md | 2 +- .../DEFAULT_CONTEXT_WINDOW_LENGTH.md | 2 +- .../variables/DEFAULT_MESSAGE_HISTORY.md | 2 +- .../variables/DEFAULT_SYSTEM_PROMPT.md | 2 +- .../variables/EFFICIENTNET_V2_S.md | 2 +- .../06-api-reference/variables/FSMN_VAD.md | 2 +- .../variables/HAMMER2_1_0_5B.md | 2 +- .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_1_5B.md | 2 +- .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_3B.md | 2 +- .../variables/HAMMER2_1_3B_QUANTIZED.md | 2 +- .../variables/KOKORO_MEDIUM.md | 2 +- .../variables/KOKORO_SMALL.md | 2 +- .../variables/KOKORO_VOICE_AF_HEART.md | 2 +- .../variables/KOKORO_VOICE_AF_RIVER.md | 2 +- .../variables/KOKORO_VOICE_AF_SARAH.md | 2 +- .../variables/KOKORO_VOICE_AM_ADAM.md | 2 +- .../variables/KOKORO_VOICE_AM_MICHAEL.md | 2 +- .../variables/KOKORO_VOICE_AM_SANTA.md | 2 +- .../variables/KOKORO_VOICE_BF_EMMA.md | 2 +- .../variables/KOKORO_VOICE_BM_DANIEL.md | 2 +- .../06-api-reference/variables/LLAMA3_2_1B.md | 2 +- .../variables/LLAMA3_2_1B_QLORA.md | 2 +- .../variables/LLAMA3_2_1B_SPINQUANT.md | 2 +- .../06-api-reference/variables/LLAMA3_2_3B.md | 2 +- .../variables/LLAMA3_2_3B_QLORA.md | 2 +- .../variables/LLAMA3_2_3B_SPINQUANT.md | 2 +- .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 2 +- .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 2 +- .../06-api-reference/variables/OCR_ABAZA.md | 2 +- .../06-api-reference/variables/OCR_ADYGHE.md | 2 +- .../variables/OCR_AFRIKAANS.md | 2 +- .../variables/OCR_ALBANIAN.md | 2 +- .../06-api-reference/variables/OCR_AVAR.md | 2 +- .../variables/OCR_AZERBAIJANI.md | 2 +- .../variables/OCR_BELARUSIAN.md | 2 +- .../06-api-reference/variables/OCR_BOSNIAN.md | 2 +- .../variables/OCR_BULGARIAN.md | 2 +- .../06-api-reference/variables/OCR_CHECHEN.md | 2 +- .../variables/OCR_CROATIAN.md | 2 +- .../06-api-reference/variables/OCR_CZECH.md | 2 +- .../06-api-reference/variables/OCR_DANISH.md | 2 +- .../06-api-reference/variables/OCR_DARGWA.md | 2 +- .../06-api-reference/variables/OCR_DUTCH.md | 2 +- .../06-api-reference/variables/OCR_ENGLISH.md | 2 +- .../variables/OCR_ESTONIAN.md | 2 +- .../06-api-reference/variables/OCR_FRENCH.md | 2 +- .../06-api-reference/variables/OCR_GERMAN.md | 2 +- .../variables/OCR_HUNGARIAN.md | 2 +- .../variables/OCR_ICELANDIC.md | 2 +- .../variables/OCR_INDONESIAN.md | 2 +- .../06-api-reference/variables/OCR_INGUSH.md | 2 +- .../06-api-reference/variables/OCR_IRISH.md | 2 +- .../06-api-reference/variables/OCR_ITALIAN.md | 2 +- .../variables/OCR_JAPANESE.md | 2 +- .../06-api-reference/variables/OCR_KANNADA.md | 2 +- .../variables/OCR_KARBADIAN.md | 2 +- .../06-api-reference/variables/OCR_KOREAN.md | 2 +- .../06-api-reference/variables/OCR_KURDISH.md | 2 +- .../06-api-reference/variables/OCR_LAK.md | 2 +- .../06-api-reference/variables/OCR_LATIN.md | 2 +- .../06-api-reference/variables/OCR_LATVIAN.md | 2 +- .../variables/OCR_LEZGHIAN.md | 2 +- .../variables/OCR_LITHUANIAN.md | 2 +- .../06-api-reference/variables/OCR_MALAY.md | 2 +- .../06-api-reference/variables/OCR_MALTESE.md | 2 +- .../06-api-reference/variables/OCR_MAORI.md | 2 +- .../variables/OCR_MONGOLIAN.md | 2 +- .../variables/OCR_NORWEGIAN.md | 2 +- .../06-api-reference/variables/OCR_OCCITAN.md | 2 +- .../06-api-reference/variables/OCR_PALI.md | 2 +- .../06-api-reference/variables/OCR_POLISH.md | 2 +- .../variables/OCR_PORTUGUESE.md | 2 +- .../variables/OCR_ROMANIAN.md | 2 +- .../06-api-reference/variables/OCR_RUSSIAN.md | 2 +- .../variables/OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/OCR_SERBIAN_LATIN.md | 2 +- .../variables/OCR_SIMPLIFIED_CHINESE.md | 2 +- .../06-api-reference/variables/OCR_SLOVAK.md | 2 +- .../variables/OCR_SLOVENIAN.md | 2 +- .../06-api-reference/variables/OCR_SPANISH.md | 2 +- .../06-api-reference/variables/OCR_SWAHILI.md | 2 +- .../06-api-reference/variables/OCR_SWEDISH.md | 2 +- .../variables/OCR_TABASSARAN.md | 2 +- .../06-api-reference/variables/OCR_TAGALOG.md | 2 +- .../06-api-reference/variables/OCR_TAJIK.md | 2 +- .../06-api-reference/variables/OCR_TELUGU.md | 2 +- .../06-api-reference/variables/OCR_TURKISH.md | 2 +- .../variables/OCR_UKRAINIAN.md | 2 +- .../06-api-reference/variables/OCR_UZBEK.md | 2 +- .../variables/OCR_VIETNAMESE.md | 2 +- .../06-api-reference/variables/OCR_WELSH.md | 2 +- .../variables/PHI_4_MINI_4B.md | 2 +- .../variables/PHI_4_MINI_4B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_0_5B.md | 2 +- .../variables/QWEN2_5_0_5B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_1_5B.md | 2 +- .../variables/QWEN2_5_1_5B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN2_5_3B.md | 2 +- .../variables/QWEN2_5_3B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_0_6B.md | 2 +- .../variables/QWEN3_0_6B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_1_7B.md | 2 +- .../variables/QWEN3_1_7B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_4B.md | 2 +- .../variables/QWEN3_4B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_135M.md | 2 +- .../variables/SMOLLM2_1_135M_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_1_7B.md | 2 +- .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_360M.md | 2 +- .../variables/SMOLLM2_1_360M_QUANTIZED.md | 2 +- .../variables/SPECIAL_TOKENS.md | 2 +- .../SSDLITE_320_MOBILENET_V3_LARGE.md | 2 +- .../variables/STYLE_TRANSFER_CANDY.md | 2 +- .../variables/STYLE_TRANSFER_MOSAIC.md | 2 +- .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 2 +- .../variables/STYLE_TRANSFER_UDNIE.md | 2 +- .../variables/VERTICAL_OCR_ABAZA.md | 2 +- .../variables/VERTICAL_OCR_ADYGHE.md | 2 +- .../variables/VERTICAL_OCR_AFRIKAANS.md | 2 +- .../variables/VERTICAL_OCR_ALBANIAN.md | 2 +- .../variables/VERTICAL_OCR_AVAR.md | 2 +- .../variables/VERTICAL_OCR_AZERBAIJANI.md | 2 +- .../variables/VERTICAL_OCR_BELARUSIAN.md | 2 +- .../variables/VERTICAL_OCR_BOSNIAN.md | 2 +- .../variables/VERTICAL_OCR_BULGARIAN.md | 2 +- .../variables/VERTICAL_OCR_CHECHEN.md | 2 +- .../variables/VERTICAL_OCR_CROATIAN.md | 2 +- .../variables/VERTICAL_OCR_CZECH.md | 2 +- .../variables/VERTICAL_OCR_DANISH.md | 2 +- .../variables/VERTICAL_OCR_DARGWA.md | 2 +- .../variables/VERTICAL_OCR_DUTCH.md | 2 +- .../variables/VERTICAL_OCR_ENGLISH.md | 2 +- .../variables/VERTICAL_OCR_ESTONIAN.md | 2 +- .../variables/VERTICAL_OCR_FRENCH.md | 2 +- .../variables/VERTICAL_OCR_GERMAN.md | 2 +- .../variables/VERTICAL_OCR_HUNGARIAN.md | 2 +- .../variables/VERTICAL_OCR_ICELANDIC.md | 2 +- .../variables/VERTICAL_OCR_INDONESIAN.md | 2 +- .../variables/VERTICAL_OCR_INGUSH.md | 2 +- .../variables/VERTICAL_OCR_IRISH.md | 2 +- .../variables/VERTICAL_OCR_ITALIAN.md | 2 +- .../variables/VERTICAL_OCR_JAPANESE.md | 2 +- .../variables/VERTICAL_OCR_KANNADA.md | 2 +- .../variables/VERTICAL_OCR_KARBADIAN.md | 2 +- .../variables/VERTICAL_OCR_KOREAN.md | 2 +- .../variables/VERTICAL_OCR_KURDISH.md | 2 +- .../variables/VERTICAL_OCR_LAK.md | 2 +- .../variables/VERTICAL_OCR_LATIN.md | 2 +- .../variables/VERTICAL_OCR_LATVIAN.md | 2 +- .../variables/VERTICAL_OCR_LEZGHIAN.md | 2 +- .../variables/VERTICAL_OCR_LITHUANIAN.md | 2 +- .../variables/VERTICAL_OCR_MALAY.md | 2 +- .../variables/VERTICAL_OCR_MALTESE.md | 2 +- .../variables/VERTICAL_OCR_MAORI.md | 2 +- .../variables/VERTICAL_OCR_MONGOLIAN.md | 2 +- .../variables/VERTICAL_OCR_NORWEGIAN.md | 2 +- .../variables/VERTICAL_OCR_OCCITAN.md | 2 +- .../variables/VERTICAL_OCR_PALI.md | 2 +- .../variables/VERTICAL_OCR_POLISH.md | 2 +- .../variables/VERTICAL_OCR_PORTUGUESE.md | 2 +- .../variables/VERTICAL_OCR_ROMANIAN.md | 2 +- .../variables/VERTICAL_OCR_RUSSIAN.md | 2 +- .../VERTICAL_OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/VERTICAL_OCR_SERBIAN_LATIN.md | 2 +- .../VERTICAL_OCR_SIMPLIFIED_CHINESE.md | 2 +- .../variables/VERTICAL_OCR_SLOVAK.md | 2 +- .../variables/VERTICAL_OCR_SLOVENIAN.md | 2 +- .../variables/VERTICAL_OCR_SPANISH.md | 2 +- .../variables/VERTICAL_OCR_SWAHILI.md | 2 +- .../variables/VERTICAL_OCR_SWEDISH.md | 2 +- .../variables/VERTICAL_OCR_TABASSARAN.md | 2 +- .../variables/VERTICAL_OCR_TAGALOG.md | 2 +- .../variables/VERTICAL_OCR_TAJIK.md | 2 +- .../variables/VERTICAL_OCR_TELUGU.md | 2 +- .../variables/VERTICAL_OCR_TURKISH.md | 2 +- .../variables/VERTICAL_OCR_UKRAINIAN.md | 2 +- .../variables/VERTICAL_OCR_UZBEK.md | 2 +- .../variables/VERTICAL_OCR_VIETNAMESE.md | 2 +- .../variables/VERTICAL_OCR_WELSH.md | 2 +- .../variables/WHISPER_BASE.md | 2 +- .../variables/WHISPER_BASE_EN.md | 2 +- .../variables/WHISPER_SMALL.md | 2 +- .../variables/WHISPER_SMALL_EN.md | 2 +- .../variables/WHISPER_TINY.md | 2 +- .../variables/WHISPER_TINY_EN.md | 2 +- .../variables/WHISPER_TINY_EN_QUANTIZED.md | 2 +- .../variables/parseToolCall.md | 2 +- .../computer_vision/ImageEmbeddingsModule.ts | 15 ++ .../ImageSegmentationModule.ts | 21 +- .../src/modules/computer_vision/OCRModule.ts | 18 ++ .../computer_vision/ObjectDetectionModule.ts | 19 ++ 293 files changed, 900 insertions(+), 761 deletions(-) diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index b2039b4c7..6ab1212e5 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,6 @@ # Class: ClassificationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L10) Module for image classification tasks. @@ -28,7 +28,7 @@ Module for image classification tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,9 +58,9 @@ Unloads the model from memory. ### forward() -> **forward**(`imageSource`): `Promise`\<`any`\> +> **forward**(`imageSource`): `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L41) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -74,7 +74,7 @@ The image source to be classified. #### Returns -`Promise`\<`any`\> +`Promise`\<\{\[`category`: `string`\]: `number`; \}\> The classification result. @@ -84,7 +84,7 @@ The classification result. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L18) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L18) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index 20126d727..217ccf11f 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -1,6 +1,6 @@ # Class: ExecutorchModule -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L40) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L40) Executes the model's forward pass, where input is an array of `TensorPtr` objects. If the inference is successful, an array of tensor pointers is returned. @@ -83,7 +83,7 @@ An array of output tensor pointers. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -112,7 +112,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -146,7 +146,7 @@ The input shape as an array of numbers. > **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L16) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L16) Loads the model, where `modelSource` is a string, number, or object that specifies the location of the model binary. Optionally accepts a download progress callback. diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md index bebf322e2..fc0fb00a8 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,8 @@ # Class: ImageEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L10) + +Module for generating image embeddings from input images. ## Extends @@ -26,7 +28,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +60,9 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L40) + +Executes the model's forward pass, where `imageSource` is a URI/URL to image that will be embedded. #### Parameters @@ -66,17 +70,21 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image `string` +The image source to be embedded. + #### Returns `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> +A Float32Array containing the image embeddings. + *** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -105,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -139,12 +147,16 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L17) + +Loads the model, where `modelSource` is a string that specifies the location of the model binary. #### Parameters ##### model +Object containing `modelSource`. + ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) @@ -153,6 +165,8 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md index af00558d5..ee990800a 100644 --- a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -1,6 +1,8 @@ # Class: ImageSegmentationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L11) + +Module for image segmentation tasks. ## Extends @@ -26,7 +28,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -56,9 +58,11 @@ Unloads the model from memory. ### forward() -> **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> +> **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> + +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L45) -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L26) +Executes the model's forward pass #### Parameters @@ -66,17 +70,25 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image `string` +a fetchable resource or a Base64-encoded string. + ##### classesOfInterest? [`DeeplabLabel`](../enumerations/DeeplabLabel.md)[] +an optional list of DeeplabLabel used to indicate additional arrays of probabilities to output (see section "Running the model"). The default is an empty list. + ##### resize? `boolean` +an optional boolean to indicate whether the output should be resized to the original image dimensions, or left in the size of the model (see section "Running the model"). The default is `false`. + #### Returns -`Promise`\<\{ `0?`: `number`[]; `1?`: `number`[]; `10?`: `number`[]; `11?`: `number`[]; `12?`: `number`[]; `13?`: `number`[]; `14?`: `number`[]; `15?`: `number`[]; `16?`: `number`[]; `17?`: `number`[]; `18?`: `number`[]; `19?`: `number`[]; `2?`: `number`[]; `20?`: `number`[]; `21?`: `number`[]; `3?`: `number`[]; `4?`: `number`[]; `5?`: `number`[]; `6?`: `number`[]; `7?`: `number`[]; `8?`: `number`[]; `9?`: `number`[]; \}\> +`Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> + +A dictionary where keys are `DeeplabLabel` and values are arrays of probabilities for each pixel belonging to the corresponding class. *** @@ -84,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +125,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,12 +159,17 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L20) + +Loads the model, where `modelSource` is a string that specifies the location of the model binary. +To track the download progress, supply a callback function `onDownloadProgressCallback`. #### Parameters ##### model +Object containing `modelSource`. + ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) @@ -161,6 +178,8 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Image (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md index 75c743c78..fcd65798b 100644 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -1,6 +1,6 @@ # Class: LLMModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L12) Module for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Module for managing a Large Language Model (LLM) instance. > **new LLMModule**(`optionalCallbacks`): `LLMModule` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L21) Creates a new instance of LLMModule with optional callbacks. @@ -50,7 +50,7 @@ A new LLMModule instance. > **configure**(`configuration`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) Configures chat and tool calling and generation settings. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -73,7 +73,7 @@ Configuration object containing `chatConfig`, `toolsConfig`, and `generationConf > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:169](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L169) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:169](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L169) Method to delete the model from memory. Note you cannot delete model while it's generating. @@ -89,7 +89,7 @@ You need to interrupt it first and make sure model stopped generation. > **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:143](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L143) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:143](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L143) Deletes all messages starting with message on `index` position. After deletion it will call `messageHistoryCallback()` containing new history. @@ -115,7 +115,7 @@ The index of the message to delete from history. > **forward**(`input`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:105](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L105) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:105](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L105) Runs model inference with raw input string. You need to provide entire conversation and prompt (in correct format and with special tokens!) in input string to this method. @@ -142,7 +142,7 @@ The generated response as a string. > **generate**(`messages`, `tools?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:117](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L117) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:117](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L117) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -172,7 +172,7 @@ The generated response as a string. > **getGeneratedTokenCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:160](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L160) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:160](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L160) Returns the number of tokens generated in the last response. @@ -188,7 +188,7 @@ The count of generated tokens. > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L151) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L151) Interrupts model generation. It may return one more token after interrupt. @@ -202,7 +202,7 @@ Interrupts model generation. It may return one more token after interrupt. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L55) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L55) Loads the LLM model and tokenizer. @@ -246,7 +246,7 @@ Optional callback to track download progress (value between 0 and 1). > **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:130](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L130) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:130](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L130) Method to add user message to conversation. After model responds it will call `messageHistoryCallback()` containing both user message and model response. @@ -272,7 +272,7 @@ The message string to send. > **setTokenCallback**(`tokenCallback`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) Sets new token callback invoked on every token batch. diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md index 4e9855d65..96b82cc6f 100644 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -1,6 +1,6 @@ # Class: OCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **new OCRModule**(): `OCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) #### Returns @@ -20,7 +20,10 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:32](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L32) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:50](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L50) + +Release the memory held by the module. Calling `forward` afterwards is invalid. +Note that you cannot delete model while it's generating. #### Returns @@ -32,7 +35,9 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L28) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L42) + +Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. #### Parameters @@ -40,22 +45,32 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo `string` +The image source to be processed. + #### Returns `Promise`\<`any`\> +The OCR result as a string. + *** ### load() > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L20) + +Loads the model, where `detectorSource` is a string that specifies the location of the detector binary, +`recognizerSource` is a string that specifies the location of the recognizer binary, +and `language` is a parameter that specifies the language of the text to be recognized by the OCR. #### Parameters ##### model +Object containing `detectorSource`, `recognizerSource`, and `language`. + ###### detectorSource [`ResourceSource`](../type-aliases/ResourceSource.md) @@ -72,6 +87,8 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index 6c2095a7b..202de48e3 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -1,6 +1,8 @@ # Class: ObjectDetectionModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L11) + +Module for object detection tasks. ## Extends @@ -26,7 +28,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +60,10 @@ Unloads the model from memory. > **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L26) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L45) + +Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. +`detectionThreshold` can be supplied to alter the sensitivity of the detection. #### Parameters @@ -66,21 +71,27 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec `string` +The image source to be processed. + ##### detectionThreshold `number` = `0.7` +The threshold for detection sensitivity. Default is 0.7. + #### Returns `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> +An array of Detection objects representing detected items in the image. + *** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -109,7 +120,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -143,12 +154,17 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L20) + +Loads the model, where `modelSource` is a string that specifies the location of the model binary. +To track the download progress, supply a callback function `onDownloadProgressCallback`. #### Parameters ##### model +Object containing `modelSource`. + ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) @@ -157,6 +173,8 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Objec (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md index 47a238246..9f453d776 100644 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -1,6 +1,6 @@ # Class: ResourceFetcher -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](h > `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](h > `static` **cancelFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251]( > `static` **deleteResources**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278]( > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](h > `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290]( > `static` **listDownloadedFiles**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) #### Returns @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268]( > `static` **listDownloadedModels**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) #### Returns @@ -126,7 +126,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273]( > `static` **pauseFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) #### Parameters @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241]( > `static` **resumeFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) #### Parameters diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md index 0dfc4ad98..8d1753bcd 100644 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -1,6 +1,6 @@ # Class: RnExecutorchError -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/errorUtils.ts#L3) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/errorUtils.ts#L3) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https: > **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/errorUtils.ts#L14) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/errorUtils.ts#L14) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https > `optional` **cause**: `unknown` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/errorUtils.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/errorUtils.ts#L12) The original cause of the error, if any. @@ -56,7 +56,7 @@ The original cause of the error, if any. > **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/errorUtils.ts#L7) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/errorUtils.ts#L7) The error code representing the type of error. diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md index af8d6bcf3..7b19c9b95 100644 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -1,6 +1,6 @@ # Class: SpeechToTextModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L10) Module for Speech to Text (STT) functionalities. @@ -20,7 +20,7 @@ Module for Speech to Text (STT) functionalities. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:94](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L94) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:94](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L94) Runs the decoder of the model. Passing number[] is deprecated. @@ -50,7 +50,7 @@ Decoded output. > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L64) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L64) Unloads the model from memory. @@ -64,7 +64,7 @@ Unloads the model from memory. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:75](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L75) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:75](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L75) Runs the encoding part of the model on the provided waveform. Returns the encoded waveform as a Float32Array. Passing `number[]` is deprecated. @@ -89,7 +89,7 @@ The encoded output. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27) Loads the model specified by the config object. `onDownloadProgressCallback` allows you to monitor the current progress of the model download. @@ -118,7 +118,7 @@ Optional callback to monitor download progress. > **stream**(`options`): `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L151) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L151) Starts a streaming transcription session. Yields objects with `committed` and `nonCommitted` transcriptions. @@ -144,7 +144,7 @@ An async generator yielding transcription updates. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:211](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L211) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:211](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L211) Inserts a new audio chunk into the streaming transcription session. Passing `number[]` is deprecated. @@ -166,7 +166,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:224](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L224) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:224](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L224) Stops the current streaming transcription session. @@ -180,7 +180,7 @@ Stops the current streaming transcription session. > **transcribe**(`waveform`, `options`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:124](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L124) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:124](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L124) Starts a transcription process for a given input array (16kHz waveform). For multilingual models, specify the language in `options`. diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index 9bd0b5d23..17785d72f 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,6 @@ # Class: StyleTransferModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -105,7 +105,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -139,7 +139,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index a44f293cf..dcc52356e 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: TextEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L10) Module for generating text embeddings from input text. @@ -28,7 +28,7 @@ Module for generating text embeddings from input text. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:53](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L53) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:53](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L53) Executes the model's forward pass, where `input` is a text that will be embedded. @@ -84,7 +84,7 @@ A Float32Array containing the vector embeddings. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L20) Loads the model and tokenizer specified by the config object. diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index 786b93fde..209cc7dd5 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -1,6 +1,6 @@ # Class: TextToImageModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) #### Parameters @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -48,7 +48,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -66,7 +66,7 @@ Unloads the model from memory. > **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) #### Parameters @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -125,7 +125,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -159,7 +159,7 @@ The input shape as an array of numbers. > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) #### Returns @@ -171,7 +171,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) #### Parameters diff --git a/docs/docs/06-api-reference/classes/TextToSpeechModule.md b/docs/docs/06-api-reference/classes/TextToSpeechModule.md index c768413f7..a7e2c3793 100644 --- a/docs/docs/06-api-reference/classes/TextToSpeechModule.md +++ b/docs/docs/06-api-reference/classes/TextToSpeechModule.md @@ -1,6 +1,6 @@ # Class: TextToSpeechModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L14) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L14) Module for Text to Speech (TTS) functionalities. @@ -20,7 +20,7 @@ Module for Text to Speech (TTS) functionalities. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L18) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L18) Native module instance @@ -30,7 +30,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:164](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L164) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:164](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L164) Unloads the model from memory. @@ -42,9 +42,9 @@ Unloads the model from memory. ### forward() -> **forward**(`text`, `speed`): `Promise`\<`any`\> +> **forward**(`text`, `speed`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:97](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L97) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:97](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L97) Synthesizes the provided text into speech. Returns a promise that resolves to the full audio waveform as a `Float32Array`. @@ -65,7 +65,7 @@ Optional speed multiplier for the speech synthesis (default is 1.0). #### Returns -`Promise`\<`any`\> +`Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> A promise resolving to the synthesized audio waveform. @@ -75,7 +75,7 @@ A promise resolving to the synthesized audio waveform. > **load**(`config`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L27) Loads the model and voice assets specified by the config object. `onDownloadProgressCallback` allows you to monitor the current progress. @@ -102,9 +102,9 @@ Optional callback to monitor download progress. ### stream() -> **stream**(`input`): `AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>, `void`, `unknown`\> +> **stream**(`input`): `AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:112](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L112) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:112](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L112) Starts a streaming synthesis session. Yields audio chunks as they are generated. @@ -118,7 +118,7 @@ Input object containing text and optional speed. #### Returns -`AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>, `void`, `unknown`\> +`AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>\> An async generator yielding Float32Array audio chunks. @@ -128,7 +128,7 @@ An async generator yielding Float32Array audio chunks. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:157](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L157) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:157](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L157) Stops the streaming process if there is any ongoing. diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md index f2ae0bed2..cd4ef44a8 100644 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -1,6 +1,6 @@ # Class: TokenizerModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L10) Native module instance @@ -26,9 +26,9 @@ Native module instance ### decode() -> **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`any`\> +> **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L54) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L54) Converts an array of token IDs into a string. @@ -48,7 +48,7 @@ Whether to skip special tokens during decoding (default: true). #### Returns -`Promise`\<`any`\> +`Promise`\<`string`\> The decoded string. @@ -56,9 +56,9 @@ The decoded string. ### encode() -> **encode**(`input`): `Promise`\<`any`\> +> **encode**(`input`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:43](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L43) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:43](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L43) Converts a string into an array of token IDs. @@ -72,7 +72,7 @@ The input string to be tokenized. #### Returns -`Promise`\<`any`\> +`Promise`\<`number`[]\> An array of token IDs. @@ -82,7 +82,7 @@ An array of token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L66) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L66) Returns the size of the tokenizer's vocabulary. @@ -98,7 +98,7 @@ The vocabulary size. > **idToToken**(`tokenId`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:76](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L76) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:76](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L76) Returns the token associated to the ID. @@ -122,7 +122,7 @@ The token string associated to ID. > **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L19) Loads the tokenizer from the specified source. `tokenizerSource` is a string that points to the location of the tokenizer JSON file. @@ -153,7 +153,7 @@ Optional callback to monitor download progress. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L86) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L86) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index 82c67f997..d80fe9437 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -1,6 +1,6 @@ # Class: VADModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L39) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L39) Executes the model's forward pass, where `waveform` is a Float32Array representing the audio signal. @@ -82,7 +82,7 @@ A promise resolving to an array of detected speech segments. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -111,7 +111,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -145,7 +145,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L16) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L16) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md index d62bed8f1..ca054f896 100644 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -1,6 +1,6 @@ # Class: VerticalOCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **new VerticalOCRModule**(): `VerticalOCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) #### Returns @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) #### Parameters diff --git a/docs/docs/06-api-reference/enumerations/CocoLabel.md b/docs/docs/06-api-reference/enumerations/CocoLabel.md index 8ccc629d9..ad0268c29 100644 --- a/docs/docs/06-api-reference/enumerations/CocoLabel.md +++ b/docs/docs/06-api-reference/enumerations/CocoLabel.md @@ -1,6 +1,6 @@ # Enumeration: CocoLabel -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:35](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L35) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:35](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L35) COCO dataset class labels used for object detection. @@ -10,7 +10,7 @@ COCO dataset class labels used for object detection. > **AIRPLANE**: `5` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L40) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L40) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](h > **APPLE**: `53` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L87) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L87) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](h > **BACKPACK**: `27` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L62) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L62) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](h > **BANANA**: `52` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L86) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L86) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](h > **BASEBALL**: `39` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L74) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L74) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](h > **BEAR**: `23` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L58) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L58) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](h > **BED**: `65` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L99) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L99) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](h > **BENCH**: `15` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L50) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L50) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](h > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L37) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L37) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](h > **BIRD**: `16` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L51) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L51) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](h > **BLENDER**: `83` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L117) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L117) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117]( > **BOAT**: `9` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L44) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L44) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](h > **BOOK**: `84` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L118) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L118) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118]( > **BOTTLE**: `44` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L78) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L78) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](h > **BOWL**: `51` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L85) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L85) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](h > **BROCCOLI**: `56` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L90) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L90) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](h > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L41) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L41) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](h > **CAKE**: `61` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L95) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L95) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](h > **CAR**: `3` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L38) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L38) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](h > **CARROT**: `57` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L91) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L91) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](h > **CAT**: `17` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L52) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L52) *** @@ -178,7 +178,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](h > **CELL\_PHONE**: `77` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L111) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L111) *** @@ -186,7 +186,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111]( > **CHAIR**: `62` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L96) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L96) *** @@ -194,7 +194,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](h > **CLOCK**: `85` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L119) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L119) *** @@ -202,7 +202,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119]( > **COUCH**: `63` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L97) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L97) *** @@ -210,7 +210,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](h > **COW**: `21` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L56) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L56) *** @@ -218,7 +218,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](h > **CUP**: `47` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L81) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L81) *** @@ -226,7 +226,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](h > **DESK**: `69` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L103) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L103) *** @@ -234,7 +234,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103]( > **DINING\_TABLE**: `67` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L101) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L101) *** @@ -242,7 +242,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101]( > **DOG**: `18` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L53) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L53) *** @@ -250,7 +250,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](h > **DONUT**: `60` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L94) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L94) *** @@ -258,7 +258,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](h > **DOOR**: `71` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L105) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L105) *** @@ -266,7 +266,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105]( > **ELEPHANT**: `22` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L57) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L57) *** @@ -274,7 +274,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](h > **EYE**: `30` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L65) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L65) *** @@ -282,7 +282,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](h > **FIRE\_HYDRANT**: `11` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L46) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L46) *** @@ -290,7 +290,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](h > **FORK**: `48` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L82) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L82) *** @@ -298,7 +298,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](h > **FRISBEE**: `34` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L69) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L69) *** @@ -306,7 +306,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](h > **GIRAFFE**: `25` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L60) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L60) *** @@ -314,7 +314,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](h > **HAIR\_BRUSH**: `91` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L125) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L125) *** @@ -322,7 +322,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125]( > **HAIR\_DRIER**: `89` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L123) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L123) *** @@ -330,7 +330,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123]( > **HANDBAG**: `31` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L66) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L66) *** @@ -338,7 +338,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](h > **HAT**: `26` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L61) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L61) *** @@ -346,7 +346,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](h > **HORSE**: `19` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L54) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L54) *** @@ -354,7 +354,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](h > **HOT\_DOG**: `58` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L92) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L92) *** @@ -362,7 +362,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](h > **KEYBOARD**: `76` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L110) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L110) *** @@ -370,7 +370,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110]( > **KITE**: `38` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L73) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L73) *** @@ -378,7 +378,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](h > **KNIFE**: `49` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L83) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L83) *** @@ -386,7 +386,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](h > **LAPTOP**: `73` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L107) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L107) *** @@ -394,7 +394,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107]( > **MICROWAVE**: `78` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L112) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L112) *** @@ -402,7 +402,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112]( > **MIRROR**: `66` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L100) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L100) *** @@ -410,7 +410,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100]( > **MOTORCYCLE**: `4` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L39) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L39) *** @@ -418,7 +418,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](h > **MOUSE**: `74` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L108) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L108) *** @@ -426,7 +426,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108]( > **ORANGE**: `55` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L89) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L89) *** @@ -434,7 +434,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](h > **OVEN**: `79` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L113) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L113) *** @@ -442,7 +442,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113]( > **PARKING**: `14` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L49) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L49) *** @@ -450,7 +450,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](h > **PERSON**: `1` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L36) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L36) *** @@ -458,7 +458,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](h > **PIZZA**: `59` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L93) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L93) *** @@ -466,7 +466,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](h > **PLATE**: `45` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L79) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L79) *** @@ -474,7 +474,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](h > **POTTED\_PLANT**: `64` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L98) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L98) *** @@ -482,7 +482,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](h > **REFRIGERATOR**: `82` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L116) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L116) *** @@ -490,7 +490,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116]( > **REMOTE**: `75` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L109) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L109) *** @@ -498,7 +498,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109]( > **SANDWICH**: `54` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L88) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L88) *** @@ -506,7 +506,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](h > **SCISSORS**: `87` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L121) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L121) *** @@ -514,7 +514,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121]( > **SHEEP**: `20` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L55) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L55) *** @@ -522,7 +522,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](h > **SHOE**: `29` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L64) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L64) *** @@ -530,7 +530,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](h > **SINK**: `81` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L115) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L115) *** @@ -538,7 +538,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115]( > **SKATEBOARD**: `41` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L75) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L75) *** @@ -546,7 +546,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](h > **SKIS**: `35` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L70) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L70) *** @@ -554,7 +554,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](h > **SNOWBOARD**: `36` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L71) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L71) *** @@ -562,7 +562,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](h > **SPOON**: `50` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L84) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L84) *** @@ -570,7 +570,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](h > **SPORTS**: `37` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L72) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L72) *** @@ -578,7 +578,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](h > **STOP\_SIGN**: `13` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L48) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L48) *** @@ -586,7 +586,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](h > **STREET\_SIGN**: `12` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L47) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L47) *** @@ -594,7 +594,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](h > **SUITCASE**: `33` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L68) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L68) *** @@ -602,7 +602,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](h > **SURFBOARD**: `42` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L76) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L76) *** @@ -610,7 +610,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](h > **TEDDY\_BEAR**: `88` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L122) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L122) *** @@ -618,7 +618,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122]( > **TENNIS\_RACKET**: `43` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L77) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L77) *** @@ -626,7 +626,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](h > **TIE**: `32` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L67) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L67) *** @@ -634,7 +634,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](h > **TOASTER**: `80` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L114) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L114) *** @@ -642,7 +642,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114]( > **TOILET**: `70` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L104) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L104) *** @@ -650,7 +650,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104]( > **TOOTHBRUSH**: `90` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L124) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L124) *** @@ -658,7 +658,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124]( > **TRAFFIC\_LIGHT**: `10` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L45) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L45) *** @@ -666,7 +666,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](h > **TRAIN**: `7` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L42) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L42) *** @@ -674,7 +674,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](h > **TRUCK**: `8` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L43) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L43) *** @@ -682,7 +682,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](h > **TV**: `72` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L106) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L106) *** @@ -690,7 +690,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106]( > **UMBRELLA**: `28` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L63) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L63) *** @@ -698,7 +698,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](h > **VASE**: `86` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L120) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L120) *** @@ -706,7 +706,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120]( > **WINDOW**: `68` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L102) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L102) *** @@ -714,7 +714,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102]( > **WINE\_GLASS**: `46` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L80) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L80) *** @@ -722,4 +722,4 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](h > **ZEBRA**: `24` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L59) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L59) diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md index 46c33b434..f70d82a58 100644 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -1,6 +1,6 @@ # Enumeration: DeeplabLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5]( > **AEROPLANE**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7]( > **ARGMAX**: `21` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27] > **BACKGROUND**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) *** @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6]( > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) *** @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8]( > **BIRD**: `3` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) *** @@ -48,7 +48,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9]( > **BOAT**: `4` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) *** @@ -56,7 +56,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10] > **BOTTLE**: `5` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) *** @@ -64,7 +64,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11] > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) *** @@ -72,7 +72,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12] > **CAR**: `7` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) *** @@ -80,7 +80,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13] > **CAT**: `8` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) *** @@ -88,7 +88,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14] > **CHAIR**: `9` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) *** @@ -96,7 +96,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15] > **COW**: `10` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) *** @@ -104,7 +104,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16] > **DININGTABLE**: `11` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) *** @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17] > **DOG**: `12` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) *** @@ -120,7 +120,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18] > **HORSE**: `13` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) *** @@ -128,7 +128,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19] > **MOTORBIKE**: `14` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) *** @@ -136,7 +136,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20] > **PERSON**: `15` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) *** @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21] > **POTTEDPLANT**: `16` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) *** @@ -152,7 +152,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22] > **SHEEP**: `17` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) *** @@ -160,7 +160,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23] > **SOFA**: `18` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) *** @@ -168,7 +168,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24] > **TRAIN**: `19` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) *** @@ -176,4 +176,4 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25] > **TVMONITOR**: `20` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md index 16eee3e11..aefee713e 100644 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -1,6 +1,6 @@ # Enumeration: RnExecutorchErrorCode -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https: > **AccessFailed**: `34` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) *** @@ -16,7 +16,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](http > **DelegateInvalidCompatibility**: `48` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) *** @@ -24,7 +24,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](http > **DelegateInvalidHandle**: `50` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) *** @@ -32,7 +32,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](http > **DelegateMemoryAllocationFailed**: `49` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) *** @@ -40,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](http > **DownloadInterrupted**: `118` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) Thrown when the number of downloaded files is unexpected, due to download interruptions. @@ -50,7 +50,7 @@ Thrown when the number of downloaded files is unexpected, due to download interr > **EndOfMethod**: `3` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](http > **FileReadFailed**: `114` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. @@ -68,7 +68,7 @@ Thrown when a file read operation failed. This could be invalid image url passed > **FileWriteFailed**: `103` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) An error ocurred when saving a file. This could be, for instance a result image from an image model. @@ -78,7 +78,7 @@ An error ocurred when saving a file. This could be, for instance a result image > **Internal**: `1` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) *** @@ -86,7 +86,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](http > **InvalidArgument**: `18` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) *** @@ -94,7 +94,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](http > **InvalidConfig**: `112` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. @@ -104,7 +104,7 @@ Thrown when config parameters passed to a model are invalid. For example, when L > **InvalidExternalData**: `36` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) *** @@ -112,7 +112,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](http > **InvalidModelOutput**: `115` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) Thrown when the size of model output is unexpected. @@ -122,7 +122,7 @@ Thrown when the size of model output is unexpected. > **InvalidModelSource**: `255` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) Thrown when the type of model source passed by the user is invalid. @@ -132,7 +132,7 @@ Thrown when the type of model source passed by the user is invalid. > **InvalidProgram**: `35` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) *** @@ -140,7 +140,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](http > **InvalidState**: `2` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) *** @@ -148,7 +148,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](http > **InvalidType**: `19` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) *** @@ -156,7 +156,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](http > **InvalidUserInput**: `117` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). @@ -166,7 +166,7 @@ Thrown when the input passed to our APIs is invalid, for example when passing an > **LanguageNotSupported**: `105` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. @@ -176,7 +176,7 @@ Thrown when a language is passed to a multi-language model that is not supported > **MemoryAllocationFailed**: `33` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) *** @@ -184,7 +184,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](http > **MissingDataChunk**: `161` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) Thrown when streaming transcription is attempted but audio data chunk is missing. @@ -194,7 +194,7 @@ Thrown when streaming transcription is attempted but audio data chunk is missing > **ModelGenerating**: `104` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. @@ -204,7 +204,7 @@ Thrown when a user tries to run a model that is currently processing. It is only > **ModuleNotLoaded**: `102` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. @@ -214,7 +214,7 @@ Thrown when a user tries to run a model that is not yet downloaded or loaded int > **MultilingualConfiguration**: `160` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. @@ -224,7 +224,7 @@ Thrown when there's a configuration mismatch between multilingual and language s > **NotFound**: `32` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) *** @@ -232,7 +232,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](http > **NotImplemented**: `17` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) *** @@ -240,7 +240,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](http > **NotSupported**: `16` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) *** @@ -248,7 +248,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](http > **Ok**: `0` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) *** @@ -256,7 +256,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](http > **OperatorMissing**: `20` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) *** @@ -264,7 +264,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](http > **OutOfResources**: `37` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) *** @@ -272,7 +272,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](http > **ResourceFetcherAlreadyOngoing**: `183` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) Thrown when trying to resume a download that is already ongoing. @@ -282,7 +282,7 @@ Thrown when trying to resume a download that is already ongoing. > **ResourceFetcherAlreadyPaused**: `182` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) Thrown when trying to pause a download that is already paused. @@ -292,7 +292,7 @@ Thrown when trying to pause a download that is already paused. > **ResourceFetcherDownloadFailed**: `180` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. @@ -302,7 +302,7 @@ Thrown when a resource fails to download. This could be due to invalid URL, or f > **ResourceFetcherDownloadInProgress**: `181` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) Thrown when a user tries to trigger a download that's already in progress. @@ -312,7 +312,7 @@ Thrown when a user tries to trigger a download that's already in progress. > **ResourceFetcherMissingUri**: `185` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) Thrown when required URI information is missing for a download operation. @@ -322,7 +322,7 @@ Thrown when required URI information is missing for a download operation. > **ResourceFetcherNotActive**: `184` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) Thrown when trying to pause, resume, or cancel a download that is not active. @@ -332,7 +332,7 @@ Thrown when trying to pause, resume, or cancel a download that is not active. > **StreamingInProgress**: `163` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) Thrown when trying to start a new streaming session while another is already in progress. @@ -342,7 +342,7 @@ Thrown when trying to start a new streaming session while another is already in > **StreamingNotStarted**: `162` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) Thrown when trying to stop or insert data into a stream that hasn't been started. @@ -352,7 +352,7 @@ Thrown when trying to stop or insert data into a stream that hasn't been started > **ThreadPoolError**: `113` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) Thrown when React Native ExecuTorch threadpool problem occurs. @@ -362,7 +362,7 @@ Thrown when React Native ExecuTorch threadpool problem occurs. > **UnexpectedNumInputs**: `97` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) Thrown when the number of passed inputs to the model is different than the model metadata specifies. @@ -372,7 +372,7 @@ Thrown when the number of passed inputs to the model is different than the model > **UnknownError**: `101` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. @@ -382,6 +382,6 @@ An umbrella-error that is thrown usually when something unexpected happens, for > **WrongDimensions**: `116` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md index 056c64a9a..32e5b588a 100644 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -1,6 +1,6 @@ # Enumeration: ScalarType -Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L13) +Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L13) Enum representing the scalar types of tensors. @@ -10,7 +10,7 @@ Enum representing the scalar types of tensors. > **BITS16**: `22` -Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L28) +Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L28) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://gi > **BOOL**: `11` -Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L22) +Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L22) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://gi > **BYTE**: `0` -Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L14) +Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L14) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://gi > **CHAR**: `1` -Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L15) +Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L15) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://gi > **DOUBLE**: `7` -Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L21) +Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L21) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://gi > **FLOAT**: `6` -Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L20) +Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L20) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://gi > **FLOAT8E4M3FN**: `24` -Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L30) +Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L30) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://gi > **FLOAT8E4M3FNUZ**: `26` -Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L32) +Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L32) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://gi > **FLOAT8E5M2**: `23` -Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L29) +Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L29) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://gi > **FLOAT8E5M2FNUZ**: `25` -Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L31) +Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L31) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://gi > **HALF**: `5` -Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L19) +Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L19) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://gi > **INT**: `3` -Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L17) +Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L17) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://gi > **LONG**: `4` -Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L18) +Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L18) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://gi > **QINT32**: `14` -Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L25) +Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L25) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://gi > **QINT8**: `12` -Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L23) +Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L23) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://gi > **QUINT2X4**: `17` -Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L27) +Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L27) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://gi > **QUINT4X2**: `16` -Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L26) +Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L26) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://gi > **QUINT8**: `13` -Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L24) +Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L24) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://gi > **SHORT**: `2` -Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L16) +Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L16) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://gi > **UINT16**: `27` -Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L33) +Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L33) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://gi > **UINT32**: `28` -Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L34) +Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L34) *** @@ -178,4 +178,4 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://gi > **UINT64**: `29` -Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L35) +Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L35) diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md index b4d87d81e..b77315bf9 100644 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -2,7 +2,7 @@ > **DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT**(`structuredOutputSchema`): `string` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) ## Parameters diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md index 6503c98b5..55b5e4baf 100644 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -2,7 +2,7 @@ > **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> -Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/llm.ts#L81) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/llm.ts#L81) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md index 9a5c62edc..b25357318 100644 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -2,7 +2,7 @@ > **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` -Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/llm.ts#L50) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/llm.ts#L50) ## Type Parameters diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md index 228f08aa2..4f796f631 100644 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -2,7 +2,7 @@ > **useClassification**(`ClassificationConfiguration`): [`ClassificationType`](../interfaces/ClassificationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L11) React hook for managing a Classification model instance. diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md index 106482fea..4c93d27bc 100644 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -2,7 +2,7 @@ > **useExecutorchModule**(`executorchModuleConfiguration`): [`ExecutorchModuleType`](../interfaces/ExecutorchModuleType.md) -Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L11) React hook for managing an arbitrary Executorch module instance. diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md index fe3ef5e90..76c70aff8 100644 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -2,7 +2,7 @@ > **useImageEmbeddings**(`ImageEmbeddingsConfiguration`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L11) React hook for managing an Image Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md index 7e8028dfe..7e154f680 100644 --- a/docs/docs/06-api-reference/functions/useImageSegmentation.md +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -2,7 +2,7 @@ > **useImageSegmentation**(`ImageSegmentationConfiguration`): [`ImageSegmentationType`](../interfaces/ImageSegmentationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L11) React hook for managing an Image Segmentation model instance. diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md index 725532967..020c3d1de 100644 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -2,7 +2,7 @@ > **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L18) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L18) React hook for managing a Large Language Model (LLM) instance. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md index 5fee1aa06..b9f48b759 100644 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -2,7 +2,7 @@ > **useOCR**(`OCRConfiguration`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L12) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L12) React hook for managing an OCR instance. diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md index f378b5432..74edcaed9 100644 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -2,7 +2,7 @@ > **useObjectDetection**(`ObjectDetectionConfiguration`): [`ObjectDetectionType`](../interfaces/ObjectDetectionType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L11) React hook for managing an Object Detection model instance. diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md index d3697ce66..024a6c45e 100644 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -2,7 +2,7 @@ > **useSpeechToText**(`speechToTextConfiguration`): [`SpeechToTextType`](../interfaces/SpeechToTextType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) React hook for managing a Speech to Text (STT) instance. diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md index 094d34221..fc398483e 100644 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -2,7 +2,7 @@ > **useStyleTransfer**(`StyleTransferConfiguration`): [`StyleTransferType`](../interfaces/StyleTransferType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L11) React hook for managing a Style Transfer model instance. diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md index ba77c3495..c2e9fc571 100644 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -2,7 +2,7 @@ > **useTextEmbeddings**(`TextEmbeddingsConfiguration`): [`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) React hook for managing a Text Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md index 25a0750af..2a75f0eec 100644 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -2,7 +2,7 @@ > **useTextToImage**(`TextToImageConfiguration`): [`TextToImageType`](../interfaces/TextToImageType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L13) React hook for managing a Text to Image instance. diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md index 6ce90d878..0ad1b3ada 100644 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -2,7 +2,7 @@ > **useTextToSpeech**(`TextToSpeechConfiguration`): [`TextToSpeechType`](../interfaces/TextToSpeechType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L18) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L18) React hook for managing Text to Speech instance. diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md index dd907e724..a52272f70 100644 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -2,7 +2,7 @@ > **useTokenizer**(`tokenizerConfiguration`): [`TokenizerType`](../interfaces/TokenizerType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) React hook for managing a Tokenizer instance. diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md index 5f4881d98..4564d956d 100644 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -2,7 +2,7 @@ > **useVAD**(`VADConfiguration`): [`VADType`](../interfaces/VADType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) React hook for managing a VAD model instance. diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md index 846a1b2f6..7a3e99d36 100644 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -2,7 +2,7 @@ > **useVerticalOCR**(`VerticalOCRConfiguration`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L12) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L12) React hook for managing a Vertical OCR instance. diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md index 9b73b939f..2a0a0c7d7 100644 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -1,6 +1,6 @@ # Interface: Bbox -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L12) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L12) Represents a bounding box for a detected object in an image. @@ -10,7 +10,7 @@ Represents a bounding box for a detected object in an image. > **x1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L13) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L13) The x-coordinate of the bottom-left corner of the bounding box. @@ -20,7 +20,7 @@ The x-coordinate of the bottom-left corner of the bounding box. > **x2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L14) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L14) The x-coordinate of the top-right corner of the bounding box. @@ -30,7 +30,7 @@ The x-coordinate of the top-right corner of the bounding box. > **y1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L15) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L15) The y-coordinate of the bottom-left corner of the bounding box. @@ -40,6 +40,6 @@ The y-coordinate of the bottom-left corner of the bounding box. > **y2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L16) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L16) The y-coordinate of the top-right corner of the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md index a95f98c4f..7701830ac 100644 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -1,6 +1,6 @@ # Interface: ChatConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L168) +Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L168) Object configuring chat management. @@ -10,7 +10,7 @@ Object configuring chat management. > **contextWindowLength**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:170](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L170) +Defined in: [packages/react-native-executorch/src/types/llm.ts:170](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L170) The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. @@ -20,7 +20,7 @@ The number of messages from the current conversation that the model will use to > **initialMessageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:169](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L169) +Defined in: [packages/react-native-executorch/src/types/llm.ts:169](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L169) An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. @@ -30,6 +30,6 @@ An array of `Message` objects that represent the conversation history. This can > **systemPrompt**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:171](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L171) +Defined in: [packages/react-native-executorch/src/types/llm.ts:171](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L171) Often used to tell the model what is its purpose, for example - "Be a helpful translator". diff --git a/docs/docs/06-api-reference/interfaces/ClassificationProps.md b/docs/docs/06-api-reference/interfaces/ClassificationProps.md index b7ce214d5..61a97ddfb 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationProps.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationProps.md @@ -1,6 +1,6 @@ # Interface: ClassificationProps -Defined in: [packages/react-native-executorch/src/types/classification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L11) +Defined in: [packages/react-native-executorch/src/types/classification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L11) Props for the `useClassification` hook. @@ -10,7 +10,7 @@ Props for the `useClassification` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L12) +Defined in: [packages/react-native-executorch/src/types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L13) +Defined in: [packages/react-native-executorch/src/types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ClassificationType.md b/docs/docs/06-api-reference/interfaces/ClassificationType.md index 043bbfe70..4c4354b2c 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationType.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationType.md @@ -1,6 +1,6 @@ # Interface: ClassificationType -Defined in: [packages/react-native-executorch/src/types/classification.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L20) +Defined in: [packages/react-native-executorch/src/types/classification.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L20) Return type for the `useClassification` hook. Manages the state and operations for Computer Vision image classification. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image classification. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/classification.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L39) +Defined in: [packages/react-native-executorch/src/types/classification.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/classification.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L24) +Defined in: [packages/react-native-executorch/src/types/classification.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during classification. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: [packages/react-native-executorch/src/types/classification.ts:47](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L47) +Defined in: [packages/react-native-executorch/src/types/classification.ts:47](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L47) Executes the model's forward pass to classify the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L34) +Defined in: [packages/react-native-executorch/src/types/classification.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L34) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/classification.ts#L29) +Defined in: [packages/react-native-executorch/src/types/classification.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L29) Indicates whether the classification model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md index 4b6941cff..800809eda 100644 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -1,6 +1,6 @@ # Interface: DecodingOptions -Defined in: [packages/react-native-executorch/src/types/stt.ts:169](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L169) +Defined in: [packages/react-native-executorch/src/types/stt.ts:169](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L169) Options for decoding speech to text. @@ -10,6 +10,6 @@ Options for decoding speech to text. > `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:170](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L170) +Defined in: [packages/react-native-executorch/src/types/stt.ts:170](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L170) Optional language code to guide the transcription. diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md index 588195459..30356a459 100644 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -1,6 +1,6 @@ # Interface: Detection -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L26) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L26) Represents a detected object within an image, including its bounding box, label, and confidence score. @@ -10,7 +10,7 @@ Represents a detected object within an image, including its bounding box, label, > **bbox**: [`Bbox`](Bbox.md) -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L27) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L27) The bounding box of the detected object, defined by its top-left (x1, y1) and bottom-right (x2, y2) coordinates. @@ -20,7 +20,7 @@ The bounding box of the detected object, defined by its top-left (x1, y1) and bo > **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L28) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L28) The class label of the detected object, represented as a key from the `CocoLabel` enum. @@ -30,6 +30,6 @@ The class label of the detected object, represented as a key from the `CocoLabel > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L29) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L29) The confidence score of the detection, typically ranging from 0 to 1. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md index 74cc44f3e..f956e0af0 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleProps -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L10) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L10) Props for the `useExecutorchModule` hook. @@ -10,7 +10,7 @@ Props for the `useExecutorchModule` hook. > **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L11) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L11) The source of the ExecuTorch model binary. @@ -20,6 +20,6 @@ The source of the ExecuTorch model binary. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L12) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L12) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md index 1d5705f1e..d51157913 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleType -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L19) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L19) Return type for the `useExecutorchModule` hook. Manages the state and core execution methods for a general ExecuTorch model. @@ -11,7 +11,7 @@ Manages the state and core execution methods for a general ExecuTorch model. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L38) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L38) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L23) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L23) Contains the error object if the model failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`inputTensor`) => `Promise`\<[`TensorPtr`](TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L46) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L46) Executes the model's forward pass with the provided input tensors. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another request. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:33](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L33) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:33](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L33) Indicates whether the model is currently processing a forward pass. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing a forward pass. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/executorchModule.ts#L28) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L28) Indicates whether the ExecuTorch model binary has successfully loaded into memory and is ready for inference. diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md index 38156e9b8..384e01001 100644 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -1,6 +1,6 @@ # Interface: GenerationConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:195](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L195) +Defined in: [packages/react-native-executorch/src/types/llm.ts:195](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L195) Object configuring generation settings. @@ -10,7 +10,7 @@ Object configuring generation settings. > `optional` **batchTimeInterval**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L199) +Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L199) Upper limit on the time interval between consecutive token batches. @@ -20,7 +20,7 @@ Upper limit on the time interval between consecutive token batches. > `optional` **outputTokenBatchSize**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L198) +Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L198) Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). @@ -30,7 +30,7 @@ Soft upper limit on the number of tokens in each token batch (in certain cases t > `optional` **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:196](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L196) +Defined in: [packages/react-native-executorch/src/types/llm.ts:196](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L196) Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. @@ -40,6 +40,6 @@ Scales output logits by the inverse of temperature. Controls the randomness / cr > `optional` **topp**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:197](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L197) +Defined in: [packages/react-native-executorch/src/types/llm.ts:197](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L197) Only samples from the smallest set of tokens whose cumulative probability exceeds topp. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md index c887ec046..113ab2bca 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L11) Props for the `useImageEmbeddings` hook. @@ -10,7 +10,7 @@ Props for the `useImageEmbeddings` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md index f23a21997..80bd2459a 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L20) Return type for the `useImageEmbeddings` hook. Manages the state and operations for generating image embeddings (feature vectors) used in Computer Vision tasks. @@ -11,7 +11,7 @@ Manages the state and operations for generating image embeddings (feature vector > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L39) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during embedding generation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:47](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L47) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:47](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L47) Executes the model's forward pass to generate embeddings (a feature vector) for the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L34) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L34) Indicates whether the model is currently generating embeddings for an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently generating embeddings for an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageEmbeddings.ts#L29) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L29) Indicates whether the image embeddings model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md index 2b928af07..eaa735f63 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md @@ -1,6 +1,6 @@ # Interface: ImageSegmentationProps -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:37](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L37) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:37](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L37) Props for the `useImageSegmentation` hook. @@ -10,7 +10,7 @@ Props for the `useImageSegmentation` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:38](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L38) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:38](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L38) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L39) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L39) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md index 4c8174a8b..1d5e5d18a 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md @@ -1,6 +1,6 @@ # Interface: ImageSegmentationType -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L46) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L46) Return type for the `useImageSegmentation` hook. Manages the state and operations for Computer Vision image segmentation (e.g., DeepLab). @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image segmentation (e.g., D > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:65](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L65) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:65](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L65) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:50](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L50) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:50](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L50) Contains the error object if the model failed to load, download, or encountered a runtime error during segmentation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `classesOfInterest?`, `resize?`) => `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:75](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L75) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:75](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L75) Executes the model's forward pass to perform semantic segmentation on the provided image. @@ -71,7 +71,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L60) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L60) Indicates whether the model is currently processing an image. @@ -81,6 +81,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:55](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/imageSegmentation.ts#L55) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:55](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L55) Indicates whether the segmentation model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/KokoroConfig.md b/docs/docs/06-api-reference/interfaces/KokoroConfig.md index 123672101..b39fbcacd 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroConfig.md +++ b/docs/docs/06-api-reference/interfaces/KokoroConfig.md @@ -1,6 +1,6 @@ # Interface: KokoroConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:43](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L43) +Defined in: [packages/react-native-executorch/src/types/tts.ts:43](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L43) Kokoro model configuration. Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. @@ -11,7 +11,7 @@ Only the core Kokoro model sources, as phonemizer sources are included in voice > **durationPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:45](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L45) +Defined in: [packages/react-native-executorch/src/types/tts.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L45) source to Kokoro's duration predictor model binary @@ -21,7 +21,7 @@ source to Kokoro's duration predictor model binary > **synthesizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tts.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L46) source to Kokoro's synthesizer model binary @@ -31,6 +31,6 @@ source to Kokoro's synthesizer model binary > **type**: `"kokoro"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:44](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L44) +Defined in: [packages/react-native-executorch/src/types/tts.ts:44](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L44) model type identifier diff --git a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md index d46c01e9f..7726f19fa 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md +++ b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md @@ -1,6 +1,6 @@ # Interface: KokoroVoiceExtras -Defined in: [packages/react-native-executorch/src/types/tts.ts:30](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L30) +Defined in: [packages/react-native-executorch/src/types/tts.ts:30](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L30) Kokoro-specific voice extra props @@ -10,7 +10,7 @@ Kokoro-specific voice extra props > **lexiconSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:32](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L32) +Defined in: [packages/react-native-executorch/src/types/tts.ts:32](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L32) source to Kokoro's lexicon binary @@ -20,6 +20,6 @@ source to Kokoro's lexicon binary > **taggerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:31](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L31) +Defined in: [packages/react-native-executorch/src/types/tts.ts:31](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L31) source to Kokoro's tagger model binary diff --git a/docs/docs/06-api-reference/interfaces/LLMConfig.md b/docs/docs/06-api-reference/interfaces/LLMConfig.md index f9ef292a6..44a8ce623 100644 --- a/docs/docs/06-api-reference/interfaces/LLMConfig.md +++ b/docs/docs/06-api-reference/interfaces/LLMConfig.md @@ -1,6 +1,6 @@ # Interface: LLMConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L93) +Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L93) Configuration object for initializing and customizing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Configuration object for initializing and customizing a Large Language Model (LL > `optional` **chatConfig**: `Partial`\<[`ChatConfig`](ChatConfig.md)\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:103](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L103) +Defined in: [packages/react-native-executorch/src/types/llm.ts:103](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L103) Object configuring chat management, contains following properties: @@ -26,7 +26,7 @@ Object configuring chat management, contains following properties: > `optional` **generationConfig**: [`GenerationConfig`](GenerationConfig.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:127](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L127) +Defined in: [packages/react-native-executorch/src/types/llm.ts:127](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L127) Object configuring generation settings. @@ -44,7 +44,7 @@ Object configuring generation settings. > `optional` **toolsConfig**: [`ToolsConfig`](ToolsConfig.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L114) +Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L114) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md index 7e9a36758..31f6864c2 100644 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -1,6 +1,6 @@ # Interface: LLMType -Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L6) +Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L6) React hook for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ React hook for managing a Large Language Model (LLM) instance. > **configure**: (`configuration`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L48) +Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L48) Configures chat and tool calling. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -33,7 +33,7 @@ Configuration object containing `chatConfig`, `toolsConfig`, and `generationConf > **deleteMessage**: (`index`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:82](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L82) +Defined in: [packages/react-native-executorch/src/types/llm.ts:82](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L82) Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. @@ -55,7 +55,7 @@ The index of the message to delete from history. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L35) +Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L35) Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. @@ -65,7 +65,7 @@ Represents the download progress as a value between 0 and 1, indicating the exte > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L40) +Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L40) Contains the error message if the model failed to load. @@ -75,7 +75,7 @@ Contains the error message if the model failed to load. > **generate**: (`messages`, `tools?`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:67](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L67) +Defined in: [packages/react-native-executorch/src/types/llm.ts:67](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L67) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -103,7 +103,7 @@ Optional array of tools that can be used during generation. > **getGeneratedTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L59) +Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L59) Returns the number of tokens generated so far in the current generation. @@ -119,7 +119,7 @@ The count of generated tokens. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:87](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L87) +Defined in: [packages/react-native-executorch/src/types/llm.ts:87](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L87) Function to interrupt the current inference. @@ -133,7 +133,7 @@ Function to interrupt the current inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L30) +Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L30) Indicates whether the model is currently generating a response. @@ -143,7 +143,7 @@ Indicates whether the model is currently generating a response. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L25) +Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L25) Indicates whether the model is ready. @@ -153,7 +153,7 @@ Indicates whether the model is ready. > **messageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L10) +Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L10) History containing all messages in conversation. This field is updated after model responds to sendMessage. @@ -163,7 +163,7 @@ History containing all messages in conversation. This field is updated after mod > **response**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L15) +Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L15) State of the generated response. This field is updated with each token generated by the model. @@ -173,7 +173,7 @@ State of the generated response. This field is updated with each token generated > **sendMessage**: (`message`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:75](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L75) +Defined in: [packages/react-native-executorch/src/types/llm.ts:75](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L75) Function to add user message to conversation. After model responds, `messageHistory` will be updated with both user message and model response. @@ -196,6 +196,6 @@ The message string to send. > **token**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L20) +Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L20) The most recently generated token. diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md index 4c58ef734..720034e19 100644 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -1,6 +1,6 @@ # Interface: Message -Defined in: [packages/react-native-executorch/src/types/llm.ts:141](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L141) +Defined in: [packages/react-native-executorch/src/types/llm.ts:141](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L141) Represents a message in the conversation. @@ -10,7 +10,7 @@ Represents a message in the conversation. > **content**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L143) +Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L143) Content of the message. @@ -20,6 +20,6 @@ Content of the message. > **role**: [`MessageRole`](../type-aliases/MessageRole.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L142) +Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L142) Role of the message sender of type `MessageRole`. diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md index d014a402b..eefe3dd55 100644 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -1,6 +1,6 @@ # Interface: OCRDetection -Defined in: [packages/react-native-executorch/src/types/ocr.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L13) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L13) OCRDetection represents a single detected text instance in an image, including its bounding box, recognized text, and confidence score. @@ -11,7 +11,7 @@ including its bounding box, recognized text, and confidence score. > **bbox**: [`Point`](Point.md)[] -Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L14) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L14) An array of points defining the bounding box around the detected text. @@ -21,7 +21,7 @@ An array of points defining the bounding box around the detected text. > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L16) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L16) The confidence score of the OCR detection, ranging from 0 to 1. @@ -31,6 +31,6 @@ The confidence score of the OCR detection, ranging from 0 to 1. > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L15) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L15) The recognized text within the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/OCRProps.md b/docs/docs/06-api-reference/interfaces/OCRProps.md index e63a3bd9c..0a4005d1f 100644 --- a/docs/docs/06-api-reference/interfaces/OCRProps.md +++ b/docs/docs/06-api-reference/interfaces/OCRProps.md @@ -1,6 +1,6 @@ # Interface: OCRProps -Defined in: [packages/react-native-executorch/src/types/ocr.ts:33](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L33) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:33](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L33) Configuration properties for the `useOCR` hook. @@ -14,7 +14,7 @@ Configuration properties for the `useOCR` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L37) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L37) Object containing the necessary model sources and configuration for the OCR pipeline. @@ -42,7 +42,7 @@ The language configuration enum for the OCR model (e.g., English, Polish, etc.). > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L58) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L58) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/OCRType.md b/docs/docs/06-api-reference/interfaces/OCRType.md index 67825ff44..c83319021 100644 --- a/docs/docs/06-api-reference/interfaces/OCRType.md +++ b/docs/docs/06-api-reference/interfaces/OCRType.md @@ -1,6 +1,6 @@ # Interface: OCRType -Defined in: [packages/react-native-executorch/src/types/ocr.ts:76](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L76) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:76](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L76) Return type for the `useOCR` hook. Manages the state and operations for Optical Character Recognition (OCR). @@ -11,7 +11,7 @@ Manages the state and operations for Optical Character Recognition (OCR). > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:95](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L95) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:95](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L95) Represents the total download progress of the model binaries as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the total download progress of the model binaries as a value between > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L80) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L80) Contains the error object if the models failed to load, download, or encountered a runtime error during recognition. @@ -31,7 +31,7 @@ Contains the error object if the models failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<[`OCRDetection`](OCRDetection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L103) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L103) Executes the OCR pipeline (detection and recognition) on the provided image. @@ -59,7 +59,7 @@ If the models are not loaded or are currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:90](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L90) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:90](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L90) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:85](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L85) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:85](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L85) Indicates whether both detector and recognizer models are loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md index ad3834e7a..7c547fa37 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionProps -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:135](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L135) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:135](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L135) Props for the `useObjectDetection` hook. @@ -10,7 +10,7 @@ Props for the `useObjectDetection` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:136](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L136) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:136](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L136) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:137](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L137) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:137](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L137) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md index ea3ac4963..826fcd2a4 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionType -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:144](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L144) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:144](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L144) Return type for the `useObjectDetection` hook. Manages the state and operations for Computer Vision object detection tasks. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision object detection tasks. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:163](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L163) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:163](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L163) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:148](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L148) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:148](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L148) Contains the error object if the model failed to load, download, or encountered a runtime error during detection. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `detectionThreshold?`) => `Promise`\<[`Detection`](Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:172](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L172) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:172](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L172) Executes the model's forward pass to detect objects within the provided image. @@ -65,7 +65,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:158](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L158) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:158](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L158) Indicates whether the model is currently processing an image. @@ -75,6 +75,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:153](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/objectDetection.ts#L153) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:153](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L153) Indicates whether the object detection model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/Point.md b/docs/docs/06-api-reference/interfaces/Point.md index f7efe0528..7246dfb12 100644 --- a/docs/docs/06-api-reference/interfaces/Point.md +++ b/docs/docs/06-api-reference/interfaces/Point.md @@ -1,6 +1,6 @@ # Interface: Point -Defined in: [packages/react-native-executorch/src/types/ocr.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L25) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L25) Point represents a coordinate in 2D space. @@ -10,7 +10,7 @@ Point represents a coordinate in 2D space. > **x**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L26) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L26) The x-coordinate of the point. @@ -20,6 +20,6 @@ The x-coordinate of the point. > **y**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L27) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L27) The y-coordinate of the point. diff --git a/docs/docs/06-api-reference/interfaces/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index ec9762074..d9b6fdbf2 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,6 @@ # Interface: Segment -Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L22) +Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L22) Represents a detected audio segment with start and end timestamps. @@ -10,7 +10,7 @@ Represents a detected audio segment with start and end timestamps. > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L24) +Defined in: [packages/react-native-executorch/src/types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L24) End time of the segment in seconds. @@ -20,6 +20,6 @@ End time of the segment in seconds. > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:23](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L23) +Defined in: [packages/react-native-executorch/src/types/vad.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L23) Start time of the segment in seconds. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md index dfe018bd2..7236a1c61 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextModelConfig -Defined in: [packages/react-native-executorch/src/types/stt.ts:176](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L176) +Defined in: [packages/react-native-executorch/src/types/stt.ts:176](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L176) Configuration for Speech to Text model. @@ -10,7 +10,7 @@ Configuration for Speech to Text model. > **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:190](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L190) +Defined in: [packages/react-native-executorch/src/types/stt.ts:190](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L190) A string that specifies the location of a `.pte` file for the decoder. @@ -20,7 +20,7 @@ A string that specifies the location of a `.pte` file for the decoder. > **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:185](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L185) +Defined in: [packages/react-native-executorch/src/types/stt.ts:185](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L185) A string that specifies the location of a `.pte` file for the encoder. @@ -30,7 +30,7 @@ A string that specifies the location of a `.pte` file for the encoder. > **isMultilingual**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:180](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L180) +Defined in: [packages/react-native-executorch/src/types/stt.ts:180](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L180) A boolean flag indicating whether the model supports multiple languages. @@ -40,6 +40,6 @@ A boolean flag indicating whether the model supports multiple languages. > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:195](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L195) +Defined in: [packages/react-native-executorch/src/types/stt.ts:195](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L195) A string that specifies the location to the tokenizer for the model. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md index 0b3ba0716..6247e5d4a 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextType -Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L7) +Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L7) React hook for managing Speech to Text (STT) instance. @@ -10,7 +10,7 @@ React hook for managing Speech to Text (STT) instance. > **committedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L32) +Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L32) Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. @@ -21,7 +21,7 @@ Useful for displaying stable results during streaming. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L26) +Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L26) Tracks the progress of the model download process. @@ -31,7 +31,7 @@ Tracks the progress of the model download process. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L11) +Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L11) Contains the error message if the model failed to load. @@ -41,7 +41,7 @@ Contains the error message if the model failed to load. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L21) +Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L21) Indicates whether the model is currently processing an inference. @@ -51,7 +51,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L16) +Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L16) Indicates whether the model has successfully loaded and is ready for inference. @@ -61,7 +61,7 @@ Indicates whether the model has successfully loaded and is ready for inference. > **nonCommittedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L38) +Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L38) Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. @@ -72,7 +72,7 @@ Useful for displaying live, partial results during streaming. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L53) +Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L53) Runs the decoder of the model. Passing `number[]` is deprecated. @@ -102,7 +102,7 @@ A promise resolving to the decoded text. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L45) +Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L45) Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. @@ -126,7 +126,7 @@ A promise resolving to the encoded data. > **stream**(`options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L71) +Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L71) Starts a streaming transcription process. Use in combination with streamInsert to feed audio chunks and streamStop to end the stream. @@ -152,7 +152,7 @@ The final transcription string. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L78) +Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L78) Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Passing `number[]` is deprecated. @@ -175,7 +175,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L83) +Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L83) Stops the ongoing streaming transcription process. @@ -189,7 +189,7 @@ Stops the ongoing streaming transcription process. > **transcribe**(`waveform`, `options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L62) +Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L62) Starts a transcription process for a given input array, which should be a waveform at 16kHz. Passing `number[]` is deprecated. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md index 4a7295c4d..92eebaeeb 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md @@ -1,6 +1,6 @@ # Interface: StyleTransferProps -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L11) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L11) Configuration properties for the `useStyleTransfer` hook. @@ -10,7 +10,7 @@ Configuration properties for the `useStyleTransfer` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L12) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L12) Object containing the `modelSource` for the style transfer model. @@ -24,6 +24,6 @@ Object containing the `modelSource` for the style transfer model. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L13) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L13) 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 a32817999..f49c80fd4 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferType.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferType.md @@ -1,6 +1,6 @@ # Interface: StyleTransferType -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L20) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L20) Return type for the `useStyleTransfer` hook. Manages the state and operations for applying artistic style transfer to images. @@ -11,7 +11,7 @@ Manages the state and operations for applying artistic style transfer to images. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L39) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:24](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L24) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during style transfer. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:47](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L47) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:47](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L47) Executes the model's forward pass to apply the specific artistic style to the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L34) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L34) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/styleTransfer.ts#L29) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L29) Indicates whether the style transfer model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md index 281569948..a7c8650ac 100644 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -1,6 +1,6 @@ # Interface: TensorPtr -Defined in: [packages/react-native-executorch/src/types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L61) +Defined in: [packages/react-native-executorch/src/types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L61) Represents a pointer to a tensor, including its data buffer, size dimensions, and scalar type. @@ -10,7 +10,7 @@ Represents a pointer to a tensor, including its data buffer, size dimensions, an > **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:62](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L62) +Defined in: [packages/react-native-executorch/src/types/common.ts:62](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L62) The data buffer of the tensor. @@ -20,7 +20,7 @@ The data buffer of the tensor. > **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:64](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L64) +Defined in: [packages/react-native-executorch/src/types/common.ts:64](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L64) The scalar type of the tensor, as defined in the `ScalarType` enum. @@ -30,6 +30,6 @@ The scalar type of the tensor, as defined in the `ScalarType` enum. > **sizes**: `number`[] -Defined in: [packages/react-native-executorch/src/types/common.ts:63](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L63) +Defined in: [packages/react-native-executorch/src/types/common.ts:63](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L63) An array representing the size of each dimension of the tensor. diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md index e41193221..a09beb9cd 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:45](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L45) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L45) Props for the useTextEmbeddings hook. @@ -10,7 +10,7 @@ Props for the useTextEmbeddings hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L46) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L46) An object containing the model and tokenizer sources. @@ -28,6 +28,6 @@ An object containing the model and tokenizer sources. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L50) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L50) 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 7d30d3bc7..7c201807c 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) React hook state and methods for managing a Text Embeddings model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Text Embeddings model instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) Tracks the progress of the model download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the model download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) Contains the error message if the model failed to load or during inference. @@ -30,7 +30,7 @@ Contains the error message if the model failed to load or during inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) Indicates whether the model is currently generating embeddings. @@ -40,7 +40,7 @@ Indicates whether the model is currently generating embeddings. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) Indicates whether the embeddings model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the embeddings model has successfully loaded and is ready for > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) Runs the text embeddings model on the provided input string. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageParams.md b/docs/docs/06-api-reference/interfaces/TextToImageParams.md index d2b008406..9a7b3fcad 100644 --- a/docs/docs/06-api-reference/interfaces/TextToImageParams.md +++ b/docs/docs/06-api-reference/interfaces/TextToImageParams.md @@ -1,6 +1,6 @@ # Interface: TextToImageParams -Defined in: [packages/react-native-executorch/src/types/tti.ts:7](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L7) +Defined in: [packages/react-native-executorch/src/types/tti.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L7) Configuration properties for the `useTextToImage` hook. @@ -10,7 +10,7 @@ Configuration properties for the `useTextToImage` hook. > `optional` **inferenceCallback**: (`stepIdx`) => `void` -Defined in: [packages/react-native-executorch/src/types/tti.ts:29](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L29) +Defined in: [packages/react-native-executorch/src/types/tti.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L29) Optional callback function that is triggered after each diffusion inference step. Useful for updating a progress bar during image generation. @@ -33,7 +33,7 @@ The index of the current inference step. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/tti.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L11) +Defined in: [packages/react-native-executorch/src/types/tti.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L11) Object containing the required model sources for the diffusion pipeline. @@ -73,7 +73,7 @@ Source for the UNet (noise predictor) model binary. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:35](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L35) +Defined in: [packages/react-native-executorch/src/types/tti.ts:35](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L35) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageType.md b/docs/docs/06-api-reference/interfaces/TextToImageType.md index 5e9be3a93..dee5ca206 100644 --- a/docs/docs/06-api-reference/interfaces/TextToImageType.md +++ b/docs/docs/06-api-reference/interfaces/TextToImageType.md @@ -1,6 +1,6 @@ # Interface: TextToImageType -Defined in: [packages/react-native-executorch/src/types/tti.ts:42](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L42) +Defined in: [packages/react-native-executorch/src/types/tti.ts:42](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L42) Return type for the `useTextToImage` hook. Manages the state and operations for generating images from text prompts using a diffusion model pipeline. @@ -11,7 +11,7 @@ Manages the state and operations for generating images from text prompts using a > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tti.ts:61](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L61) +Defined in: [packages/react-native-executorch/src/types/tti.ts:61](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L61) Represents the total download progress of all the model binaries combined, as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the total download progress of all the model binaries combined, as a > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tti.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tti.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L46) Contains the error object if any of the pipeline models failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if any of the pipeline models failed to load, download > **generate**: (`input`, `imageSize?`, `numSteps?`, `seed?`) => `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tti.ts:72](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L72) +Defined in: [packages/react-native-executorch/src/types/tti.ts:72](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L72) Runs the diffusion pipeline to generate an image from the provided text prompt. @@ -77,7 +77,7 @@ If the model is not loaded or is currently generating another image. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/tti.ts:82](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L82) +Defined in: [packages/react-native-executorch/src/types/tti.ts:82](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L82) Interrupts the currently active image generation process at the next available inference step. @@ -91,7 +91,7 @@ Interrupts the currently active image generation process at the next available i > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:56](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L56) +Defined in: [packages/react-native-executorch/src/types/tti.ts:56](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L56) Indicates whether the model is currently generating an image. @@ -101,6 +101,6 @@ Indicates whether the model is currently generating an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:51](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tti.ts#L51) +Defined in: [packages/react-native-executorch/src/types/tti.ts:51](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L51) Indicates whether the entire diffusion pipeline is loaded into memory and ready for generation. diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md index 9a276e1c1..b423a03dc 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:56](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L56) +Defined in: [packages/react-native-executorch/src/types/tts.ts:56](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L56) General Text to Speech module configuration @@ -14,7 +14,7 @@ General Text to Speech module configuration > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L57) +Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L57) a selected T2S model @@ -24,6 +24,6 @@ a selected T2S model > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L58) +Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L58) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md index 2787ed0f8..e1a7a1118 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L78) +Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L78) Text to Speech module input definition @@ -14,7 +14,7 @@ Text to Speech module input definition > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L80) +Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L80) optional speed argument - the higher it is, the faster the speech becomes @@ -24,6 +24,6 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L79) +Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L79) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md index bae5356dc..70ba14721 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechProps -Defined in: [packages/react-native-executorch/src/types/tts.ts:68](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L68) +Defined in: [packages/react-native-executorch/src/types/tts.ts:68](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L68) Props for the useTextToSpeech hook. @@ -14,7 +14,7 @@ Props for the useTextToSpeech hook. > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L57) +Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L57) a selected T2S model @@ -28,7 +28,7 @@ a selected T2S model > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:69](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L69) +Defined in: [packages/react-native-executorch/src/types/tts.ts:69](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L69) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. @@ -38,7 +38,7 @@ Boolean that can prevent automatic model loading (and downloading the data if yo > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L58) +Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L58) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md index 2aeaf7674..108fc5109 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechStreamingInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:142](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L142) +Defined in: [packages/react-native-executorch/src/types/tts.ts:142](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L142) Text to Speech streaming input definition @@ -19,7 +19,7 @@ Callbacks can be both synchronous or asynchronous. > `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:143](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L143) +Defined in: [packages/react-native-executorch/src/types/tts.ts:143](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L143) Called when streaming begins @@ -33,7 +33,7 @@ Called when streaming begins > `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:145](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L145) +Defined in: [packages/react-native-executorch/src/types/tts.ts:145](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L145) Called when streaming ends @@ -47,7 +47,7 @@ Called when streaming ends > `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:144](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L144) +Defined in: [packages/react-native-executorch/src/types/tts.ts:144](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L144) Called after each audio chunk gets calculated. @@ -67,7 +67,7 @@ Called after each audio chunk gets calculated. > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L80) +Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L80) optional speed argument - the higher it is, the faster the speech becomes @@ -81,7 +81,7 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L79) +Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L79) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md index 6d2f8351d..3efd004c4 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechType -Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L87) +Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L87) Return type for the `useTextToSpeech` hook. Manages the state and operations for Text-to-Speech generation. @@ -11,7 +11,7 @@ Manages the state and operations for Text-to-Speech generation. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:106](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L106) +Defined in: [packages/react-native-executorch/src/types/tts.ts:106](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L106) Represents the download progress of the model and voice assets as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model and voice assets as a value betwee > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tts.ts:91](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L91) +Defined in: [packages/react-native-executorch/src/types/tts.ts:91](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L91) Contains the error object if the model failed to load or encountered an error during inference. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load or encountered an error du > **forward**: (`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L114) +Defined in: [packages/react-native-executorch/src/types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L114) Runs the model to convert the provided text into speech audio in a single pass. * @@ -60,7 +60,7 @@ If the model is not loaded or is currently generating. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:101](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L101) +Defined in: [packages/react-native-executorch/src/types/tts.ts:101](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L101) Indicates whether the model is currently generating audio. @@ -70,7 +70,7 @@ Indicates whether the model is currently generating audio. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:96](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L96) +Defined in: [packages/react-native-executorch/src/types/tts.ts:96](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L96) Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. @@ -80,7 +80,7 @@ Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. > **stream**: (`input`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:123](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L123) +Defined in: [packages/react-native-executorch/src/types/tts.ts:123](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L123) Streams the generated audio data incrementally. This is optimal for real-time playback, allowing audio to start playing before the full text is synthesized. @@ -110,7 +110,7 @@ If the model is not loaded or is currently generating. > **streamStop**: () => `void` -Defined in: [packages/react-native-executorch/src/types/tts.ts:128](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L128) +Defined in: [packages/react-native-executorch/src/types/tts.ts:128](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L128) Interrupts and stops the currently active audio generation stream. diff --git a/docs/docs/06-api-reference/interfaces/TokenizerType.md b/docs/docs/06-api-reference/interfaces/TokenizerType.md index c91c28c58..305229ab7 100644 --- a/docs/docs/06-api-reference/interfaces/TokenizerType.md +++ b/docs/docs/06-api-reference/interfaces/TokenizerType.md @@ -1,6 +1,6 @@ # Interface: TokenizerType -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L6) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L6) React hook state and methods for managing a Tokenizer instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Tokenizer instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L25) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L25) Tracks the progress of the tokenizer download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the tokenizer download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L10) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L10) Contains the error message if the tokenizer failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the tokenizer failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L20) Indicates whether the tokenizer is currently processing data. @@ -40,7 +40,7 @@ Indicates whether the tokenizer is currently processing data. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L15) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L15) Indicates whether the tokenizer has successfully loaded and is ready for use. @@ -50,7 +50,7 @@ Indicates whether the tokenizer has successfully loaded and is ready for use. > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:33](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L33) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:33](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L33) Converts an array of token IDs into a string. @@ -80,7 +80,7 @@ A promise resolving to the decoded text string. > **encode**(`text`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L40) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L40) Converts a string into an array of token IDs. @@ -104,7 +104,7 @@ A promise resolving to an array `number[]` containing the encoded token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L46) Returns the size of the tokenizer's vocabulary. @@ -120,7 +120,7 @@ A promise resolving to the vocabulary size. > **idToToken**(`id`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:53](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L53) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:53](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L53) Returns the token associated to the ID. @@ -144,7 +144,7 @@ A promise resolving to the token string representation. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tokenizer.ts#L60) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L60) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md index 22b083e9b..400532b94 100644 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -1,6 +1,6 @@ # Interface: ToolCall -Defined in: [packages/react-native-executorch/src/types/llm.ts:152](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L152) +Defined in: [packages/react-native-executorch/src/types/llm.ts:152](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L152) Represents a tool call made by the model. @@ -10,7 +10,7 @@ Represents a tool call made by the model. > **arguments**: `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L154) +Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L154) The arguments passed to the tool. @@ -20,6 +20,6 @@ The arguments passed to the tool. > **toolName**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:153](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L153) +Defined in: [packages/react-native-executorch/src/types/llm.ts:153](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L153) The name of the tool being called. diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md index ec31c2026..6354840b0 100644 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -1,6 +1,6 @@ # Interface: ToolsConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:181](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L181) +Defined in: [packages/react-native-executorch/src/types/llm.ts:181](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L181) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. @@ -10,7 +10,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > `optional` **displayToolCalls**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L184) +Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L184) If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. @@ -20,7 +20,7 @@ If set to true, JSON tool calls will be displayed in chat. If false, only answer > **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L183) +Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L183) Function that accepts `ToolCall`, executes tool and returns the string to model. @@ -40,6 +40,6 @@ Function that accepts `ToolCall`, executes tool and returns the string to model. > **tools**: `Object`[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:182](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L182) +Defined in: [packages/react-native-executorch/src/types/llm.ts:182](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L182) List of objects defining tools. diff --git a/docs/docs/06-api-reference/interfaces/VADProps.md b/docs/docs/06-api-reference/interfaces/VADProps.md index 8464fb23b..017fd75db 100644 --- a/docs/docs/06-api-reference/interfaces/VADProps.md +++ b/docs/docs/06-api-reference/interfaces/VADProps.md @@ -1,6 +1,6 @@ # Interface: VADProps -Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L11) +Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L11) Props for the useVAD hook. @@ -10,7 +10,7 @@ Props for the useVAD hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L12) +Defined in: [packages/react-native-executorch/src/types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L13) +Defined in: [packages/react-native-executorch/src/types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/VADType.md b/docs/docs/06-api-reference/interfaces/VADType.md index 8c24e85a7..1d8e6682a 100644 --- a/docs/docs/06-api-reference/interfaces/VADType.md +++ b/docs/docs/06-api-reference/interfaces/VADType.md @@ -1,6 +1,6 @@ # Interface: VADType -Defined in: [packages/react-native-executorch/src/types/vad.ts:30](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L30) +Defined in: [packages/react-native-executorch/src/types/vad.ts:30](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L30) React hook state and methods for managing a Voice Activity Detection (VAD) model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Voice Activity Detection (VAD) model > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:49](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L49) +Defined in: [packages/react-native-executorch/src/types/vad.ts:49](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L49) Represents the download progress as a value between 0 and 1. @@ -20,7 +20,7 @@ Represents the download progress as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L34) +Defined in: [packages/react-native-executorch/src/types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L34) Contains the error message if the VAD model failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the VAD model failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:44](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L44) +Defined in: [packages/react-native-executorch/src/types/vad.ts:44](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L44) Indicates whether the model is currently processing an inference. @@ -40,7 +40,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:39](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L39) +Defined in: [packages/react-native-executorch/src/types/vad.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L39) Indicates whether the VAD model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the VAD model has successfully loaded and is ready for inferen > **forward**(`waveform`): `Promise`\<[`Segment`](Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/types/vad.ts:57](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/vad.ts#L57) +Defined in: [packages/react-native-executorch/src/types/vad.ts:57](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L57) Runs the Voice Activity Detection model on the provided audio waveform. diff --git a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md index 1853f2bb2..43435d73c 100644 --- a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md +++ b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md @@ -1,6 +1,6 @@ # Interface: VerticalOCRProps -Defined in: [packages/react-native-executorch/src/types/ocr.ts:64](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L64) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:64](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L64) Configuration properties for the `useVerticalOCR` hook. @@ -14,7 +14,7 @@ Configuration properties for the `useVerticalOCR` hook. > `optional` **independentCharacters**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:69](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L69) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:69](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L69) Boolean indicating whether to treat each character independently during recognition. Defaults to `false`. @@ -25,7 +25,7 @@ Defaults to `false`. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L37) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L37) Object containing the necessary model sources and configuration for the OCR pipeline. @@ -57,7 +57,7 @@ The language configuration enum for the OCR model (e.g., English, Polish, etc.). > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L58) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L58) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/VoiceConfig.md b/docs/docs/06-api-reference/interfaces/VoiceConfig.md index a09f1f9d2..501cd2b54 100644 --- a/docs/docs/06-api-reference/interfaces/VoiceConfig.md +++ b/docs/docs/06-api-reference/interfaces/VoiceConfig.md @@ -1,6 +1,6 @@ # Interface: VoiceConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L18) +Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L18) Voice configuration @@ -12,7 +12,7 @@ So far in Kokoro, each voice is directly associated with a language. > `optional` **extra**: [`KokoroVoiceExtras`](KokoroVoiceExtras.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L21) +Defined in: [packages/react-native-executorch/src/types/tts.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L21) an optional extra sources or properties related to specific voice @@ -22,7 +22,7 @@ an optional extra sources or properties related to specific voice > **lang**: [`TextToSpeechLanguage`](../type-aliases/TextToSpeechLanguage.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L19) +Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L19) speaker's language @@ -32,6 +32,6 @@ speaker's language > **voiceSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L20) a source to a binary file with voice embedding diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md index 01984d53f..6abc9796a 100644 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -2,4 +2,4 @@ > **LLMTool** = `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:159](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L159) +Defined in: [packages/react-native-executorch/src/types/llm.ts:159](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L159) diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md index 88a6c4845..90f5665ef 100644 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -2,6 +2,6 @@ > **MessageRole** = `"user"` \| `"assistant"` \| `"system"` -Defined in: [packages/react-native-executorch/src/types/llm.ts:133](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L133) +Defined in: [packages/react-native-executorch/src/types/llm.ts:133](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L133) Roles that a message sender can have. diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md index b87665a9a..1fa3e3c70 100644 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -2,6 +2,6 @@ > **OCRLanguage** = keyof *typeof* `symbols` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:109](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/ocr.ts#L109) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:109](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L109) Enumeration of supported OCR languages based on available symbol sets. diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md index 0714e4990..222d1a151 100644 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -2,6 +2,6 @@ > **ResourceSource** = `string` \| `number` \| `object` -Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L8) +Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L8) Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md index 01b1b2faf..3a7e2c1e4 100644 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -2,4 +2,4 @@ > **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/stt.ts#L87) +Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L87) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md index cf8d753c5..0465d7310 100644 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -2,6 +2,6 @@ > **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` -Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/common.ts#L41) +Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L41) Represents the data buffer of a tensor, which can be one of several typed array formats. diff --git a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md index edb2a3313..e80668111 100644 --- a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md @@ -2,4 +2,4 @@ > **TextToSpeechLanguage** = `"en-us"` \| `"en-gb"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:5](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/tts.ts#L5) +Defined in: [packages/react-native-executorch/src/types/tts.ts:5](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L5) 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 0debd519f..03a244767 100644 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MINILM\_L6\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L408) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L408) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md index 713273235..961de5037 100644 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MPNET\_BASE\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L413) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L413) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md index b96b5758d..d8f90c883 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_256**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L442) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L442) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index 00719920c..629ac9c94 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_512**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L434) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L434) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index 896365d8d..fa0ebd271 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_IMAGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md index b312b5d19..3bc003a7b 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_TEXT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L428) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L428) ## 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 4340ebe0a..c5b72259f 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: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L385) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L385) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md index 2625b923d..2d5db19d0 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_CHAT\_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md index f261d6127..3ac239dd3 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_CONTEXT\_WINDOW\_LENGTH**: `5` = `5` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md index 53737f1e5..e4f9ffecb 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_MESSAGE\_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md index 787e3c8da..f64365f89 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -2,4 +2,4 @@ > `const` **DEFAULT\_SYSTEM\_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) 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 d8c0bceda..217d60708 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -2,7 +2,7 @@ > `const` **EFFICIENTNET\_V2\_S**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L260) ## 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 52545bd7b..e53edeb21 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -2,7 +2,7 @@ > `const` **FSMN\_VAD**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L453) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L453) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md index c3b43a5ae..73a8cc39f 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L108) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L108) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md index 6bdb2b9d2..6894487ad 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L114) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L114) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md index 49c462160..a7600c5b0 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L120) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L120) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md index 6636e75ad..6f63d298c 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L126) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L126) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md index 409366b9d..2978373e3 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L132) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L132) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md index 26e4b977a..24bd67826 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L138) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L138) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md index cc409292f..1729438ba 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_MEDIUM**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/models.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/models.ts#L22) A standard Kokoro instance which processes the text in batches of maximum 128 tokens. diff --git a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md index 4cac0e28b..fe69659dc 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/models.ts#L13) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/models.ts#L13) A Kokoro model instance which processes the text in batches of maximum 64 tokens. Uses significant less memory than the medium model, but could produce diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md index a88ec622c..0479afa0e 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_HEART**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L21) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md index 04011a5d6..fb049b869 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_RIVER**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L26) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L26) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md index d092c0a81..363085831 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_SARAH**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L31) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L31) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md index 3aa069ef5..49dc6f9ab 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_ADAM**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L36) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L36) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md index 30592e17a..4652f5732 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_MICHAEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L41) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md index ee775b3c6..e46728035 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_SANTA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L46) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md index bc8cb5e30..eaaf952ab 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BF\_EMMA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L51) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L51) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md index 66f0aa6d0..725471a8e 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BM\_DANIEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/tts/voices.ts#L56) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L56) 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 30c3fc78b..657735992 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L34) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L34) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md index 77db91eae..88495bf03 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L40) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L40) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md index 48ecfd704..ca5a96c38 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L46) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md index 6bc5d5b77..85a845ec1 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L16) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L16) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md index 563b382df..057d46cb9 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L22) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md index b376a2d0b..65ed4d2b6 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L28) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L28) ## 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 3d3cfcbfc..d18bc7cd2 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MINILM\_L6\_COS\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L418) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L418) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md index ef809b82e..18a957970 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MPNET\_BASE\_DOT\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md index 082d573e2..4c2b0934d 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L41) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md index e70d933fa..763fedd92 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L47) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L47) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md index f9fa0f8f8..9e4339c96 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L53) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L53) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md index 3ba1f2921..c8c782200 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L362) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L362) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md index 3f71bd4cf..54a356b1e 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L59) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L59) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md index 88fe44ce6..68f3cb17a 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L65) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L65) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md index 4e59d6f1c..67a2d2651 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L71) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L71) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md index 79a0fae96..663a5338c 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L83) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L83) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md index 5a2b9596b..c79c6e870 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L77) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L77) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md index 8c05f59a2..fada7875b 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L98) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L98) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md index 218017501..1f1ee45d8 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L164) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L164) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md index 2a96820d7..889b2cc6e 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L104) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L104) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md index 27f3157bf..084d478f4 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L116) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L116) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md index 6727e6caa..c3cbe8ecc 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L122) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L122) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md index f0efe95a8..eb7eef1ed 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L284) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md index 56861e6c4..59b7b0b7d 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L134) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L134) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md index 8b96d1a9e..39702d4c4 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L146) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L146) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md index a6f645f4d..3e85b31aa 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L152) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L152) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md index 51070f2c8..9118243b7 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L128) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L128) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md index b365db1ff..f31c99172 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L170) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L170) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md index 134ff7ab5..9928b477f 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L188) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L188) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md index 81f150d2a..563e02c21 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L176) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L176) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md index f5ed121e2..42eaf6cf2 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L182) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L182) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md index 526ccb92d..6ea0fa771 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L158) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L158) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md index 40a9ce80d..6b67279b5 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L194) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L194) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md index 2c5b2f73b..da0192001 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md index c75c259d2..06b034e62 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md index ae53df63f..6c8410fd9 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md index e91e8e78e..1224d71f0 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md index d2344b7ba..97fda3225 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md index 3b2f98259..18f46a853 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L236) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L236) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md index 06e5147d6..95858dd22 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md index 367070c0d..058286756 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L254) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L254) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md index a47824077..af71ec53b 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md index 60731589f..6b79914cb 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md index dfc0fb23d..4a448645a 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L272) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L272) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md index 1f50686e2..fb1b591a5 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L278) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L278) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md index 89cbc8c7f..7c6093790 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L260) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md index 355ccc987..e3bbd6463 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L266) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L266) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md index 513367a75..599f08661 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L290) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L290) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md index 3b8b9074e..14849ff3b 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L296) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L296) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md index e6ebbe6f3..59cc4d4b7 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L302) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md index 713b968ff..d4d050d66 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L308) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L308) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md index 50335d017..a4617209e 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L314) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L314) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md index 1370df61d..3e934614c 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L320) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L320) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md index 3502ecaf8..3ef0e9a29 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L326) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L326) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md index d71002412..f35673979 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L332) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L332) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md index 83917b81c..f20421131 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L341) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L341) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md index 89afdcf9d..151d9333a 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L89) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L89) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md index 77b128985..e3055f62b 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L350) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L350) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md index f1f3a6800..bda4f5cdd 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L356) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L356) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md index 25ae2e260..0d80c21f3 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L140) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L140) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md index f594f2533..f587ea388 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L374) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L374) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md index b92e5963b..a099db354 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md index f4ad71166..bd67b978f 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L380) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L380) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md index 8d5dc301a..172dcf90c 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L398) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L398) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md index 6037db84f..f98afe9e7 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md index 6edac617b..8776a1192 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L386) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L386) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md index f54a0d674..7094d3c1b 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L404) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L404) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md index 25b457a52..bd162681b 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L410) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L410) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md index 73a3f827b..19360f419 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L416) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L416) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md index ea5dcde82..6acf0d26b 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L422) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L422) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md index 6b7c63a1c..31867f210 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L110) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L110) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md index 14fdcd34a..516666e7e 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md index 744d6c429..759a6cb47 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md index ca1370696..8ccfefb2b 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md index f0d97bfb8..0eb61c045 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md index b3f71c193..3ea925143 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md index 5f6111226..52b70043b 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md index 22fb424ff..3eedcaaab 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md index 4195fc356..449e6abfd 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md index f688f045d..2ff5476cb 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L62) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L62) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md index 39fd64a7d..1ff92ba53 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L68) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L68) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md index 3ae971c7c..92c036106 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L74) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L74) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md index 10730b6d6..f15a3c73d 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L80) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L80) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index de16d8979..a902df578 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L86) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L86) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md index 35dd40f6e..0525e65d2 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L92) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L92) ## 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 a94d29180..27a0f93ad 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L154) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L154) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md index 226dc4680..52434e3aa 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L160) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L160) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md index b707d5db3..bc5f48271 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L178) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L178) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md index 9ebdf8a5f..94390d03e 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L184) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L184) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md index 295ffdd89..5f0f59c6f 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L166) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L166) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md index 9c2690b0e..63a41d066 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L172) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L172) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md index dcb31687d..08e8799a1 100644 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -2,7 +2,7 @@ > `const` **SPECIAL\_TOKENS**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:202](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/types/llm.ts#L202) +Defined in: [packages/react-native-executorch/src/types/llm.ts:202](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L202) ## Type Declaration 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 936c9dba5..d2fe5c90b 100644 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `const` **SSDLITE\_320\_MOBILENET\_V3\_LARGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L267) ## 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 1668c7cbb..5ca9786da 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_CANDY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L289) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L289) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md index 58445ab8e..f90bb9fd6 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_MOSAIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L293) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L293) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md index b97908551..2b915cac5 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_RAIN\_PRINCESS**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md index 691e3e40e..b9677f850 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_UDNIE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L301) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L301) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md index a53dcb944..bf36e3b4c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L42) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L42) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md index cac8d0722..6e6c30701 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L48) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L48) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md index 46d667a4e..72b515c91 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L54) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L54) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md index c61458fa5..99c611ca9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L363) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L363) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md index 588dd50fc..0bf26aa2d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L60) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L60) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md index 17f461bc3..bcb5ea577 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L66) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L66) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md index ec0a7f06e..ace29f99b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L72) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L72) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md index c77e43769..309934de9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L84) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L84) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md index 7272d35bb..b6bf2b83d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L78) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L78) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md index 7f818e55d..75aa7904a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L99) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L99) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md index 64cd953d9..a4b879a65 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L165) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L165) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md index 33bccb2f9..409bb16a8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L105) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L105) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md index d39b51aed..51fa69ae3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L117) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L117) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md index 5f473963b..5cda0fc80 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L123) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L123) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md index 639bd73c7..907c56b9e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L285) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L285) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md index b44a9b13d..d8b97097e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L135) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L135) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md index cabaa4e35..0c7ba8517 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L147) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L147) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md index 33f940668..84add4d1d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L153) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L153) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md index c5670ebbc..53df487d9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L129) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L129) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md index 21f34f561..fe7193f4a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L171) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L171) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md index 9681cf6e7..7e05b2df9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L189) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L189) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md index 1f76e9bc6..8240a8243 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L177) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L177) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md index d2c7c049a..ec4f0f173 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L183) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L183) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md index 33ab3cf3d..1b2e45ab0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L159) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L159) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md index 0888df169..833c7c052 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L195) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L195) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md index d0a0a8f3b..5bb22d0ab 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L201) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L201) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md index 2371a0ad7..b15e9c4de 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L213) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L213) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md index be55f1ccc..849faad42 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L207) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L207) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md index 7d73c4f9d..5d422cf26 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L219) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L219) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md index fbbf34a3e..d3ebe60d9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L225) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L225) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md index 1e3004a70..c752d3125 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L237) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L237) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md index f142bb111..4d5596c0c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L231) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L231) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md index 69bbf0b7b..87b508d2e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L255) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L255) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md index 090a322e2..3ba0f0b48 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L243) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L243) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md index f42c7df30..4a2dfe1e1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L249) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L249) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md index c0e2c2b31..27bdd5e12 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L273) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L273) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md index c066b6af6..061b510d1 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L279) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L279) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md index d55c3ab62..88643f94a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L261) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L261) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md index b85f8b7e7..de1ed3161 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L267) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md index d141ac7cd..0694d9f0f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L291) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L291) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md index 96f223fe1..6dae18aec 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md index f93fb7088..a5172b473 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L303) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L303) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md index dc5757f77..26c052990 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L309) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L309) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md index 42e689d9e..e2a67a61d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L315) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L315) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md index 086e6b851..b7abc31bd 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L321) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L321) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md index 9272d90a3..ae2d5887a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L327) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L327) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md index da34c72bd..1901edb1c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L336) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L336) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md index 19344c71d..458dcb1b9 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L345) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L345) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md index a982e0a74..8862d5e6b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L93) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L93) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md index a1fad863d..c2a744ea3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L351) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L351) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md index 865d11730..8588e9d0c 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L357) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L357) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md index 0b45d3f79..b48506347 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L141) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L141) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md index a04e56cba..1bc36e48d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md index 2847ba10e..5cde0e029 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L369) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L369) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md index 776f62b2d..eebae30b5 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L381) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L381) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md index 36d26c644..76035f70b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L399) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L399) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md index b7c0e555f..b11464f5e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L393) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L393) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md index e4d5ebc8d..ad1a34ac2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L387) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L387) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md index 777b38e1d..51abd6e86 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L405) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L405) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md index eed3d700b..b9afdef40 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L411) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L411) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md index 6ebac234e..29dd37960 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L417) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L417) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md index 5de114587..e747aa76d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md index 88618b141..960e7dcd2 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/ocr/models.ts#L111) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L111) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md index 46b5874d0..29f055ccd 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md index d41357628..79447d772 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L347) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L347) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md index 630890b83..c03fece88 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md index 1e32fd83f..ff6c8919c 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L354) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L354) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md index 8716c159d..23fd86a13 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L361) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L361) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md index dd3bc373a..c81ec5090 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L333) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L333) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md index cb1df265b..24263911b 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/constants/modelUrls.ts#L340) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L340) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md index fb935f276..fc6e92a23 100644 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -2,7 +2,7 @@ > `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] -Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/81b229bbed784732fe329dbbff41e28b06bdb54d/packages/react-native-executorch/src/utils/llm.ts#L9) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/llm.ts#L9) ## Parameters 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 6ca6ea3b9..f61ab693b 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts @@ -4,7 +4,16 @@ import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; import { BaseModule } from '../BaseModule'; +/** + * Module for generating image embeddings from input images. + */ export class ImageEmbeddingsModule extends BaseModule { + /** + * Loads the model, where `modelSource` is a string that specifies the location of the model binary. + * + * @param model - Object containing `modelSource`. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( model: { modelSource: ResourceSource }, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -22,6 +31,12 @@ export class ImageEmbeddingsModule extends BaseModule { this.nativeModule = global.loadImageEmbeddings(paths[0] || ''); } + /** + * Executes the model's forward pass, where `imageSource` is a URI/URL to image that will be embedded. + * + * @param imageSource - The image source to be embedded. + * @returns A Float32Array containing the image embeddings. + */ async forward(imageSource: string): Promise { if (this.nativeModule == null) throw new RnExecutorchError( diff --git a/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts index d964f530d..73bfa62cf 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts @@ -5,7 +5,18 @@ import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; import { BaseModule } from '../BaseModule'; +/** + * Module for image segmentation tasks. + */ export class ImageSegmentationModule extends BaseModule { + + /** + * 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`. + * + * @param model - Object containing `modelSource`. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( model: { modelSource: ResourceSource }, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -23,11 +34,19 @@ export class ImageSegmentationModule extends BaseModule { this.nativeModule = global.loadImageSegmentation(paths[0] || ''); } + /** + * Executes the model's forward pass + * + * @param imageSource - a fetchable resource or a Base64-encoded string. + * @param classesOfInterest - an optional list of DeeplabLabel used to indicate additional arrays of probabilities to output (see section "Running the model"). The default is an empty list. + * @param resize - an optional boolean to indicate whether the output should be resized to the original image dimensions, or left in the size of the model (see section "Running the model"). The default is `false`. + * @returns A dictionary where keys are `DeeplabLabel` and values are arrays of probabilities for each pixel belonging to the corresponding class. + */ async forward( imageSource: string, classesOfInterest?: DeeplabLabel[], resize?: boolean - ): Promise<{ [key in DeeplabLabel]?: number[] }> { + ): Promise>> { if (this.nativeModule == null) { throw new RnExecutorchError( RnExecutorchErrorCode.ModuleNotLoaded, diff --git a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts b/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts index ac4e2e2ff..f914a00e6 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts @@ -9,6 +9,14 @@ export class OCRModule { this.controller = new OCRController(); } + /** + * Loads the model, where `detectorSource` is a string that specifies the location of the detector binary, + * `recognizerSource` is a string that specifies the location of the recognizer binary, + * and `language` is a parameter that specifies the language of the text to be recognized by the OCR. + * + * @param model - Object containing `detectorSource`, `recognizerSource`, and `language`. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( model: { detectorSource: ResourceSource; @@ -25,10 +33,20 @@ export class OCRModule { ); } + /** + * Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. + * + * @param imageSource - The image source to be processed. + * @returns The OCR result as a string. + */ async forward(imageSource: string) { return await this.controller.forward(imageSource); } + /** + * Release the memory held by the module. Calling `forward` afterwards is invalid. + * Note that you cannot delete model while it's generating. + */ delete() { this.controller.delete(); } diff --git a/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts index dde5d2233..b3763f3c1 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts @@ -5,7 +5,18 @@ import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; import { BaseModule } from '../BaseModule'; +/** + * Module for object detection tasks. + */ export class ObjectDetectionModule extends BaseModule { + + /** + * 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`. + * + * @param model - Object containing `modelSource`. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( model: { modelSource: ResourceSource }, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -23,6 +34,14 @@ export class ObjectDetectionModule extends BaseModule { this.nativeModule = global.loadObjectDetection(paths[0] || ''); } + /** + * Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. + * `detectionThreshold` can be supplied to alter the sensitivity of the detection. + * + * @param imageSource - The image source to be processed. + * @param detectionThreshold - The threshold for detection sensitivity. Default is 0.7. + * @returns An array of Detection objects representing detected items in the image. + */ async forward( imageSource: string, detectionThreshold: number = 0.7 From 41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Wed, 28 Jan 2026 11:14:21 +0100 Subject: [PATCH 14/15] Added all of the modules to autogenerated docs --- .../classes/ClassificationModule.md | 14 +- .../classes/ExecutorchModule.md | 14 +- .../classes/ImageEmbeddingsModule.md | 14 +- .../classes/ImageSegmentationModule.md | 14 +- .../06-api-reference/classes/LLMModule.md | 24 +-- .../06-api-reference/classes/OCRModule.md | 10 +- .../classes/ObjectDetectionModule.md | 14 +- .../classes/ResourceFetcher.md | 20 +- .../classes/RnExecutorchError.md | 8 +- .../classes/SpeechToTextModule.md | 18 +- .../classes/StyleTransferModule.md | 29 ++- .../classes/TextEmbeddingsModule.md | 14 +- .../classes/TextToImageModule.md | 45 ++++- .../classes/TextToSpeechModule.md | 14 +- .../classes/TokenizerModule.md | 16 +- .../06-api-reference/classes/VADModule.md | 14 +- .../classes/VerticalOCRModule.md | 29 ++- .../enumerations/CocoLabel.md | 182 +++++++++--------- .../enumerations/DeeplabLabel.md | 48 ++--- .../enumerations/RnExecutorchErrorCode.md | 124 +++++++----- .../enumerations/ScalarType.md | 90 ++++++--- .../DEFAULT_STRUCTURED_OUTPUT_PROMPT.md | 8 +- .../fixAndValidateStructuredOutput.md | 10 +- .../functions/getStructuredOutputPrompt.md | 8 +- .../functions/useClassification.md | 2 +- .../functions/useExecutorchModule.md | 2 +- .../functions/useImageEmbeddings.md | 2 +- .../functions/useImageSegmentation.md | 2 +- .../docs/06-api-reference/functions/useLLM.md | 2 +- .../docs/06-api-reference/functions/useOCR.md | 2 +- .../functions/useObjectDetection.md | 2 +- .../functions/useSpeechToText.md | 2 +- .../functions/useStyleTransfer.md | 2 +- .../functions/useTextEmbeddings.md | 2 +- .../functions/useTextToImage.md | 2 +- .../functions/useTextToSpeech.md | 2 +- .../functions/useTokenizer.md | 2 +- .../docs/06-api-reference/functions/useVAD.md | 2 +- .../functions/useVerticalOCR.md | 2 +- docs/docs/06-api-reference/interfaces/Bbox.md | 10 +- .../06-api-reference/interfaces/ChatConfig.md | 8 +- .../interfaces/ClassificationProps.md | 6 +- .../interfaces/ClassificationType.md | 12 +- .../interfaces/DecodingOptions.md | 4 +- .../06-api-reference/interfaces/Detection.md | 8 +- .../interfaces/ExecutorchModuleProps.md | 6 +- .../interfaces/ExecutorchModuleType.md | 12 +- .../interfaces/GenerationConfig.md | 10 +- .../interfaces/ImageEmbeddingsProps.md | 6 +- .../interfaces/ImageEmbeddingsType.md | 12 +- .../interfaces/ImageSegmentationProps.md | 6 +- .../interfaces/ImageSegmentationType.md | 12 +- .../interfaces/KokoroConfig.md | 8 +- .../interfaces/KokoroVoiceExtras.md | 6 +- .../06-api-reference/interfaces/LLMConfig.md | 8 +- .../06-api-reference/interfaces/LLMType.md | 28 +-- .../06-api-reference/interfaces/Message.md | 6 +- .../interfaces/OCRDetection.md | 8 +- .../06-api-reference/interfaces/OCRProps.md | 6 +- .../06-api-reference/interfaces/OCRType.md | 12 +- .../interfaces/ObjectDetectionProps.md | 6 +- .../interfaces/ObjectDetectionType.md | 12 +- .../docs/06-api-reference/interfaces/Point.md | 6 +- .../06-api-reference/interfaces/Segment.md | 6 +- .../interfaces/SpeechToTextModelConfig.md | 10 +- .../interfaces/SpeechToTextType.md | 26 +-- .../interfaces/StyleTransferProps.md | 6 +- .../interfaces/StyleTransferType.md | 12 +- .../06-api-reference/interfaces/TensorPtr.md | 8 +- .../interfaces/TextEmbeddingsProps.md | 6 +- .../interfaces/TextEmbeddingsType.md | 12 +- .../interfaces/TextToImageParams.md | 8 +- .../interfaces/TextToImageType.md | 14 +- .../interfaces/TextToSpeechConfig.md | 6 +- .../interfaces/TextToSpeechInput.md | 6 +- .../interfaces/TextToSpeechProps.md | 8 +- .../interfaces/TextToSpeechStreamingInput.md | 12 +- .../interfaces/TextToSpeechType.md | 16 +- .../interfaces/TokenizerType.md | 20 +- .../06-api-reference/interfaces/ToolCall.md | 6 +- .../interfaces/ToolsConfig.md | 8 +- .../06-api-reference/interfaces/VADProps.md | 6 +- .../06-api-reference/interfaces/VADType.md | 12 +- .../interfaces/VerticalOCRProps.md | 8 +- .../interfaces/VoiceConfig.md | 8 +- .../06-api-reference/type-aliases/LLMTool.md | 6 +- .../type-aliases/MessageRole.md | 2 +- .../type-aliases/OCRLanguage.md | 2 +- .../type-aliases/ResourceSource.md | 2 +- .../type-aliases/SpeechToTextLanguage.md | 2 +- .../type-aliases/TensorBuffer.md | 2 +- .../type-aliases/TextToSpeechLanguage.md | 2 +- .../variables/ALL_MINILM_L6_V2.md | 2 +- .../variables/ALL_MPNET_BASE_V2.md | 2 +- .../variables/BK_SDM_TINY_VPRED_256.md | 2 +- .../variables/BK_SDM_TINY_VPRED_512.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 2 +- .../variables/DEEPLAB_V3_RESNET50.md | 2 +- .../variables/DEFAULT_CHAT_CONFIG.md | 4 +- .../DEFAULT_CONTEXT_WINDOW_LENGTH.md | 4 +- .../variables/DEFAULT_MESSAGE_HISTORY.md | 4 +- .../variables/DEFAULT_SYSTEM_PROMPT.md | 4 +- .../variables/EFFICIENTNET_V2_S.md | 2 +- .../06-api-reference/variables/FSMN_VAD.md | 2 +- .../variables/HAMMER2_1_0_5B.md | 2 +- .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_1_5B.md | 2 +- .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_3B.md | 2 +- .../variables/HAMMER2_1_3B_QUANTIZED.md | 2 +- .../variables/KOKORO_MEDIUM.md | 2 +- .../variables/KOKORO_SMALL.md | 2 +- .../variables/KOKORO_VOICE_AF_HEART.md | 2 +- .../variables/KOKORO_VOICE_AF_RIVER.md | 2 +- .../variables/KOKORO_VOICE_AF_SARAH.md | 2 +- .../variables/KOKORO_VOICE_AM_ADAM.md | 2 +- .../variables/KOKORO_VOICE_AM_MICHAEL.md | 2 +- .../variables/KOKORO_VOICE_AM_SANTA.md | 2 +- .../variables/KOKORO_VOICE_BF_EMMA.md | 2 +- .../variables/KOKORO_VOICE_BM_DANIEL.md | 2 +- .../06-api-reference/variables/LLAMA3_2_1B.md | 2 +- .../variables/LLAMA3_2_1B_QLORA.md | 2 +- .../variables/LLAMA3_2_1B_SPINQUANT.md | 2 +- .../06-api-reference/variables/LLAMA3_2_3B.md | 2 +- .../variables/LLAMA3_2_3B_QLORA.md | 2 +- .../variables/LLAMA3_2_3B_SPINQUANT.md | 2 +- .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 2 +- .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 2 +- .../06-api-reference/variables/OCR_ABAZA.md | 2 +- .../06-api-reference/variables/OCR_ADYGHE.md | 2 +- .../variables/OCR_AFRIKAANS.md | 2 +- .../variables/OCR_ALBANIAN.md | 2 +- .../06-api-reference/variables/OCR_AVAR.md | 2 +- .../variables/OCR_AZERBAIJANI.md | 2 +- .../variables/OCR_BELARUSIAN.md | 2 +- .../06-api-reference/variables/OCR_BOSNIAN.md | 2 +- .../variables/OCR_BULGARIAN.md | 2 +- .../06-api-reference/variables/OCR_CHECHEN.md | 2 +- .../variables/OCR_CROATIAN.md | 2 +- .../06-api-reference/variables/OCR_CZECH.md | 2 +- .../06-api-reference/variables/OCR_DANISH.md | 2 +- .../06-api-reference/variables/OCR_DARGWA.md | 2 +- .../06-api-reference/variables/OCR_DUTCH.md | 2 +- .../06-api-reference/variables/OCR_ENGLISH.md | 2 +- .../variables/OCR_ESTONIAN.md | 2 +- .../06-api-reference/variables/OCR_FRENCH.md | 2 +- .../06-api-reference/variables/OCR_GERMAN.md | 2 +- .../variables/OCR_HUNGARIAN.md | 2 +- .../variables/OCR_ICELANDIC.md | 2 +- .../variables/OCR_INDONESIAN.md | 2 +- .../06-api-reference/variables/OCR_INGUSH.md | 2 +- .../06-api-reference/variables/OCR_IRISH.md | 2 +- .../06-api-reference/variables/OCR_ITALIAN.md | 2 +- .../variables/OCR_JAPANESE.md | 2 +- .../06-api-reference/variables/OCR_KANNADA.md | 2 +- .../variables/OCR_KARBADIAN.md | 2 +- .../06-api-reference/variables/OCR_KOREAN.md | 2 +- .../06-api-reference/variables/OCR_KURDISH.md | 2 +- .../06-api-reference/variables/OCR_LAK.md | 2 +- .../06-api-reference/variables/OCR_LATIN.md | 2 +- .../06-api-reference/variables/OCR_LATVIAN.md | 2 +- .../variables/OCR_LEZGHIAN.md | 2 +- .../variables/OCR_LITHUANIAN.md | 2 +- .../06-api-reference/variables/OCR_MALAY.md | 2 +- .../06-api-reference/variables/OCR_MALTESE.md | 2 +- .../06-api-reference/variables/OCR_MAORI.md | 2 +- .../variables/OCR_MONGOLIAN.md | 2 +- .../variables/OCR_NORWEGIAN.md | 2 +- .../06-api-reference/variables/OCR_OCCITAN.md | 2 +- .../06-api-reference/variables/OCR_PALI.md | 2 +- .../06-api-reference/variables/OCR_POLISH.md | 2 +- .../variables/OCR_PORTUGUESE.md | 2 +- .../variables/OCR_ROMANIAN.md | 2 +- .../06-api-reference/variables/OCR_RUSSIAN.md | 2 +- .../variables/OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/OCR_SERBIAN_LATIN.md | 2 +- .../variables/OCR_SIMPLIFIED_CHINESE.md | 2 +- .../06-api-reference/variables/OCR_SLOVAK.md | 2 +- .../variables/OCR_SLOVENIAN.md | 2 +- .../06-api-reference/variables/OCR_SPANISH.md | 2 +- .../06-api-reference/variables/OCR_SWAHILI.md | 2 +- .../06-api-reference/variables/OCR_SWEDISH.md | 2 +- .../variables/OCR_TABASSARAN.md | 2 +- .../06-api-reference/variables/OCR_TAGALOG.md | 2 +- .../06-api-reference/variables/OCR_TAJIK.md | 2 +- .../06-api-reference/variables/OCR_TELUGU.md | 2 +- .../06-api-reference/variables/OCR_TURKISH.md | 2 +- .../variables/OCR_UKRAINIAN.md | 2 +- .../06-api-reference/variables/OCR_UZBEK.md | 2 +- .../variables/OCR_VIETNAMESE.md | 2 +- .../06-api-reference/variables/OCR_WELSH.md | 2 +- .../variables/PHI_4_MINI_4B.md | 2 +- .../variables/PHI_4_MINI_4B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_0_5B.md | 2 +- .../variables/QWEN2_5_0_5B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_1_5B.md | 2 +- .../variables/QWEN2_5_1_5B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN2_5_3B.md | 2 +- .../variables/QWEN2_5_3B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_0_6B.md | 2 +- .../variables/QWEN3_0_6B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_1_7B.md | 2 +- .../variables/QWEN3_1_7B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_4B.md | 2 +- .../variables/QWEN3_4B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_135M.md | 2 +- .../variables/SMOLLM2_1_135M_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_1_7B.md | 2 +- .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_360M.md | 2 +- .../variables/SMOLLM2_1_360M_QUANTIZED.md | 2 +- .../variables/SPECIAL_TOKENS.md | 2 +- .../SSDLITE_320_MOBILENET_V3_LARGE.md | 2 +- .../variables/STYLE_TRANSFER_CANDY.md | 2 +- .../variables/STYLE_TRANSFER_MOSAIC.md | 2 +- .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 2 +- .../variables/STYLE_TRANSFER_UDNIE.md | 2 +- .../variables/VERTICAL_OCR_ABAZA.md | 2 +- .../variables/VERTICAL_OCR_ADYGHE.md | 2 +- .../variables/VERTICAL_OCR_AFRIKAANS.md | 2 +- .../variables/VERTICAL_OCR_ALBANIAN.md | 2 +- .../variables/VERTICAL_OCR_AVAR.md | 2 +- .../variables/VERTICAL_OCR_AZERBAIJANI.md | 2 +- .../variables/VERTICAL_OCR_BELARUSIAN.md | 2 +- .../variables/VERTICAL_OCR_BOSNIAN.md | 2 +- .../variables/VERTICAL_OCR_BULGARIAN.md | 2 +- .../variables/VERTICAL_OCR_CHECHEN.md | 2 +- .../variables/VERTICAL_OCR_CROATIAN.md | 2 +- .../variables/VERTICAL_OCR_CZECH.md | 2 +- .../variables/VERTICAL_OCR_DANISH.md | 2 +- .../variables/VERTICAL_OCR_DARGWA.md | 2 +- .../variables/VERTICAL_OCR_DUTCH.md | 2 +- .../variables/VERTICAL_OCR_ENGLISH.md | 2 +- .../variables/VERTICAL_OCR_ESTONIAN.md | 2 +- .../variables/VERTICAL_OCR_FRENCH.md | 2 +- .../variables/VERTICAL_OCR_GERMAN.md | 2 +- .../variables/VERTICAL_OCR_HUNGARIAN.md | 2 +- .../variables/VERTICAL_OCR_ICELANDIC.md | 2 +- .../variables/VERTICAL_OCR_INDONESIAN.md | 2 +- .../variables/VERTICAL_OCR_INGUSH.md | 2 +- .../variables/VERTICAL_OCR_IRISH.md | 2 +- .../variables/VERTICAL_OCR_ITALIAN.md | 2 +- .../variables/VERTICAL_OCR_JAPANESE.md | 2 +- .../variables/VERTICAL_OCR_KANNADA.md | 2 +- .../variables/VERTICAL_OCR_KARBADIAN.md | 2 +- .../variables/VERTICAL_OCR_KOREAN.md | 2 +- .../variables/VERTICAL_OCR_KURDISH.md | 2 +- .../variables/VERTICAL_OCR_LAK.md | 2 +- .../variables/VERTICAL_OCR_LATIN.md | 2 +- .../variables/VERTICAL_OCR_LATVIAN.md | 2 +- .../variables/VERTICAL_OCR_LEZGHIAN.md | 2 +- .../variables/VERTICAL_OCR_LITHUANIAN.md | 2 +- .../variables/VERTICAL_OCR_MALAY.md | 2 +- .../variables/VERTICAL_OCR_MALTESE.md | 2 +- .../variables/VERTICAL_OCR_MAORI.md | 2 +- .../variables/VERTICAL_OCR_MONGOLIAN.md | 2 +- .../variables/VERTICAL_OCR_NORWEGIAN.md | 2 +- .../variables/VERTICAL_OCR_OCCITAN.md | 2 +- .../variables/VERTICAL_OCR_PALI.md | 2 +- .../variables/VERTICAL_OCR_POLISH.md | 2 +- .../variables/VERTICAL_OCR_PORTUGUESE.md | 2 +- .../variables/VERTICAL_OCR_ROMANIAN.md | 2 +- .../variables/VERTICAL_OCR_RUSSIAN.md | 2 +- .../VERTICAL_OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/VERTICAL_OCR_SERBIAN_LATIN.md | 2 +- .../VERTICAL_OCR_SIMPLIFIED_CHINESE.md | 2 +- .../variables/VERTICAL_OCR_SLOVAK.md | 2 +- .../variables/VERTICAL_OCR_SLOVENIAN.md | 2 +- .../variables/VERTICAL_OCR_SPANISH.md | 2 +- .../variables/VERTICAL_OCR_SWAHILI.md | 2 +- .../variables/VERTICAL_OCR_SWEDISH.md | 2 +- .../variables/VERTICAL_OCR_TABASSARAN.md | 2 +- .../variables/VERTICAL_OCR_TAGALOG.md | 2 +- .../variables/VERTICAL_OCR_TAJIK.md | 2 +- .../variables/VERTICAL_OCR_TELUGU.md | 2 +- .../variables/VERTICAL_OCR_TURKISH.md | 2 +- .../variables/VERTICAL_OCR_UKRAINIAN.md | 2 +- .../variables/VERTICAL_OCR_UZBEK.md | 2 +- .../variables/VERTICAL_OCR_VIETNAMESE.md | 2 +- .../variables/VERTICAL_OCR_WELSH.md | 2 +- .../variables/WHISPER_BASE.md | 2 +- .../variables/WHISPER_BASE_EN.md | 2 +- .../variables/WHISPER_SMALL.md | 2 +- .../variables/WHISPER_SMALL_EN.md | 2 +- .../variables/WHISPER_TINY.md | 2 +- .../variables/WHISPER_TINY_EN.md | 2 +- .../variables/WHISPER_TINY_EN_QUANTIZED.md | 2 +- .../variables/parseToolCall.md | 2 +- .../common/rnexecutorch/ErrorCodes.h | 51 ++--- .../src/constants/llmDefaults.ts | 18 ++ .../src/constants/ocr/symbols.ts | 3 + .../src/errors/ErrorCodes.ts | 56 +++++- .../computer_vision/StyleTransferModule.ts | 16 ++ .../computer_vision/TextToImageModule.ts | 27 +++ .../computer_vision/VerticalOCRModule.ts | 19 ++ .../src/types/common.ts | 66 +++++++ .../src/types/imageSegmentation.ts | 3 + .../react-native-executorch/src/types/llm.ts | 7 +- .../react-native-executorch/src/utils/llm.ts | 14 +- scripts/errors.config.ts | 55 ++++++ 301 files changed, 1221 insertions(+), 787 deletions(-) diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index 6ab1212e5..ca68dc52f 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,6 @@ # Class: ClassificationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L10) Module for image classification tasks. @@ -28,7 +28,7 @@ Module for image classification tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L41) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -84,7 +84,7 @@ The classification result. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L18) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L18) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index 217ccf11f..5b6f6f133 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -1,6 +1,6 @@ # Class: ExecutorchModule -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L40) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L40) Executes the model's forward pass, where input is an array of `TensorPtr` objects. If the inference is successful, an array of tensor pointers is returned. @@ -83,7 +83,7 @@ An array of output tensor pointers. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -112,7 +112,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -146,7 +146,7 @@ The input shape as an array of numbers. > **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L16) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L16) Loads the model, where `modelSource` is a string, number, or object that specifies the location of the model binary. Optionally accepts a download progress callback. diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md index fc0fb00a8..46cf15bd5 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: ImageEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L10) Module for generating image embeddings from input images. @@ -28,7 +28,7 @@ Module for generating image embeddings from input images. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L40) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L40) Executes the model's forward pass, where `imageSource` is a URI/URL to image that will be embedded. @@ -84,7 +84,7 @@ A Float32Array containing the image embeddings. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L17) Loads the model, where `modelSource` is a string that specifies the location of the model binary. diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md index ee990800a..560156592 100644 --- a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -1,6 +1,6 @@ # Class: ImageSegmentationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L11) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L11) Module for image segmentation tasks. @@ -28,7 +28,7 @@ Module for image segmentation tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L45) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L45) Executes the model's forward pass @@ -96,7 +96,7 @@ A dictionary where keys are `DeeplabLabel` and values are arrays of probabilitie > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -125,7 +125,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -159,7 +159,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L20) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md index fcd65798b..c42d98ca6 100644 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -1,6 +1,6 @@ # Class: LLMModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L12) Module for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Module for managing a Large Language Model (LLM) instance. > **new LLMModule**(`optionalCallbacks`): `LLMModule` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L21) Creates a new instance of LLMModule with optional callbacks. @@ -50,7 +50,7 @@ A new LLMModule instance. > **configure**(`configuration`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) Configures chat and tool calling and generation settings. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -73,7 +73,7 @@ Configuration object containing `chatConfig`, `toolsConfig`, and `generationConf > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:169](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L169) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:169](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L169) Method to delete the model from memory. Note you cannot delete model while it's generating. @@ -89,7 +89,7 @@ You need to interrupt it first and make sure model stopped generation. > **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:143](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L143) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:143](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L143) Deletes all messages starting with message on `index` position. After deletion it will call `messageHistoryCallback()` containing new history. @@ -115,7 +115,7 @@ The index of the message to delete from history. > **forward**(`input`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:105](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L105) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:105](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L105) Runs model inference with raw input string. You need to provide entire conversation and prompt (in correct format and with special tokens!) in input string to this method. @@ -142,7 +142,7 @@ The generated response as a string. > **generate**(`messages`, `tools?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:117](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L117) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:117](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L117) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -172,7 +172,7 @@ The generated response as a string. > **getGeneratedTokenCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:160](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L160) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:160](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L160) Returns the number of tokens generated in the last response. @@ -188,7 +188,7 @@ The count of generated tokens. > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L151) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L151) Interrupts model generation. It may return one more token after interrupt. @@ -202,7 +202,7 @@ Interrupts model generation. It may return one more token after interrupt. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L55) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L55) Loads the LLM model and tokenizer. @@ -246,7 +246,7 @@ Optional callback to track download progress (value between 0 and 1). > **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:130](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L130) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:130](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L130) Method to add user message to conversation. After model responds it will call `messageHistoryCallback()` containing both user message and model response. @@ -272,7 +272,7 @@ The message string to send. > **setTokenCallback**(`tokenCallback`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) Sets new token callback invoked on every token batch. diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md index 96b82cc6f..195635fcc 100644 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -1,6 +1,6 @@ # Class: OCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **new OCRModule**(): `OCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) #### Returns @@ -20,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:50](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L50) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L50) Release the memory held by the module. Calling `forward` afterwards is invalid. Note that you cannot delete model while it's generating. @@ -35,7 +35,7 @@ Note that you cannot delete model while it's generating. > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L42) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L42) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -59,7 +59,7 @@ The OCR result as a string. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L20) Loads the model, where `detectorSource` is a string that specifies the location of the detector binary, `recognizerSource` is a string that specifies the location of the recognizer binary, diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index 202de48e3..a9a0747c0 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -1,6 +1,6 @@ # Class: ObjectDetectionModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L11) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L11) Module for object detection tasks. @@ -28,7 +28,7 @@ Module for object detection tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L45) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L45) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. `detectionThreshold` can be supplied to alter the sensitivity of the detection. @@ -91,7 +91,7 @@ An array of Detection objects representing detected items in the image. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -120,7 +120,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -154,7 +154,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L20) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md index 9f453d776..95b19b12d 100644 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -1,6 +1,6 @@ # Class: ResourceFetcher -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](h > `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) ## Methods @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](h > `static` **cancelFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251]( > `static` **deleteResources**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278]( > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](h > `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290]( > `static` **listDownloadedFiles**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) #### Returns @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268]( > `static` **listDownloadedModels**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) #### Returns @@ -126,7 +126,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273]( > `static` **pauseFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) #### Parameters @@ -144,7 +144,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241]( > `static` **resumeFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) #### Parameters diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md index 8d1753bcd..164880514 100644 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -1,6 +1,6 @@ # Class: RnExecutorchError -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/errorUtils.ts#L3) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/errorUtils.ts#L3) ## Extends @@ -12,7 +12,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https: > **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/errorUtils.ts#L14) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/errorUtils.ts#L14) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https > `optional` **cause**: `unknown` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/errorUtils.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/errorUtils.ts#L12) The original cause of the error, if any. @@ -56,7 +56,7 @@ The original cause of the error, if any. > **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/errorUtils.ts#L7) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/errorUtils.ts#L7) The error code representing the type of error. diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md index 7b19c9b95..8720863aa 100644 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -1,6 +1,6 @@ # Class: SpeechToTextModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L10) Module for Speech to Text (STT) functionalities. @@ -20,7 +20,7 @@ Module for Speech to Text (STT) functionalities. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:94](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L94) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:94](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L94) Runs the decoder of the model. Passing number[] is deprecated. @@ -50,7 +50,7 @@ Decoded output. > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L64) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L64) Unloads the model from memory. @@ -64,7 +64,7 @@ Unloads the model from memory. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:75](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L75) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:75](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L75) Runs the encoding part of the model on the provided waveform. Returns the encoded waveform as a Float32Array. Passing `number[]` is deprecated. @@ -89,7 +89,7 @@ The encoded output. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27) Loads the model specified by the config object. `onDownloadProgressCallback` allows you to monitor the current progress of the model download. @@ -118,7 +118,7 @@ Optional callback to monitor download progress. > **stream**(`options`): `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L151) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L151) Starts a streaming transcription session. Yields objects with `committed` and `nonCommitted` transcriptions. @@ -144,7 +144,7 @@ An async generator yielding transcription updates. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:211](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L211) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:211](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L211) Inserts a new audio chunk into the streaming transcription session. Passing `number[]` is deprecated. @@ -166,7 +166,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:224](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L224) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:224](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L224) Stops the current streaming transcription session. @@ -180,7 +180,7 @@ Stops the current streaming transcription session. > **transcribe**(`waveform`, `options`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:124](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L124) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:124](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L124) Starts a transcription process for a given input array (16kHz waveform). For multilingual models, specify the language in `options`. diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index 17785d72f..bf2e4d487 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,8 @@ # Class: StyleTransferModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L7) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L10) + +Module for style transfer tasks. ## Extends @@ -26,7 +28,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +60,9 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L25) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L41) + +Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. #### Parameters @@ -66,17 +70,21 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style `string` +The image source to be processed. + #### Returns `Promise`\<`string`\> +The stylized image as a Base64-encoded string. + *** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -105,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -139,12 +147,17 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L18) + +Loads the model, where `modelSource` is a string that specifies the location of the model binary. +To track the download progress, supply a callback function `onDownloadProgressCallback`. #### Parameters ##### model +Object containing `modelSource`. + ###### modelSource [`ResourceSource`](../type-aliases/ResourceSource.md) @@ -153,6 +166,8 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Style (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index dcc52356e..0804f9fb8 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: TextEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L10) Module for generating text embeddings from input text. @@ -28,7 +28,7 @@ Module for generating text embeddings from input text. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:53](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L53) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L53) Executes the model's forward pass, where `input` is a text that will be embedded. @@ -84,7 +84,7 @@ A Float32Array containing the vector embeddings. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L20) Loads the model and tokenizer specified by the config object. diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index 209cc7dd5..eb85b7b67 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -1,6 +1,8 @@ # Class: TextToImageModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:9](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L9) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) + +Module for text-to-image generation tasks. ## Extends @@ -12,7 +14,9 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L20) + +Creates a new instance of `TextToImageModule` with optional callback on inference step. #### Parameters @@ -20,6 +24,8 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT (`stepIdx`) => `void` +Optional callback function that receives the current step index during inference. + #### Returns `TextToImageModule` @@ -34,7 +40,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -48,7 +54,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -66,7 +72,10 @@ Unloads the model from memory. > **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) + +Runs the model to generate an image described by `input`, and conditioned by `seed`, performing `numSteps` inference steps. +The resulting image, with dimensions `imageSize`×`imageSize` pixels, is returned as a base64-encoded string. #### Parameters @@ -74,29 +83,39 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT `string` +The text prompt to generate the image from. + ##### imageSize `number` = `512` +The desired width and height of the output image in pixels. + ##### numSteps `number` = `5` +The number of inference steps to perform. + ##### seed? `number` +An optional seed for random number generation to ensure reproducibility. + #### Returns `Promise`\<`string`\> +A Base64-encoded string representing the generated PNG image. + *** ### forwardET() > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -125,7 +144,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -159,7 +178,9 @@ The input shape as an array of numbers. > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:125](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L125) + +Interrupts model generation. The model is stopped in the nearest step. #### Returns @@ -171,12 +192,16 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L33) + +Loads the model from specified resources. #### Parameters ##### model +Object containing sources for tokenizer, scheduler, encoder, unet, and decoder. + ###### decoderSource [`ResourceSource`](../type-aliases/ResourceSource.md) @@ -201,6 +226,8 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextT (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/classes/TextToSpeechModule.md b/docs/docs/06-api-reference/classes/TextToSpeechModule.md index a7e2c3793..b126fe55c 100644 --- a/docs/docs/06-api-reference/classes/TextToSpeechModule.md +++ b/docs/docs/06-api-reference/classes/TextToSpeechModule.md @@ -1,6 +1,6 @@ # Class: TextToSpeechModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L14) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L14) Module for Text to Speech (TTS) functionalities. @@ -20,7 +20,7 @@ Module for Text to Speech (TTS) functionalities. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L18) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L18) Native module instance @@ -30,7 +30,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:164](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L164) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:164](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L164) Unloads the model from memory. @@ -44,7 +44,7 @@ Unloads the model from memory. > **forward**(`text`, `speed`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:97](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L97) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:97](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L97) Synthesizes the provided text into speech. Returns a promise that resolves to the full audio waveform as a `Float32Array`. @@ -75,7 +75,7 @@ A promise resolving to the synthesized audio waveform. > **load**(`config`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L27) Loads the model and voice assets specified by the config object. `onDownloadProgressCallback` allows you to monitor the current progress. @@ -104,7 +104,7 @@ Optional callback to monitor download progress. > **stream**(`input`): `AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:112](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L112) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:112](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L112) Starts a streaming synthesis session. Yields audio chunks as they are generated. @@ -128,7 +128,7 @@ An async generator yielding Float32Array audio chunks. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:157](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L157) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:157](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L157) Stops the streaming process if there is any ongoing. diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md index cd4ef44a8..5fd6929f1 100644 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -1,6 +1,6 @@ # Class: TokenizerModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L10) Native module instance @@ -28,7 +28,7 @@ Native module instance > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L54) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L54) Converts an array of token IDs into a string. @@ -58,7 +58,7 @@ The decoded string. > **encode**(`input`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:43](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L43) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:43](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L43) Converts a string into an array of token IDs. @@ -82,7 +82,7 @@ An array of token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L66) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L66) Returns the size of the tokenizer's vocabulary. @@ -98,7 +98,7 @@ The vocabulary size. > **idToToken**(`tokenId`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:76](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L76) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L76) Returns the token associated to the ID. @@ -122,7 +122,7 @@ The token string associated to ID. > **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L19) Loads the tokenizer from the specified source. `tokenizerSource` is a string that points to the location of the tokenizer JSON file. @@ -153,7 +153,7 @@ Optional callback to monitor download progress. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L86) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L86) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index d80fe9437..5c0ef83e4 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -1,6 +1,6 @@ # Class: VADModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +40,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +58,7 @@ Unloads the model from memory. > **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L39) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L39) Executes the model's forward pass, where `waveform` is a Float32Array representing the audio signal. @@ -82,7 +82,7 @@ A promise resolving to an array of detected speech segments. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -111,7 +111,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -145,7 +145,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L16) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L16) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md index ca054f896..85075d8cb 100644 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -1,6 +1,6 @@ # Class: VerticalOCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) ## Constructors @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **new VerticalOCRModule**(): `VerticalOCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) #### Returns @@ -20,7 +20,10 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L53) + +Release the memory held by the module. Calling `forward` afterwards is invalid. +Note that you cannot delete model while it's generating. #### Returns @@ -32,7 +35,9 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:30](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L30) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L45) + +Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. #### Parameters @@ -40,22 +45,32 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti `string` +The image source to be processed. + #### Returns `Promise`\<`any`\> +The OCR result as a string. + *** ### load() > **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L21) + +Loads the model, where `detectorSource` is a string that specifies the location of the detector binary, +`recognizerSource` is a string that specifies the location of the recognizer binary, +and `language` is a parameter that specifies the language of the text to be recognized by the OCR. #### Parameters ##### model +Object containing `detectorSource`, `recognizerSource`, and `language`. + ###### detectorSource [`ResourceSource`](../type-aliases/ResourceSource.md) @@ -72,10 +87,14 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti `boolean` +Whether to treat characters independently during recognition. + ##### onDownloadProgressCallback (`progress`) => `void` +Optional callback to monitor download progress. + #### Returns `Promise`\<`void`\> diff --git a/docs/docs/06-api-reference/enumerations/CocoLabel.md b/docs/docs/06-api-reference/enumerations/CocoLabel.md index ad0268c29..784862d56 100644 --- a/docs/docs/06-api-reference/enumerations/CocoLabel.md +++ b/docs/docs/06-api-reference/enumerations/CocoLabel.md @@ -1,6 +1,6 @@ # Enumeration: CocoLabel -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:35](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L35) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:35](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L35) COCO dataset class labels used for object detection. @@ -10,7 +10,7 @@ COCO dataset class labels used for object detection. > **AIRPLANE**: `5` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L40) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L40) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](h > **APPLE**: `53` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L87) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L87) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](h > **BACKPACK**: `27` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L62) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L62) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](h > **BANANA**: `52` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L86) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L86) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](h > **BASEBALL**: `39` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L74) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L74) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](h > **BEAR**: `23` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L58) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L58) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](h > **BED**: `65` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L99) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L99) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](h > **BENCH**: `15` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L50) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L50) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](h > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L37) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L37) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](h > **BIRD**: `16` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L51) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L51) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](h > **BLENDER**: `83` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L117) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L117) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117]( > **BOAT**: `9` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L44) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L44) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](h > **BOOK**: `84` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L118) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L118) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118]( > **BOTTLE**: `44` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L78) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L78) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](h > **BOWL**: `51` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L85) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L85) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](h > **BROCCOLI**: `56` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L90) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L90) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](h > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L41) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L41) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](h > **CAKE**: `61` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L95) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L95) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](h > **CAR**: `3` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L38) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L38) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](h > **CARROT**: `57` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L91) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L91) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](h > **CAT**: `17` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L52) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L52) *** @@ -178,7 +178,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](h > **CELL\_PHONE**: `77` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L111) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L111) *** @@ -186,7 +186,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111]( > **CHAIR**: `62` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L96) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L96) *** @@ -194,7 +194,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](h > **CLOCK**: `85` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L119) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L119) *** @@ -202,7 +202,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119]( > **COUCH**: `63` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L97) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L97) *** @@ -210,7 +210,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](h > **COW**: `21` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L56) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L56) *** @@ -218,7 +218,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](h > **CUP**: `47` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L81) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L81) *** @@ -226,7 +226,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](h > **DESK**: `69` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L103) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L103) *** @@ -234,7 +234,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103]( > **DINING\_TABLE**: `67` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L101) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L101) *** @@ -242,7 +242,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101]( > **DOG**: `18` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L53) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L53) *** @@ -250,7 +250,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](h > **DONUT**: `60` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L94) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L94) *** @@ -258,7 +258,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](h > **DOOR**: `71` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L105) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L105) *** @@ -266,7 +266,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105]( > **ELEPHANT**: `22` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L57) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L57) *** @@ -274,7 +274,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](h > **EYE**: `30` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L65) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L65) *** @@ -282,7 +282,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](h > **FIRE\_HYDRANT**: `11` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L46) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L46) *** @@ -290,7 +290,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](h > **FORK**: `48` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L82) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L82) *** @@ -298,7 +298,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](h > **FRISBEE**: `34` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L69) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L69) *** @@ -306,7 +306,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](h > **GIRAFFE**: `25` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L60) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L60) *** @@ -314,7 +314,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](h > **HAIR\_BRUSH**: `91` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L125) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L125) *** @@ -322,7 +322,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125]( > **HAIR\_DRIER**: `89` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L123) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L123) *** @@ -330,7 +330,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123]( > **HANDBAG**: `31` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L66) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L66) *** @@ -338,7 +338,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](h > **HAT**: `26` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L61) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L61) *** @@ -346,7 +346,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](h > **HORSE**: `19` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L54) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L54) *** @@ -354,7 +354,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](h > **HOT\_DOG**: `58` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L92) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L92) *** @@ -362,7 +362,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](h > **KEYBOARD**: `76` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L110) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L110) *** @@ -370,7 +370,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110]( > **KITE**: `38` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L73) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L73) *** @@ -378,7 +378,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](h > **KNIFE**: `49` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L83) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L83) *** @@ -386,7 +386,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](h > **LAPTOP**: `73` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L107) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L107) *** @@ -394,7 +394,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107]( > **MICROWAVE**: `78` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L112) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L112) *** @@ -402,7 +402,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112]( > **MIRROR**: `66` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L100) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L100) *** @@ -410,7 +410,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100]( > **MOTORCYCLE**: `4` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L39) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L39) *** @@ -418,7 +418,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](h > **MOUSE**: `74` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L108) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L108) *** @@ -426,7 +426,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108]( > **ORANGE**: `55` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L89) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L89) *** @@ -434,7 +434,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](h > **OVEN**: `79` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L113) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L113) *** @@ -442,7 +442,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113]( > **PARKING**: `14` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L49) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L49) *** @@ -450,7 +450,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](h > **PERSON**: `1` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L36) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L36) *** @@ -458,7 +458,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](h > **PIZZA**: `59` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L93) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L93) *** @@ -466,7 +466,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](h > **PLATE**: `45` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L79) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L79) *** @@ -474,7 +474,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](h > **POTTED\_PLANT**: `64` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L98) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L98) *** @@ -482,7 +482,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](h > **REFRIGERATOR**: `82` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L116) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L116) *** @@ -490,7 +490,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116]( > **REMOTE**: `75` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L109) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L109) *** @@ -498,7 +498,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109]( > **SANDWICH**: `54` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L88) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L88) *** @@ -506,7 +506,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](h > **SCISSORS**: `87` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L121) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L121) *** @@ -514,7 +514,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121]( > **SHEEP**: `20` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L55) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L55) *** @@ -522,7 +522,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](h > **SHOE**: `29` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L64) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L64) *** @@ -530,7 +530,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](h > **SINK**: `81` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L115) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L115) *** @@ -538,7 +538,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115]( > **SKATEBOARD**: `41` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L75) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L75) *** @@ -546,7 +546,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](h > **SKIS**: `35` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L70) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L70) *** @@ -554,7 +554,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](h > **SNOWBOARD**: `36` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L71) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L71) *** @@ -562,7 +562,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](h > **SPOON**: `50` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L84) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L84) *** @@ -570,7 +570,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](h > **SPORTS**: `37` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L72) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L72) *** @@ -578,7 +578,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](h > **STOP\_SIGN**: `13` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L48) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L48) *** @@ -586,7 +586,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](h > **STREET\_SIGN**: `12` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L47) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L47) *** @@ -594,7 +594,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](h > **SUITCASE**: `33` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L68) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L68) *** @@ -602,7 +602,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](h > **SURFBOARD**: `42` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L76) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L76) *** @@ -610,7 +610,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](h > **TEDDY\_BEAR**: `88` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L122) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L122) *** @@ -618,7 +618,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122]( > **TENNIS\_RACKET**: `43` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L77) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L77) *** @@ -626,7 +626,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](h > **TIE**: `32` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L67) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L67) *** @@ -634,7 +634,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](h > **TOASTER**: `80` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L114) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L114) *** @@ -642,7 +642,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114]( > **TOILET**: `70` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L104) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L104) *** @@ -650,7 +650,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104]( > **TOOTHBRUSH**: `90` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L124) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L124) *** @@ -658,7 +658,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124]( > **TRAFFIC\_LIGHT**: `10` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L45) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L45) *** @@ -666,7 +666,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](h > **TRAIN**: `7` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L42) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L42) *** @@ -674,7 +674,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](h > **TRUCK**: `8` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L43) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L43) *** @@ -682,7 +682,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](h > **TV**: `72` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L106) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L106) *** @@ -690,7 +690,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106]( > **UMBRELLA**: `28` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L63) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L63) *** @@ -698,7 +698,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](h > **VASE**: `86` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L120) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L120) *** @@ -706,7 +706,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120]( > **WINDOW**: `68` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L102) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L102) *** @@ -714,7 +714,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102]( > **WINE\_GLASS**: `46` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L80) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L80) *** @@ -722,4 +722,4 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](h > **ZEBRA**: `24` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L59) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L59) diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md index f70d82a58..180a52132 100644 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -1,6 +1,8 @@ # Enumeration: DeeplabLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L5) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) + +Labels used in the DeepLab image segmentation model. ## Enumeration Members @@ -8,7 +10,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:5]( > **AEROPLANE**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L7) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) *** @@ -16,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:7]( > **ARGMAX**: `21` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L30) *** @@ -24,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27] > **BACKGROUND**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L6) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) *** @@ -32,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:6]( > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) *** @@ -40,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8]( > **BIRD**: `3` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) *** @@ -48,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9]( > **BOAT**: `4` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) *** @@ -56,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10] > **BOTTLE**: `5` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) *** @@ -64,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11] > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) *** @@ -72,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12] > **CAR**: `7` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) *** @@ -80,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13] > **CAT**: `8` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) *** @@ -88,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14] > **CHAIR**: `9` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) *** @@ -96,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15] > **COW**: `10` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) *** @@ -104,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16] > **DININGTABLE**: `11` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) *** @@ -112,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17] > **DOG**: `12` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) *** @@ -120,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18] > **HORSE**: `13` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) *** @@ -128,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19] > **MOTORBIKE**: `14` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) *** @@ -136,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20] > **PERSON**: `15` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) *** @@ -144,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21] > **POTTEDPLANT**: `16` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) *** @@ -152,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22] > **SHEEP**: `17` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) *** @@ -160,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23] > **SOFA**: `18` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) *** @@ -168,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24] > **TRAIN**: `19` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L28) *** @@ -176,4 +178,4 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25] > **TVMONITOR**: `20` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L29) diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md index aefee713e..7e12e541a 100644 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -1,6 +1,6 @@ # Enumeration: RnExecutorchErrorCode -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) ## Enumeration Members @@ -8,7 +8,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https: > **AccessFailed**: `34` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:148](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L148) + +Could not access a resource. *** @@ -16,7 +18,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](http > **DelegateInvalidCompatibility**: `48` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:164](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L164) + +Init stage: Backend receives an incompatible delegate version. *** @@ -24,7 +28,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](http > **DelegateInvalidHandle**: `50` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L118) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:172](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L172) + +Execute stage: The handle is invalid. *** @@ -32,7 +38,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:118](http > **DelegateMemoryAllocationFailed**: `49` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L117) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:168](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L168) + +Init stage: Backend fails to allocate memory. *** @@ -40,7 +48,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:117](http > **DownloadInterrupted**: `118` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) Thrown when the number of downloaded files is unexpected, due to download interruptions. @@ -50,7 +58,9 @@ Thrown when the number of downloaded files is unexpected, due to download interr > **EndOfMethod**: `3` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) + +Status indicating there are no more steps of execution to run *** @@ -58,7 +68,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](http > **FileReadFailed**: `114` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. @@ -68,7 +78,7 @@ Thrown when a file read operation failed. This could be invalid image url passed > **FileWriteFailed**: `103` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) An error ocurred when saving a file. This could be, for instance a result image from an image model. @@ -78,7 +88,9 @@ An error ocurred when saving a file. This could be, for instance a result image > **Internal**: `1` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L102) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) + +An internal error occurred. *** @@ -86,7 +98,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:102](http > **InvalidArgument**: `18` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L107) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L128) + +User provided an invalid argument. *** @@ -94,7 +108,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:107](http > **InvalidConfig**: `112` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. @@ -104,7 +118,9 @@ Thrown when config parameters passed to a model are invalid. For example, when L > **InvalidExternalData**: `36` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L114) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:156](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L156) + +Error caused by the contents of external data. *** @@ -112,7 +128,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:114](http > **InvalidModelOutput**: `115` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) Thrown when the size of model output is unexpected. @@ -122,7 +138,7 @@ Thrown when the size of model output is unexpected. > **InvalidModelSource**: `255` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) Thrown when the type of model source passed by the user is invalid. @@ -132,7 +148,9 @@ Thrown when the type of model source passed by the user is invalid. > **InvalidProgram**: `35` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L113) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:152](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L152) + +Error caused by the contents of a program. *** @@ -140,7 +158,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:113](http > **InvalidState**: `2` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L103) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) + +Status indicating the executor is in an invalid state for a targeted operation. *** @@ -148,7 +168,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:103](http > **InvalidType**: `19` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:132](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L132) + +Object is an invalid type for the operation. *** @@ -156,9 +178,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](http > **InvalidUserInput**: `117` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) -Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). +Thrown when the input passed to our APIs is invalid, for example when passing an empty message aray to LLM's generate(). *** @@ -166,7 +188,7 @@ Thrown when the input passed to our APIs is invalid, for example when passing an > **LanguageNotSupported**: `105` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. @@ -176,7 +198,9 @@ Thrown when a language is passed to a multi-language model that is not supported > **MemoryAllocationFailed**: `33` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L111) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:144](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L144) + +Could not allocate the requested memory. *** @@ -184,7 +208,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:111](http > **MissingDataChunk**: `161` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) Thrown when streaming transcription is attempted but audio data chunk is missing. @@ -194,7 +218,7 @@ Thrown when streaming transcription is attempted but audio data chunk is missing > **ModelGenerating**: `104` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. @@ -204,7 +228,7 @@ Thrown when a user tries to run a model that is currently processing. It is only > **ModuleNotLoaded**: `102` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. @@ -214,7 +238,7 @@ Thrown when a user tries to run a model that is not yet downloaded or loaded int > **MultilingualConfiguration**: `160` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. @@ -224,7 +248,9 @@ Thrown when there's a configuration mismatch between multilingual and language s > **NotFound**: `32` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L110) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:140](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L140) + +Requested resource could not be found. *** @@ -232,7 +258,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:110](http > **NotImplemented**: `17` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L106) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:124](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L124) + +Operation is not yet implemented. *** @@ -240,7 +268,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:106](http > **NotSupported**: `16` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L105) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:120](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L120) + +Operation is not supported in the current context. *** @@ -248,7 +278,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:105](http > **Ok**: `0` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L101) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) + +Status indicating a successful operation. *** @@ -256,7 +288,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:101](http > **OperatorMissing**: `20` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L109) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:136](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L136) + +Operator(s) missing in the operator registry. *** @@ -264,7 +298,9 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:109](http > **OutOfResources**: `37` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L115) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:160](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L160) + +Does not have enough resources to perform the requested operation. *** @@ -272,7 +308,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:115](http > **ResourceFetcherAlreadyOngoing**: `183` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) Thrown when trying to resume a download that is already ongoing. @@ -282,7 +318,7 @@ Thrown when trying to resume a download that is already ongoing. > **ResourceFetcherAlreadyPaused**: `182` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) Thrown when trying to pause a download that is already paused. @@ -292,7 +328,7 @@ Thrown when trying to pause a download that is already paused. > **ResourceFetcherDownloadFailed**: `180` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. @@ -302,7 +338,7 @@ Thrown when a resource fails to download. This could be due to invalid URL, or f > **ResourceFetcherDownloadInProgress**: `181` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) Thrown when a user tries to trigger a download that's already in progress. @@ -312,7 +348,7 @@ Thrown when a user tries to trigger a download that's already in progress. > **ResourceFetcherMissingUri**: `185` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) Thrown when required URI information is missing for a download operation. @@ -322,7 +358,7 @@ Thrown when required URI information is missing for a download operation. > **ResourceFetcherNotActive**: `184` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) Thrown when trying to pause, resume, or cancel a download that is not active. @@ -332,7 +368,7 @@ Thrown when trying to pause, resume, or cancel a download that is not active. > **StreamingInProgress**: `163` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) Thrown when trying to start a new streaming session while another is already in progress. @@ -342,7 +378,7 @@ Thrown when trying to start a new streaming session while another is already in > **StreamingNotStarted**: `162` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) Thrown when trying to stop or insert data into a stream that hasn't been started. @@ -352,7 +388,7 @@ Thrown when trying to stop or insert data into a stream that hasn't been started > **ThreadPoolError**: `113` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) Thrown when React Native ExecuTorch threadpool problem occurs. @@ -362,7 +398,7 @@ Thrown when React Native ExecuTorch threadpool problem occurs. > **UnexpectedNumInputs**: `97` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) Thrown when the number of passed inputs to the model is different than the model metadata specifies. @@ -372,7 +408,7 @@ Thrown when the number of passed inputs to the model is different than the model > **UnknownError**: `101` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. @@ -382,6 +418,6 @@ An umbrella-error that is thrown usually when something unexpected happens, for > **WrongDimensions**: `116` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md index 32e5b588a..6a5cc884a 100644 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -1,6 +1,6 @@ # Enumeration: ScalarType -Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L13) +Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L13) Enum representing the scalar types of tensors. @@ -10,7 +10,9 @@ Enum representing the scalar types of tensors. > **BITS16**: `22` -Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L28) +Defined in: [packages/react-native-executorch/src/types/common.ts:73](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L73) + +Raw Bits type. *** @@ -18,7 +20,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:28](https://gi > **BOOL**: `11` -Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L22) +Defined in: [packages/react-native-executorch/src/types/common.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L49) + +Boolean type. *** @@ -26,7 +30,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:22](https://gi > **BYTE**: `0` -Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L14) +Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L17) + +Byte type (8-bit unsigned integer). *** @@ -34,7 +40,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:14](https://gi > **CHAR**: `1` -Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L15) +Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L21) + +Character type (8-bit signed integer). *** @@ -42,7 +50,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:15](https://gi > **DOUBLE**: `7` -Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L21) +Defined in: [packages/react-native-executorch/src/types/common.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L45) + +Double-precision floating point type (64-bit). *** @@ -50,7 +60,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://gi > **FLOAT**: `6` -Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L20) +Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L41) + +Single-precision floating point type (32-bit). *** @@ -58,7 +70,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:20](https://gi > **FLOAT8E4M3FN**: `24` -Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L30) +Defined in: [packages/react-native-executorch/src/types/common.ts:81](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L81) + +Quantized 8-bit floating point type: Sign bit, 4 Exponent bits, 3 Mantissa bits. *** @@ -66,7 +80,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:30](https://gi > **FLOAT8E4M3FNUZ**: `26` -Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L32) +Defined in: [packages/react-native-executorch/src/types/common.ts:89](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L89) + +Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 4 Exponent bits, 3 Mantissa bits. *** @@ -74,7 +90,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:32](https://gi > **FLOAT8E5M2**: `23` -Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L29) +Defined in: [packages/react-native-executorch/src/types/common.ts:77](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L77) + +Quantized 8-bit floating point type: Sign bit, 5 Exponent bits, 2 Mantissa bits. *** @@ -82,7 +100,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://gi > **FLOAT8E5M2FNUZ**: `25` -Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L31) +Defined in: [packages/react-native-executorch/src/types/common.ts:85](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L85) + +Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 5 Exponent bits, 2 Mantissa bits. *** @@ -90,7 +110,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:31](https://gi > **HALF**: `5` -Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L19) +Defined in: [packages/react-native-executorch/src/types/common.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L37) + +Half-precision floating point type (16-bit). *** @@ -98,7 +120,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:19](https://gi > **INT**: `3` -Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L17) +Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L29) + +Integer type (32-bit signed integer). *** @@ -106,7 +130,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://gi > **LONG**: `4` -Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L18) +Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L33) + +Long integer type (64-bit signed integer). *** @@ -114,7 +140,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:18](https://gi > **QINT32**: `14` -Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L25) +Defined in: [packages/react-native-executorch/src/types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L61) + +Quantized 32-bit signed integer type. *** @@ -122,7 +150,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://gi > **QINT8**: `12` -Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L23) +Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L53) + +Quantized 8-bit signed integer type. *** @@ -130,7 +160,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:23](https://gi > **QUINT2X4**: `17` -Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L27) +Defined in: [packages/react-native-executorch/src/types/common.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L69) + +Packed Quantized Unsigned 2-bit Integer type (4 numbers in 1 byte). *** @@ -138,7 +170,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:27](https://gi > **QUINT4X2**: `16` -Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L26) +Defined in: [packages/react-native-executorch/src/types/common.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L65) + +Packed Quantized Unsigned 4-bit Integers type (2 number in 1 byte). *** @@ -146,7 +180,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:26](https://gi > **QUINT8**: `13` -Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L24) +Defined in: [packages/react-native-executorch/src/types/common.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L57) + +Quantized 8-bit unsigned integer type. *** @@ -154,7 +190,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:24](https://gi > **SHORT**: `2` -Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L16) +Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L25) + +Short integer type (16-bit signed integer). *** @@ -162,7 +200,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:16](https://gi > **UINT16**: `27` -Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L33) +Defined in: [packages/react-native-executorch/src/types/common.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L93) + +Unsigned 16-bit integer type. *** @@ -170,7 +210,9 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://gi > **UINT32**: `28` -Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L34) +Defined in: [packages/react-native-executorch/src/types/common.ts:97](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L97) + +Unsigned 32-bit integer type. *** @@ -178,4 +220,6 @@ Defined in: [packages/react-native-executorch/src/types/common.ts:34](https://gi > **UINT64**: `29` -Defined in: [packages/react-native-executorch/src/types/common.ts:35](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L35) +Defined in: [packages/react-native-executorch/src/types/common.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L101) + +Unsigned 64-bit integer type. diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md index b77315bf9..d0563044d 100644 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -2,7 +2,9 @@ > **DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT**(`structuredOutputSchema`): `string` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/llmDefaults.ts#L15) + +Generates a default structured output prompt based on the provided JSON schema. ## Parameters @@ -10,6 +12,10 @@ Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](ht `string` +A string representing the JSON schema for the desired output format. + ## Returns `string` + +A prompt string instructing the model to format its output according to the given schema. diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md index 55b5e4baf..3e12457bd 100644 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -2,7 +2,9 @@ > **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> -Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/llm.ts#L81) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/llm.ts#L93) + +Fixes and validates structured output from LLMs against a provided schema. ## Type Parameters @@ -16,10 +18,16 @@ Defined in: [packages/react-native-executorch/src/utils/llm.ts:81](https://githu `string` +The raw output string from the LLM. + ### responseSchema +The schema (Zod or JSON Schema) to validate the output against. + `Schema` | `T` ## Returns `output`\<`T`\> + +The validated and parsed output. diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md index b25357318..ce22fb7b4 100644 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -2,7 +2,9 @@ > **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` -Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/llm.ts#L50) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/llm.ts#L56) + +Generates a structured output prompt based on the provided schema. ## Type Parameters @@ -14,8 +16,12 @@ Defined in: [packages/react-native-executorch/src/utils/llm.ts:50](https://githu ### responseSchema +The schema (Zod or JSON Schema) defining the desired output format. + `T` | `Schema` ## Returns `string` + +A prompt string instructing the model to format its output according to the given schema. diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md index 4f796f631..2148caa71 100644 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -2,7 +2,7 @@ > **useClassification**(`ClassificationConfiguration`): [`ClassificationType`](../interfaces/ClassificationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L11) React hook for managing a Classification model instance. diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md index 4c93d27bc..e954c9fa5 100644 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -2,7 +2,7 @@ > **useExecutorchModule**(`executorchModuleConfiguration`): [`ExecutorchModuleType`](../interfaces/ExecutorchModuleType.md) -Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L11) React hook for managing an arbitrary Executorch module instance. diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md index 76c70aff8..790c1bd01 100644 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -2,7 +2,7 @@ > **useImageEmbeddings**(`ImageEmbeddingsConfiguration`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L11) React hook for managing an Image Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md index 7e154f680..080c9d0eb 100644 --- a/docs/docs/06-api-reference/functions/useImageSegmentation.md +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -2,7 +2,7 @@ > **useImageSegmentation**(`ImageSegmentationConfiguration`): [`ImageSegmentationType`](../interfaces/ImageSegmentationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L11) React hook for managing an Image Segmentation model instance. diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md index 020c3d1de..2f439adc9 100644 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -2,7 +2,7 @@ > **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L18) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L18) React hook for managing a Large Language Model (LLM) instance. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md index b9f48b759..ec2e3f0d6 100644 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -2,7 +2,7 @@ > **useOCR**(`OCRConfiguration`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L12) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L12) React hook for managing an OCR instance. diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md index 74edcaed9..74b431b3b 100644 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -2,7 +2,7 @@ > **useObjectDetection**(`ObjectDetectionConfiguration`): [`ObjectDetectionType`](../interfaces/ObjectDetectionType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L11) React hook for managing an Object Detection model instance. diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md index 024a6c45e..9eb6164d2 100644 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -2,7 +2,7 @@ > **useSpeechToText**(`speechToTextConfiguration`): [`SpeechToTextType`](../interfaces/SpeechToTextType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) React hook for managing a Speech to Text (STT) instance. diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md index fc398483e..898003553 100644 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -2,7 +2,7 @@ > **useStyleTransfer**(`StyleTransferConfiguration`): [`StyleTransferType`](../interfaces/StyleTransferType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L11) React hook for managing a Style Transfer model instance. diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md index c2e9fc571..5f7549b2b 100644 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -2,7 +2,7 @@ > **useTextEmbeddings**(`TextEmbeddingsConfiguration`): [`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) React hook for managing a Text Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md index 2a75f0eec..2e0397baf 100644 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -2,7 +2,7 @@ > **useTextToImage**(`TextToImageConfiguration`): [`TextToImageType`](../interfaces/TextToImageType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L13) React hook for managing a Text to Image instance. diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md index 0ad1b3ada..771717d98 100644 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -2,7 +2,7 @@ > **useTextToSpeech**(`TextToSpeechConfiguration`): [`TextToSpeechType`](../interfaces/TextToSpeechType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L18) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L18) React hook for managing Text to Speech instance. diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md index a52272f70..e5a687233 100644 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -2,7 +2,7 @@ > **useTokenizer**(`tokenizerConfiguration`): [`TokenizerType`](../interfaces/TokenizerType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) React hook for managing a Tokenizer instance. diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md index 4564d956d..747b29f8e 100644 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -2,7 +2,7 @@ > **useVAD**(`VADConfiguration`): [`VADType`](../interfaces/VADType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) React hook for managing a VAD model instance. diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md index 7a3e99d36..3c6deb180 100644 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -2,7 +2,7 @@ > **useVerticalOCR**(`VerticalOCRConfiguration`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L12) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L12) React hook for managing a Vertical OCR instance. diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md index 2a0a0c7d7..0475d7efd 100644 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -1,6 +1,6 @@ # Interface: Bbox -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L12) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L12) Represents a bounding box for a detected object in an image. @@ -10,7 +10,7 @@ Represents a bounding box for a detected object in an image. > **x1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L13) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L13) The x-coordinate of the bottom-left corner of the bounding box. @@ -20,7 +20,7 @@ The x-coordinate of the bottom-left corner of the bounding box. > **x2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L14) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L14) The x-coordinate of the top-right corner of the bounding box. @@ -30,7 +30,7 @@ The x-coordinate of the top-right corner of the bounding box. > **y1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L15) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L15) The y-coordinate of the bottom-left corner of the bounding box. @@ -40,6 +40,6 @@ The y-coordinate of the bottom-left corner of the bounding box. > **y2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L16) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L16) The y-coordinate of the top-right corner of the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md index 7701830ac..0597ad996 100644 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -1,6 +1,6 @@ # Interface: ChatConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:168](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L168) +Defined in: [packages/react-native-executorch/src/types/llm.ts:171](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L171) Object configuring chat management. @@ -10,7 +10,7 @@ Object configuring chat management. > **contextWindowLength**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:170](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L170) +Defined in: [packages/react-native-executorch/src/types/llm.ts:173](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L173) The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. @@ -20,7 +20,7 @@ The number of messages from the current conversation that the model will use to > **initialMessageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:169](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L169) +Defined in: [packages/react-native-executorch/src/types/llm.ts:172](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L172) An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. @@ -30,6 +30,6 @@ An array of `Message` objects that represent the conversation history. This can > **systemPrompt**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:171](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L171) +Defined in: [packages/react-native-executorch/src/types/llm.ts:174](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L174) Often used to tell the model what is its purpose, for example - "Be a helpful translator". diff --git a/docs/docs/06-api-reference/interfaces/ClassificationProps.md b/docs/docs/06-api-reference/interfaces/ClassificationProps.md index 61a97ddfb..cd98ac888 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationProps.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationProps.md @@ -1,6 +1,6 @@ # Interface: ClassificationProps -Defined in: [packages/react-native-executorch/src/types/classification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L11) +Defined in: [packages/react-native-executorch/src/types/classification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L11) Props for the `useClassification` hook. @@ -10,7 +10,7 @@ Props for the `useClassification` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L12) +Defined in: [packages/react-native-executorch/src/types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L13) +Defined in: [packages/react-native-executorch/src/types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ClassificationType.md b/docs/docs/06-api-reference/interfaces/ClassificationType.md index 4c4354b2c..a747c795a 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationType.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationType.md @@ -1,6 +1,6 @@ # Interface: ClassificationType -Defined in: [packages/react-native-executorch/src/types/classification.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L20) +Defined in: [packages/react-native-executorch/src/types/classification.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L20) Return type for the `useClassification` hook. Manages the state and operations for Computer Vision image classification. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image classification. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/classification.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L39) +Defined in: [packages/react-native-executorch/src/types/classification.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/classification.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L24) +Defined in: [packages/react-native-executorch/src/types/classification.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during classification. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: [packages/react-native-executorch/src/types/classification.ts:47](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L47) +Defined in: [packages/react-native-executorch/src/types/classification.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L47) Executes the model's forward pass to classify the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L34) +Defined in: [packages/react-native-executorch/src/types/classification.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L34) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/classification.ts#L29) +Defined in: [packages/react-native-executorch/src/types/classification.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L29) Indicates whether the classification model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md index 800809eda..3bc9aca5f 100644 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -1,6 +1,6 @@ # Interface: DecodingOptions -Defined in: [packages/react-native-executorch/src/types/stt.ts:169](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L169) +Defined in: [packages/react-native-executorch/src/types/stt.ts:169](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L169) Options for decoding speech to text. @@ -10,6 +10,6 @@ Options for decoding speech to text. > `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:170](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L170) +Defined in: [packages/react-native-executorch/src/types/stt.ts:170](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L170) Optional language code to guide the transcription. diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md index 30356a459..719b249c6 100644 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -1,6 +1,6 @@ # Interface: Detection -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L26) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L26) Represents a detected object within an image, including its bounding box, label, and confidence score. @@ -10,7 +10,7 @@ Represents a detected object within an image, including its bounding box, label, > **bbox**: [`Bbox`](Bbox.md) -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L27) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L27) The bounding box of the detected object, defined by its top-left (x1, y1) and bottom-right (x2, y2) coordinates. @@ -20,7 +20,7 @@ The bounding box of the detected object, defined by its top-left (x1, y1) and bo > **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L28) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L28) The class label of the detected object, represented as a key from the `CocoLabel` enum. @@ -30,6 +30,6 @@ The class label of the detected object, represented as a key from the `CocoLabel > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L29) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L29) The confidence score of the detection, typically ranging from 0 to 1. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md index f956e0af0..008a4a69d 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleProps -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L10) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L10) Props for the `useExecutorchModule` hook. @@ -10,7 +10,7 @@ Props for the `useExecutorchModule` hook. > **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L11) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L11) The source of the ExecuTorch model binary. @@ -20,6 +20,6 @@ The source of the ExecuTorch model binary. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L12) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L12) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md index d51157913..c382518a1 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleType -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L19) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L19) Return type for the `useExecutorchModule` hook. Manages the state and core execution methods for a general ExecuTorch model. @@ -11,7 +11,7 @@ Manages the state and core execution methods for a general ExecuTorch model. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L38) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L38) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L23) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L23) Contains the error object if the model failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`inputTensor`) => `Promise`\<[`TensorPtr`](TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L46) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L46) Executes the model's forward pass with the provided input tensors. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another request. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:33](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L33) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L33) Indicates whether the model is currently processing a forward pass. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing a forward pass. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/executorchModule.ts#L28) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L28) Indicates whether the ExecuTorch model binary has successfully loaded into memory and is ready for inference. diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md index 384e01001..a7ff71733 100644 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -1,6 +1,6 @@ # Interface: GenerationConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:195](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L195) +Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L198) Object configuring generation settings. @@ -10,7 +10,7 @@ Object configuring generation settings. > `optional` **batchTimeInterval**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L199) +Defined in: [packages/react-native-executorch/src/types/llm.ts:202](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L202) Upper limit on the time interval between consecutive token batches. @@ -20,7 +20,7 @@ Upper limit on the time interval between consecutive token batches. > `optional` **outputTokenBatchSize**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L198) +Defined in: [packages/react-native-executorch/src/types/llm.ts:201](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L201) Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). @@ -30,7 +30,7 @@ Soft upper limit on the number of tokens in each token batch (in certain cases t > `optional` **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:196](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L196) +Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L199) Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. @@ -40,6 +40,6 @@ Scales output logits by the inverse of temperature. Controls the randomness / cr > `optional` **topp**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:197](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L197) +Defined in: [packages/react-native-executorch/src/types/llm.ts:200](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L200) Only samples from the smallest set of tokens whose cumulative probability exceeds topp. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md index 113ab2bca..c8f156fc2 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L11) Props for the `useImageEmbeddings` hook. @@ -10,7 +10,7 @@ Props for the `useImageEmbeddings` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md index 80bd2459a..55c790620 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L20) Return type for the `useImageEmbeddings` hook. Manages the state and operations for generating image embeddings (feature vectors) used in Computer Vision tasks. @@ -11,7 +11,7 @@ Manages the state and operations for generating image embeddings (feature vector > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L39) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during embedding generation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:47](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L47) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L47) Executes the model's forward pass to generate embeddings (a feature vector) for the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L34) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L34) Indicates whether the model is currently generating embeddings for an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently generating embeddings for an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageEmbeddings.ts#L29) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L29) Indicates whether the image embeddings model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md index eaa735f63..39662d317 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md @@ -1,6 +1,6 @@ # Interface: ImageSegmentationProps -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:37](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L37) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L40) Props for the `useImageSegmentation` hook. @@ -10,7 +10,7 @@ Props for the `useImageSegmentation` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:38](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L38) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L41) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L39) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L42) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md index 1d5e5d18a..f493c7612 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md @@ -1,6 +1,6 @@ # Interface: ImageSegmentationType -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L46) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L49) Return type for the `useImageSegmentation` hook. Manages the state and operations for Computer Vision image segmentation (e.g., DeepLab). @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image segmentation (e.g., D > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:65](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L65) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L68) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:50](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L50) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L53) Contains the error object if the model failed to load, download, or encountered a runtime error during segmentation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `classesOfInterest?`, `resize?`) => `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:75](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L75) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L78) Executes the model's forward pass to perform semantic segmentation on the provided image. @@ -71,7 +71,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L60) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:63](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L63) Indicates whether the model is currently processing an image. @@ -81,6 +81,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:55](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/imageSegmentation.ts#L55) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L58) Indicates whether the segmentation model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/KokoroConfig.md b/docs/docs/06-api-reference/interfaces/KokoroConfig.md index b39fbcacd..6556efa96 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroConfig.md +++ b/docs/docs/06-api-reference/interfaces/KokoroConfig.md @@ -1,6 +1,6 @@ # Interface: KokoroConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:43](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L43) +Defined in: [packages/react-native-executorch/src/types/tts.ts:43](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L43) Kokoro model configuration. Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. @@ -11,7 +11,7 @@ Only the core Kokoro model sources, as phonemizer sources are included in voice > **durationPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L45) +Defined in: [packages/react-native-executorch/src/types/tts.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L45) source to Kokoro's duration predictor model binary @@ -21,7 +21,7 @@ source to Kokoro's duration predictor model binary > **synthesizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tts.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L46) source to Kokoro's synthesizer model binary @@ -31,6 +31,6 @@ source to Kokoro's synthesizer model binary > **type**: `"kokoro"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:44](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L44) +Defined in: [packages/react-native-executorch/src/types/tts.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L44) model type identifier diff --git a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md index 7726f19fa..32f30b41c 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md +++ b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md @@ -1,6 +1,6 @@ # Interface: KokoroVoiceExtras -Defined in: [packages/react-native-executorch/src/types/tts.ts:30](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L30) +Defined in: [packages/react-native-executorch/src/types/tts.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L30) Kokoro-specific voice extra props @@ -10,7 +10,7 @@ Kokoro-specific voice extra props > **lexiconSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:32](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L32) +Defined in: [packages/react-native-executorch/src/types/tts.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L32) source to Kokoro's lexicon binary @@ -20,6 +20,6 @@ source to Kokoro's lexicon binary > **taggerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:31](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L31) +Defined in: [packages/react-native-executorch/src/types/tts.ts:31](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L31) source to Kokoro's tagger model binary diff --git a/docs/docs/06-api-reference/interfaces/LLMConfig.md b/docs/docs/06-api-reference/interfaces/LLMConfig.md index 44a8ce623..563d43d60 100644 --- a/docs/docs/06-api-reference/interfaces/LLMConfig.md +++ b/docs/docs/06-api-reference/interfaces/LLMConfig.md @@ -1,6 +1,6 @@ # Interface: LLMConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L93) +Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L93) Configuration object for initializing and customizing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Configuration object for initializing and customizing a Large Language Model (LL > `optional` **chatConfig**: `Partial`\<[`ChatConfig`](ChatConfig.md)\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:103](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L103) +Defined in: [packages/react-native-executorch/src/types/llm.ts:103](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L103) Object configuring chat management, contains following properties: @@ -26,7 +26,7 @@ Object configuring chat management, contains following properties: > `optional` **generationConfig**: [`GenerationConfig`](GenerationConfig.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:127](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L127) +Defined in: [packages/react-native-executorch/src/types/llm.ts:127](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L127) Object configuring generation settings. @@ -44,7 +44,7 @@ Object configuring generation settings. > `optional` **toolsConfig**: [`ToolsConfig`](ToolsConfig.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L114) +Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L114) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md index 31f6864c2..c31aa9207 100644 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -1,6 +1,6 @@ # Interface: LLMType -Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L6) +Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L6) React hook for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ React hook for managing a Large Language Model (LLM) instance. > **configure**: (`configuration`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L48) +Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L48) Configures chat and tool calling. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -33,7 +33,7 @@ Configuration object containing `chatConfig`, `toolsConfig`, and `generationConf > **deleteMessage**: (`index`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:82](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L82) +Defined in: [packages/react-native-executorch/src/types/llm.ts:82](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L82) Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. @@ -55,7 +55,7 @@ The index of the message to delete from history. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L35) +Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L35) Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. @@ -65,7 +65,7 @@ Represents the download progress as a value between 0 and 1, indicating the exte > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L40) +Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L40) Contains the error message if the model failed to load. @@ -75,7 +75,7 @@ Contains the error message if the model failed to load. > **generate**: (`messages`, `tools?`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:67](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L67) +Defined in: [packages/react-native-executorch/src/types/llm.ts:67](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L67) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -103,7 +103,7 @@ Optional array of tools that can be used during generation. > **getGeneratedTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L59) +Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L59) Returns the number of tokens generated so far in the current generation. @@ -119,7 +119,7 @@ The count of generated tokens. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:87](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L87) +Defined in: [packages/react-native-executorch/src/types/llm.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L87) Function to interrupt the current inference. @@ -133,7 +133,7 @@ Function to interrupt the current inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L30) +Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L30) Indicates whether the model is currently generating a response. @@ -143,7 +143,7 @@ Indicates whether the model is currently generating a response. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L25) +Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L25) Indicates whether the model is ready. @@ -153,7 +153,7 @@ Indicates whether the model is ready. > **messageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L10) +Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L10) History containing all messages in conversation. This field is updated after model responds to sendMessage. @@ -163,7 +163,7 @@ History containing all messages in conversation. This field is updated after mod > **response**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L15) +Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L15) State of the generated response. This field is updated with each token generated by the model. @@ -173,7 +173,7 @@ State of the generated response. This field is updated with each token generated > **sendMessage**: (`message`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:75](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L75) +Defined in: [packages/react-native-executorch/src/types/llm.ts:75](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L75) Function to add user message to conversation. After model responds, `messageHistory` will be updated with both user message and model response. @@ -196,6 +196,6 @@ The message string to send. > **token**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L20) +Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L20) The most recently generated token. diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md index 720034e19..8f754f88b 100644 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -1,6 +1,6 @@ # Interface: Message -Defined in: [packages/react-native-executorch/src/types/llm.ts:141](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L141) +Defined in: [packages/react-native-executorch/src/types/llm.ts:141](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L141) Represents a message in the conversation. @@ -10,7 +10,7 @@ Represents a message in the conversation. > **content**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L143) +Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L143) Content of the message. @@ -20,6 +20,6 @@ Content of the message. > **role**: [`MessageRole`](../type-aliases/MessageRole.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L142) +Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L142) Role of the message sender of type `MessageRole`. diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md index eefe3dd55..9b813e3b0 100644 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -1,6 +1,6 @@ # Interface: OCRDetection -Defined in: [packages/react-native-executorch/src/types/ocr.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L13) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L13) OCRDetection represents a single detected text instance in an image, including its bounding box, recognized text, and confidence score. @@ -11,7 +11,7 @@ including its bounding box, recognized text, and confidence score. > **bbox**: [`Point`](Point.md)[] -Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L14) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L14) An array of points defining the bounding box around the detected text. @@ -21,7 +21,7 @@ An array of points defining the bounding box around the detected text. > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L16) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L16) The confidence score of the OCR detection, ranging from 0 to 1. @@ -31,6 +31,6 @@ The confidence score of the OCR detection, ranging from 0 to 1. > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L15) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L15) The recognized text within the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/OCRProps.md b/docs/docs/06-api-reference/interfaces/OCRProps.md index 0a4005d1f..b62c62874 100644 --- a/docs/docs/06-api-reference/interfaces/OCRProps.md +++ b/docs/docs/06-api-reference/interfaces/OCRProps.md @@ -1,6 +1,6 @@ # Interface: OCRProps -Defined in: [packages/react-native-executorch/src/types/ocr.ts:33](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L33) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L33) Configuration properties for the `useOCR` hook. @@ -14,7 +14,7 @@ Configuration properties for the `useOCR` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L37) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L37) Object containing the necessary model sources and configuration for the OCR pipeline. @@ -42,7 +42,7 @@ The language configuration enum for the OCR model (e.g., English, Polish, etc.). > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L58) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L58) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/OCRType.md b/docs/docs/06-api-reference/interfaces/OCRType.md index c83319021..e05a0ccdc 100644 --- a/docs/docs/06-api-reference/interfaces/OCRType.md +++ b/docs/docs/06-api-reference/interfaces/OCRType.md @@ -1,6 +1,6 @@ # Interface: OCRType -Defined in: [packages/react-native-executorch/src/types/ocr.ts:76](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L76) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L76) Return type for the `useOCR` hook. Manages the state and operations for Optical Character Recognition (OCR). @@ -11,7 +11,7 @@ Manages the state and operations for Optical Character Recognition (OCR). > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:95](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L95) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:95](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L95) Represents the total download progress of the model binaries as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the total download progress of the model binaries as a value between > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L80) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L80) Contains the error object if the models failed to load, download, or encountered a runtime error during recognition. @@ -31,7 +31,7 @@ Contains the error object if the models failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<[`OCRDetection`](OCRDetection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L103) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L103) Executes the OCR pipeline (detection and recognition) on the provided image. @@ -59,7 +59,7 @@ If the models are not loaded or are currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:90](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L90) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:90](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L90) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:85](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L85) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:85](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L85) Indicates whether both detector and recognizer models are loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md index 7c547fa37..ddc7d16f7 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionProps -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:135](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L135) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:135](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L135) Props for the `useObjectDetection` hook. @@ -10,7 +10,7 @@ Props for the `useObjectDetection` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:136](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L136) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:136](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L136) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:137](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L137) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:137](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L137) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md index 826fcd2a4..d7298642c 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionType -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:144](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L144) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:144](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L144) Return type for the `useObjectDetection` hook. Manages the state and operations for Computer Vision object detection tasks. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision object detection tasks. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:163](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L163) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:163](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L163) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:148](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L148) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:148](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L148) Contains the error object if the model failed to load, download, or encountered a runtime error during detection. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `detectionThreshold?`) => `Promise`\<[`Detection`](Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:172](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L172) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:172](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L172) Executes the model's forward pass to detect objects within the provided image. @@ -65,7 +65,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:158](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L158) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:158](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L158) Indicates whether the model is currently processing an image. @@ -75,6 +75,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:153](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/objectDetection.ts#L153) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:153](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L153) Indicates whether the object detection model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/Point.md b/docs/docs/06-api-reference/interfaces/Point.md index 7246dfb12..76ec0087d 100644 --- a/docs/docs/06-api-reference/interfaces/Point.md +++ b/docs/docs/06-api-reference/interfaces/Point.md @@ -1,6 +1,6 @@ # Interface: Point -Defined in: [packages/react-native-executorch/src/types/ocr.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L25) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L25) Point represents a coordinate in 2D space. @@ -10,7 +10,7 @@ Point represents a coordinate in 2D space. > **x**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L26) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L26) The x-coordinate of the point. @@ -20,6 +20,6 @@ The x-coordinate of the point. > **y**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L27) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L27) The y-coordinate of the point. diff --git a/docs/docs/06-api-reference/interfaces/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index d9b6fdbf2..e01cac4b0 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,6 @@ # Interface: Segment -Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L22) +Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L22) Represents a detected audio segment with start and end timestamps. @@ -10,7 +10,7 @@ Represents a detected audio segment with start and end timestamps. > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L24) +Defined in: [packages/react-native-executorch/src/types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L24) End time of the segment in seconds. @@ -20,6 +20,6 @@ End time of the segment in seconds. > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:23](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L23) +Defined in: [packages/react-native-executorch/src/types/vad.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L23) Start time of the segment in seconds. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md index 7236a1c61..f1a3c834c 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextModelConfig -Defined in: [packages/react-native-executorch/src/types/stt.ts:176](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L176) +Defined in: [packages/react-native-executorch/src/types/stt.ts:176](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L176) Configuration for Speech to Text model. @@ -10,7 +10,7 @@ Configuration for Speech to Text model. > **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:190](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L190) +Defined in: [packages/react-native-executorch/src/types/stt.ts:190](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L190) A string that specifies the location of a `.pte` file for the decoder. @@ -20,7 +20,7 @@ A string that specifies the location of a `.pte` file for the decoder. > **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:185](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L185) +Defined in: [packages/react-native-executorch/src/types/stt.ts:185](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L185) A string that specifies the location of a `.pte` file for the encoder. @@ -30,7 +30,7 @@ A string that specifies the location of a `.pte` file for the encoder. > **isMultilingual**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:180](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L180) +Defined in: [packages/react-native-executorch/src/types/stt.ts:180](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L180) A boolean flag indicating whether the model supports multiple languages. @@ -40,6 +40,6 @@ A boolean flag indicating whether the model supports multiple languages. > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:195](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L195) +Defined in: [packages/react-native-executorch/src/types/stt.ts:195](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L195) A string that specifies the location to the tokenizer for the model. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md index 6247e5d4a..416389bc5 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextType -Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L7) +Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L7) React hook for managing Speech to Text (STT) instance. @@ -10,7 +10,7 @@ React hook for managing Speech to Text (STT) instance. > **committedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L32) +Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L32) Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. @@ -21,7 +21,7 @@ Useful for displaying stable results during streaming. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L26) +Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L26) Tracks the progress of the model download process. @@ -31,7 +31,7 @@ Tracks the progress of the model download process. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L11) +Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L11) Contains the error message if the model failed to load. @@ -41,7 +41,7 @@ Contains the error message if the model failed to load. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L21) +Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L21) Indicates whether the model is currently processing an inference. @@ -51,7 +51,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L16) +Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L16) Indicates whether the model has successfully loaded and is ready for inference. @@ -61,7 +61,7 @@ Indicates whether the model has successfully loaded and is ready for inference. > **nonCommittedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L38) +Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L38) Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. @@ -72,7 +72,7 @@ Useful for displaying live, partial results during streaming. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L53) +Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L53) Runs the decoder of the model. Passing `number[]` is deprecated. @@ -102,7 +102,7 @@ A promise resolving to the decoded text. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L45) +Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L45) Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. @@ -126,7 +126,7 @@ A promise resolving to the encoded data. > **stream**(`options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L71) +Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L71) Starts a streaming transcription process. Use in combination with streamInsert to feed audio chunks and streamStop to end the stream. @@ -152,7 +152,7 @@ The final transcription string. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L78) +Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L78) Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Passing `number[]` is deprecated. @@ -175,7 +175,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L83) +Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L83) Stops the ongoing streaming transcription process. @@ -189,7 +189,7 @@ Stops the ongoing streaming transcription process. > **transcribe**(`waveform`, `options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L62) +Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L62) Starts a transcription process for a given input array, which should be a waveform at 16kHz. Passing `number[]` is deprecated. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md index 92eebaeeb..b36a8b9c9 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md @@ -1,6 +1,6 @@ # Interface: StyleTransferProps -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L11) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L11) Configuration properties for the `useStyleTransfer` hook. @@ -10,7 +10,7 @@ Configuration properties for the `useStyleTransfer` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L12) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L12) Object containing the `modelSource` for the style transfer model. @@ -24,6 +24,6 @@ Object containing the `modelSource` for the style transfer model. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L13) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L13) 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 f49c80fd4..8c2105fe7 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferType.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferType.md @@ -1,6 +1,6 @@ # Interface: StyleTransferType -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L20) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L20) Return type for the `useStyleTransfer` hook. Manages the state and operations for applying artistic style transfer to images. @@ -11,7 +11,7 @@ Manages the state and operations for applying artistic style transfer to images. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L39) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L39) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:24](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L24) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L24) Contains the error object if the model failed to load, download, or encountered a runtime error during style transfer. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:47](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L47) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L47) Executes the model's forward pass to apply the specific artistic style to the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L34) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L34) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/styleTransfer.ts#L29) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L29) Indicates whether the style transfer model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md index a7c8650ac..317f4e53a 100644 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -1,6 +1,6 @@ # Interface: TensorPtr -Defined in: [packages/react-native-executorch/src/types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L61) +Defined in: [packages/react-native-executorch/src/types/common.ts:127](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L127) Represents a pointer to a tensor, including its data buffer, size dimensions, and scalar type. @@ -10,7 +10,7 @@ Represents a pointer to a tensor, including its data buffer, size dimensions, an > **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:62](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L62) +Defined in: [packages/react-native-executorch/src/types/common.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L128) The data buffer of the tensor. @@ -20,7 +20,7 @@ The data buffer of the tensor. > **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:64](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L64) +Defined in: [packages/react-native-executorch/src/types/common.ts:130](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L130) The scalar type of the tensor, as defined in the `ScalarType` enum. @@ -30,6 +30,6 @@ The scalar type of the tensor, as defined in the `ScalarType` enum. > **sizes**: `number`[] -Defined in: [packages/react-native-executorch/src/types/common.ts:63](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L63) +Defined in: [packages/react-native-executorch/src/types/common.ts:129](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L129) An array representing the size of each dimension of the tensor. diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md index a09beb9cd..94e88722a 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:45](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L45) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L45) Props for the useTextEmbeddings hook. @@ -10,7 +10,7 @@ Props for the useTextEmbeddings hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L46) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L46) An object containing the model and tokenizer sources. @@ -28,6 +28,6 @@ An object containing the model and tokenizer sources. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L50) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L50) 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 7c201807c..8db7b95da 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) React hook state and methods for managing a Text Embeddings model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Text Embeddings model instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) Tracks the progress of the model download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the model download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) Contains the error message if the model failed to load or during inference. @@ -30,7 +30,7 @@ Contains the error message if the model failed to load or during inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) Indicates whether the model is currently generating embeddings. @@ -40,7 +40,7 @@ Indicates whether the model is currently generating embeddings. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) Indicates whether the embeddings model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the embeddings model has successfully loaded and is ready for > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) Runs the text embeddings model on the provided input string. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageParams.md b/docs/docs/06-api-reference/interfaces/TextToImageParams.md index 9a7b3fcad..ba35bcc97 100644 --- a/docs/docs/06-api-reference/interfaces/TextToImageParams.md +++ b/docs/docs/06-api-reference/interfaces/TextToImageParams.md @@ -1,6 +1,6 @@ # Interface: TextToImageParams -Defined in: [packages/react-native-executorch/src/types/tti.ts:7](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L7) +Defined in: [packages/react-native-executorch/src/types/tti.ts:7](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L7) Configuration properties for the `useTextToImage` hook. @@ -10,7 +10,7 @@ Configuration properties for the `useTextToImage` hook. > `optional` **inferenceCallback**: (`stepIdx`) => `void` -Defined in: [packages/react-native-executorch/src/types/tti.ts:29](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L29) +Defined in: [packages/react-native-executorch/src/types/tti.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L29) Optional callback function that is triggered after each diffusion inference step. Useful for updating a progress bar during image generation. @@ -33,7 +33,7 @@ The index of the current inference step. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/tti.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L11) +Defined in: [packages/react-native-executorch/src/types/tti.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L11) Object containing the required model sources for the diffusion pipeline. @@ -73,7 +73,7 @@ Source for the UNet (noise predictor) model binary. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:35](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L35) +Defined in: [packages/react-native-executorch/src/types/tti.ts:35](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L35) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageType.md b/docs/docs/06-api-reference/interfaces/TextToImageType.md index dee5ca206..436a21c7d 100644 --- a/docs/docs/06-api-reference/interfaces/TextToImageType.md +++ b/docs/docs/06-api-reference/interfaces/TextToImageType.md @@ -1,6 +1,6 @@ # Interface: TextToImageType -Defined in: [packages/react-native-executorch/src/types/tti.ts:42](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L42) +Defined in: [packages/react-native-executorch/src/types/tti.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L42) Return type for the `useTextToImage` hook. Manages the state and operations for generating images from text prompts using a diffusion model pipeline. @@ -11,7 +11,7 @@ Manages the state and operations for generating images from text prompts using a > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tti.ts:61](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L61) +Defined in: [packages/react-native-executorch/src/types/tti.ts:61](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L61) Represents the total download progress of all the model binaries combined, as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the total download progress of all the model binaries combined, as a > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tti.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tti.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L46) Contains the error object if any of the pipeline models failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if any of the pipeline models failed to load, download > **generate**: (`input`, `imageSize?`, `numSteps?`, `seed?`) => `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tti.ts:72](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L72) +Defined in: [packages/react-native-executorch/src/types/tti.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L72) Runs the diffusion pipeline to generate an image from the provided text prompt. @@ -77,7 +77,7 @@ If the model is not loaded or is currently generating another image. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/tti.ts:82](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L82) +Defined in: [packages/react-native-executorch/src/types/tti.ts:82](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L82) Interrupts the currently active image generation process at the next available inference step. @@ -91,7 +91,7 @@ Interrupts the currently active image generation process at the next available i > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:56](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L56) +Defined in: [packages/react-native-executorch/src/types/tti.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L56) Indicates whether the model is currently generating an image. @@ -101,6 +101,6 @@ Indicates whether the model is currently generating an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:51](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tti.ts#L51) +Defined in: [packages/react-native-executorch/src/types/tti.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L51) Indicates whether the entire diffusion pipeline is loaded into memory and ready for generation. diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md index b423a03dc..284d8e2ca 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:56](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L56) +Defined in: [packages/react-native-executorch/src/types/tts.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L56) General Text to Speech module configuration @@ -14,7 +14,7 @@ General Text to Speech module configuration > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L57) +Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L57) a selected T2S model @@ -24,6 +24,6 @@ a selected T2S model > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L58) +Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L58) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md index e1a7a1118..e1637ff47 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L78) +Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L78) Text to Speech module input definition @@ -14,7 +14,7 @@ Text to Speech module input definition > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L80) +Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L80) optional speed argument - the higher it is, the faster the speech becomes @@ -24,6 +24,6 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L79) +Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L79) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md index 70ba14721..59d59ebc7 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechProps -Defined in: [packages/react-native-executorch/src/types/tts.ts:68](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L68) +Defined in: [packages/react-native-executorch/src/types/tts.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L68) Props for the useTextToSpeech hook. @@ -14,7 +14,7 @@ Props for the useTextToSpeech hook. > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L57) +Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L57) a selected T2S model @@ -28,7 +28,7 @@ a selected T2S model > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:69](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L69) +Defined in: [packages/react-native-executorch/src/types/tts.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L69) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. @@ -38,7 +38,7 @@ Boolean that can prevent automatic model loading (and downloading the data if yo > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L58) +Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L58) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md index 108fc5109..e2df7c691 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechStreamingInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:142](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L142) +Defined in: [packages/react-native-executorch/src/types/tts.ts:142](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L142) Text to Speech streaming input definition @@ -19,7 +19,7 @@ Callbacks can be both synchronous or asynchronous. > `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:143](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L143) +Defined in: [packages/react-native-executorch/src/types/tts.ts:143](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L143) Called when streaming begins @@ -33,7 +33,7 @@ Called when streaming begins > `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:145](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L145) +Defined in: [packages/react-native-executorch/src/types/tts.ts:145](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L145) Called when streaming ends @@ -47,7 +47,7 @@ Called when streaming ends > `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:144](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L144) +Defined in: [packages/react-native-executorch/src/types/tts.ts:144](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L144) Called after each audio chunk gets calculated. @@ -67,7 +67,7 @@ Called after each audio chunk gets calculated. > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L80) +Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L80) optional speed argument - the higher it is, the faster the speech becomes @@ -81,7 +81,7 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L79) +Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L79) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md index 3efd004c4..22ffa9db4 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechType -Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L87) +Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L87) Return type for the `useTextToSpeech` hook. Manages the state and operations for Text-to-Speech generation. @@ -11,7 +11,7 @@ Manages the state and operations for Text-to-Speech generation. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:106](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L106) +Defined in: [packages/react-native-executorch/src/types/tts.ts:106](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L106) Represents the download progress of the model and voice assets as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model and voice assets as a value betwee > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tts.ts:91](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L91) +Defined in: [packages/react-native-executorch/src/types/tts.ts:91](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L91) Contains the error object if the model failed to load or encountered an error during inference. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load or encountered an error du > **forward**: (`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L114) +Defined in: [packages/react-native-executorch/src/types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L114) Runs the model to convert the provided text into speech audio in a single pass. * @@ -60,7 +60,7 @@ If the model is not loaded or is currently generating. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:101](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L101) +Defined in: [packages/react-native-executorch/src/types/tts.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L101) Indicates whether the model is currently generating audio. @@ -70,7 +70,7 @@ Indicates whether the model is currently generating audio. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:96](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L96) +Defined in: [packages/react-native-executorch/src/types/tts.ts:96](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L96) Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. @@ -80,7 +80,7 @@ Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. > **stream**: (`input`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:123](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L123) +Defined in: [packages/react-native-executorch/src/types/tts.ts:123](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L123) Streams the generated audio data incrementally. This is optimal for real-time playback, allowing audio to start playing before the full text is synthesized. @@ -110,7 +110,7 @@ If the model is not loaded or is currently generating. > **streamStop**: () => `void` -Defined in: [packages/react-native-executorch/src/types/tts.ts:128](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L128) +Defined in: [packages/react-native-executorch/src/types/tts.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L128) Interrupts and stops the currently active audio generation stream. diff --git a/docs/docs/06-api-reference/interfaces/TokenizerType.md b/docs/docs/06-api-reference/interfaces/TokenizerType.md index 305229ab7..5b40632ce 100644 --- a/docs/docs/06-api-reference/interfaces/TokenizerType.md +++ b/docs/docs/06-api-reference/interfaces/TokenizerType.md @@ -1,6 +1,6 @@ # Interface: TokenizerType -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L6) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L6) React hook state and methods for managing a Tokenizer instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Tokenizer instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L25) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L25) Tracks the progress of the tokenizer download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the tokenizer download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L10) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L10) Contains the error message if the tokenizer failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the tokenizer failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L20) Indicates whether the tokenizer is currently processing data. @@ -40,7 +40,7 @@ Indicates whether the tokenizer is currently processing data. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L15) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L15) Indicates whether the tokenizer has successfully loaded and is ready for use. @@ -50,7 +50,7 @@ Indicates whether the tokenizer has successfully loaded and is ready for use. > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:33](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L33) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L33) Converts an array of token IDs into a string. @@ -80,7 +80,7 @@ A promise resolving to the decoded text string. > **encode**(`text`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L40) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L40) Converts a string into an array of token IDs. @@ -104,7 +104,7 @@ A promise resolving to an array `number[]` containing the encoded token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L46) Returns the size of the tokenizer's vocabulary. @@ -120,7 +120,7 @@ A promise resolving to the vocabulary size. > **idToToken**(`id`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:53](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L53) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L53) Returns the token associated to the ID. @@ -144,7 +144,7 @@ A promise resolving to the token string representation. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tokenizer.ts#L60) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L60) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md index 400532b94..4ae31dd09 100644 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -1,6 +1,6 @@ # Interface: ToolCall -Defined in: [packages/react-native-executorch/src/types/llm.ts:152](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L152) +Defined in: [packages/react-native-executorch/src/types/llm.ts:152](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L152) Represents a tool call made by the model. @@ -10,7 +10,7 @@ Represents a tool call made by the model. > **arguments**: `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L154) +Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L154) The arguments passed to the tool. @@ -20,6 +20,6 @@ The arguments passed to the tool. > **toolName**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:153](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L153) +Defined in: [packages/react-native-executorch/src/types/llm.ts:153](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L153) The name of the tool being called. diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md index 6354840b0..ecc23fc3f 100644 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -1,6 +1,6 @@ # Interface: ToolsConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:181](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L181) +Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L184) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. @@ -10,7 +10,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > `optional` **displayToolCalls**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L184) +Defined in: [packages/react-native-executorch/src/types/llm.ts:187](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L187) If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. @@ -20,7 +20,7 @@ If set to true, JSON tool calls will be displayed in chat. If false, only answer > **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L183) +Defined in: [packages/react-native-executorch/src/types/llm.ts:186](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L186) Function that accepts `ToolCall`, executes tool and returns the string to model. @@ -40,6 +40,6 @@ Function that accepts `ToolCall`, executes tool and returns the string to model. > **tools**: `Object`[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:182](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L182) +Defined in: [packages/react-native-executorch/src/types/llm.ts:185](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L185) List of objects defining tools. diff --git a/docs/docs/06-api-reference/interfaces/VADProps.md b/docs/docs/06-api-reference/interfaces/VADProps.md index 017fd75db..42a4768eb 100644 --- a/docs/docs/06-api-reference/interfaces/VADProps.md +++ b/docs/docs/06-api-reference/interfaces/VADProps.md @@ -1,6 +1,6 @@ # Interface: VADProps -Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L11) +Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L11) Props for the useVAD hook. @@ -10,7 +10,7 @@ Props for the useVAD hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L12) +Defined in: [packages/react-native-executorch/src/types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L12) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L13) +Defined in: [packages/react-native-executorch/src/types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/VADType.md b/docs/docs/06-api-reference/interfaces/VADType.md index 1d8e6682a..bcd434177 100644 --- a/docs/docs/06-api-reference/interfaces/VADType.md +++ b/docs/docs/06-api-reference/interfaces/VADType.md @@ -1,6 +1,6 @@ # Interface: VADType -Defined in: [packages/react-native-executorch/src/types/vad.ts:30](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L30) +Defined in: [packages/react-native-executorch/src/types/vad.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L30) React hook state and methods for managing a Voice Activity Detection (VAD) model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Voice Activity Detection (VAD) model > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:49](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L49) +Defined in: [packages/react-native-executorch/src/types/vad.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L49) Represents the download progress as a value between 0 and 1. @@ -20,7 +20,7 @@ Represents the download progress as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L34) +Defined in: [packages/react-native-executorch/src/types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L34) Contains the error message if the VAD model failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the VAD model failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:44](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L44) +Defined in: [packages/react-native-executorch/src/types/vad.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L44) Indicates whether the model is currently processing an inference. @@ -40,7 +40,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:39](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L39) +Defined in: [packages/react-native-executorch/src/types/vad.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L39) Indicates whether the VAD model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the VAD model has successfully loaded and is ready for inferen > **forward**(`waveform`): `Promise`\<[`Segment`](Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/types/vad.ts:57](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/vad.ts#L57) +Defined in: [packages/react-native-executorch/src/types/vad.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L57) Runs the Voice Activity Detection model on the provided audio waveform. diff --git a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md index 43435d73c..64b5af713 100644 --- a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md +++ b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md @@ -1,6 +1,6 @@ # Interface: VerticalOCRProps -Defined in: [packages/react-native-executorch/src/types/ocr.ts:64](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L64) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L64) Configuration properties for the `useVerticalOCR` hook. @@ -14,7 +14,7 @@ Configuration properties for the `useVerticalOCR` hook. > `optional` **independentCharacters**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:69](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L69) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L69) Boolean indicating whether to treat each character independently during recognition. Defaults to `false`. @@ -25,7 +25,7 @@ Defaults to `false`. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L37) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L37) Object containing the necessary model sources and configuration for the OCR pipeline. @@ -57,7 +57,7 @@ The language configuration enum for the OCR model (e.g., English, Polish, etc.). > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L58) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L58) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/VoiceConfig.md b/docs/docs/06-api-reference/interfaces/VoiceConfig.md index 501cd2b54..177b3c950 100644 --- a/docs/docs/06-api-reference/interfaces/VoiceConfig.md +++ b/docs/docs/06-api-reference/interfaces/VoiceConfig.md @@ -1,6 +1,6 @@ # Interface: VoiceConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L18) +Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L18) Voice configuration @@ -12,7 +12,7 @@ So far in Kokoro, each voice is directly associated with a language. > `optional` **extra**: [`KokoroVoiceExtras`](KokoroVoiceExtras.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L21) +Defined in: [packages/react-native-executorch/src/types/tts.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L21) an optional extra sources or properties related to specific voice @@ -22,7 +22,7 @@ an optional extra sources or properties related to specific voice > **lang**: [`TextToSpeechLanguage`](../type-aliases/TextToSpeechLanguage.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L19) +Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L19) speaker's language @@ -32,6 +32,6 @@ speaker's language > **voiceSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L20) a source to a binary file with voice embedding diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md index 6abc9796a..f6e4468d6 100644 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -2,4 +2,8 @@ > **LLMTool** = `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:159](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L159) +Defined in: [packages/react-native-executorch/src/types/llm.ts:162](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L162) + +Represents a tool that can be used by the model. +Usually tool is represented with dictionary (Object), but fields depend on the model. +Unfortunately there's no one standard so it's hard to type it better. diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md index 90f5665ef..f32bacf1e 100644 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -2,6 +2,6 @@ > **MessageRole** = `"user"` \| `"assistant"` \| `"system"` -Defined in: [packages/react-native-executorch/src/types/llm.ts:133](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L133) +Defined in: [packages/react-native-executorch/src/types/llm.ts:133](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L133) Roles that a message sender can have. diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md index 1fa3e3c70..d96ec4c7f 100644 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -2,6 +2,6 @@ > **OCRLanguage** = keyof *typeof* `symbols` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:109](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/ocr.ts#L109) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:109](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L109) Enumeration of supported OCR languages based on available symbol sets. diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md index 222d1a151..15b5ba230 100644 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -2,6 +2,6 @@ > **ResourceSource** = `string` \| `number` \| `object` -Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L8) +Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L8) Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md index 3a7e2c1e4..cfa34aeee 100644 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -2,4 +2,4 @@ > **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/stt.ts#L87) +Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L87) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md index 0465d7310..a8f23981b 100644 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -2,6 +2,6 @@ > **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` -Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/common.ts#L41) +Defined in: [packages/react-native-executorch/src/types/common.ts:107](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L107) Represents the data buffer of a tensor, which can be one of several typed array formats. diff --git a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md index e80668111..d96ebd220 100644 --- a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md @@ -2,4 +2,4 @@ > **TextToSpeechLanguage** = `"en-us"` \| `"en-gb"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:5](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/tts.ts#L5) +Defined in: [packages/react-native-executorch/src/types/tts.ts:5](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L5) 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 03a244767..fd4d948ff 100644 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MINILM\_L6\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L408) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L408) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md index 961de5037..a38fd98ee 100644 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MPNET\_BASE\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L413) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L413) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md index d8f90c883..a540f837a 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_256**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L442) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L442) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index 629ac9c94..3fbe99b47 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_512**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L434) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L434) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index fa0ebd271..e5395268f 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_IMAGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md index 3bc003a7b..4ccd8ba8d 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_TEXT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L428) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L428) ## 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 c5b72259f..95203dff7 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: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L385) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L385) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md index 2d5db19d0..ac003b529 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -2,4 +2,6 @@ > `const` **DEFAULT\_CHAT\_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/llmDefaults.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/llmDefaults.ts#L39) + +Default chat configuration for Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md index 3ac239dd3..55e38ab11 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md @@ -2,4 +2,6 @@ > `const` **DEFAULT\_CONTEXT\_WINDOW\_LENGTH**: `5` = `5` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:19](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/llmDefaults.ts#L19) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/llmDefaults.ts#L34) + +Default context window length for Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md index e4f9ffecb..5f446a4dc 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -2,4 +2,6 @@ > `const` **DEFAULT\_MESSAGE\_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:17](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/llmDefaults.ts#L17) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/llmDefaults.ts#L29) + +Default message history for Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md index f64365f89..c5b7146cc 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -2,4 +2,6 @@ > `const` **DEFAULT\_SYSTEM\_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:3](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/llmDefaults.ts#L3) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) + +Default system prompt used to guide the behavior of Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md index 217d60708..fb28e25a8 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -2,7 +2,7 @@ > `const` **EFFICIENTNET\_V2\_S**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L260) ## 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 e53edeb21..976ddbc92 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -2,7 +2,7 @@ > `const` **FSMN\_VAD**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L453) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L453) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md index 73a8cc39f..7fa4e1e99 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L108) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L108) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md index 6894487ad..5856bcae8 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L114) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L114) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md index a7600c5b0..341da2021 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L120) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L120) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md index 6f63d298c..75e8d9d86 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L126) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L126) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md index 2978373e3..afebcc246 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L132) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L132) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md index 24bd67826..1c236d14d 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L138) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L138) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md index 1729438ba..ba7bca64d 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_MEDIUM**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/models.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/models.ts#L22) A standard Kokoro instance which processes the text in batches of maximum 128 tokens. diff --git a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md index fe69659dc..f0d86b795 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/models.ts#L13) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/models.ts#L13) A Kokoro model instance which processes the text in batches of maximum 64 tokens. Uses significant less memory than the medium model, but could produce diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md index 0479afa0e..c08419a1a 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_HEART**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L21) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md index fb049b869..1049c5b99 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_RIVER**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L26) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L26) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md index 363085831..637e91f63 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_SARAH**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L31) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L31) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md index 49dc6f9ab..05dd07676 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_ADAM**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L36) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L36) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md index 4652f5732..4f41025ef 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_MICHAEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L41) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md index e46728035..2a36ef9da 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_SANTA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L46) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md index eaaf952ab..3b07350b7 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BF\_EMMA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L51) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L51) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md index 725471a8e..d9b46f884 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BM\_DANIEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/tts/voices.ts#L56) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L56) 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 657735992..0c05386ab 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L34) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L34) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md index 88495bf03..d773c37c8 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L40) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L40) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md index ca5a96c38..afc0f99ef 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L46) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md index 85a845ec1..46a2ee7e4 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L16) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L16) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md index 057d46cb9..ffa7ccf2d 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L22) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md index 65ed4d2b6..1100cf692 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L28) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L28) ## 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 d18bc7cd2..a38328a4d 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MINILM\_L6\_COS\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L418) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L418) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md index 18a957970..eea1b0a05 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MPNET\_BASE\_DOT\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md index 4c2b0934d..3fa222c27 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L41) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md index 763fedd92..3917f772f 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L47) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L47) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md index 9e4339c96..d4ecd585e 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L53) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L53) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md index c8c782200..f427287cb 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L362) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L362) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md index 54a356b1e..cb107db78 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L59) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L59) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md index 68f3cb17a..1b8ba2454 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L65) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L65) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md index 67a2d2651..6d98938f4 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L71) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L71) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md index 663a5338c..1fcec9b2b 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L83) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L83) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md index c79c6e870..05a81f84b 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L77) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L77) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md index fada7875b..3f9805175 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L98) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L98) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md index 1f1ee45d8..e5aa2f626 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L164) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L164) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md index 889b2cc6e..54508ffeb 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L104) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L104) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md index 084d478f4..f43f7f4fa 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L116) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L116) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md index c3cbe8ecc..b582f6806 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L122) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L122) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md index eb7eef1ed..5b6bdea46 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L284) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md index 59b7b0b7d..9349837fa 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L134) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L134) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md index 39702d4c4..00d73109b 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L146) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L146) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md index 3e85b31aa..6be6d33cd 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L152) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L152) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md index 9118243b7..6a66fe18e 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L128) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L128) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md index f31c99172..865dcc4bc 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L170) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L170) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md index 9928b477f..f0ab55d80 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L188) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L188) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md index 563e02c21..c9b8363ca 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L176) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L176) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md index 42eaf6cf2..a7e602db8 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L182) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L182) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md index 6ea0fa771..c75328247 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L158) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L158) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md index 6b67279b5..e2548b127 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L194) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L194) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md index da0192001..6e53d9b5b 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md index 06b034e62..498f40e7f 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md index 6c8410fd9..798387db1 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md index 1224d71f0..63ee199e8 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md index 97fda3225..4fa0a63b1 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md index 18f46a853..98dab6e3f 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L236) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L236) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md index 95858dd22..2e118ef0e 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md index 058286756..7867b633f 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L254) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L254) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md index af71ec53b..5db1a8807 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md index 6b79914cb..0cf16635f 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md index 4a448645a..904f38f0a 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L272) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L272) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md index fb1b591a5..8c5e0f83f 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L278) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L278) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md index 7c6093790..5d86d6d77 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L260) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md index e3bbd6463..b1117e0d8 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L266) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L266) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md index 599f08661..3c1d47f12 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L290) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L290) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md index 14849ff3b..e951048fa 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L296) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L296) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md index 59cc4d4b7..c68e62311 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L302) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md index d4d050d66..c79e59eee 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L308) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L308) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md index a4617209e..c4994fa35 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L314) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L314) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md index 3e934614c..1e973e9b1 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L320) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L320) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md index 3ef0e9a29..58ef3c335 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L326) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L326) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md index f35673979..fa0d99a88 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L332) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L332) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md index f20421131..75fc2d552 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L341) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L341) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md index 151d9333a..996d11b08 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L89) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L89) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md index e3055f62b..308af7fe3 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L350) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L350) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md index bda4f5cdd..c9f9b5cbb 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L356) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L356) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md index 0d80c21f3..49f059185 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L140) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L140) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md index f587ea388..cef9353fb 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L374) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L374) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md index a099db354..a6e2740bd 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md index bd67b978f..1e652f408 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L380) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L380) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md index 172dcf90c..bf47c6c9d 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L398) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L398) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md index f98afe9e7..1d51dce04 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L392) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md index 8776a1192..0beffca9c 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L386) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L386) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md index 7094d3c1b..0aff0adeb 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L404) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L404) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md index bd162681b..878bf4fab 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L410) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L410) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md index 19360f419..b809c5471 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L416) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L416) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md index 6acf0d26b..4871ae830 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L422) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L422) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md index 31867f210..1f4fd9c4c 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L110) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L110) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md index 516666e7e..f6e2c47a1 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L242) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md index 759a6cb47..603b8c4c2 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L248) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md index 8ccfefb2b..868dd9ce1 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L200) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md index 0eb61c045..24aaa8cf4 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md index 3ea925143..94474ab2a 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L212) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md index 52b70043b..cc468b6f6 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L218) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md index 3eedcaaab..53702b1a6 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L224) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md index 449e6abfd..4a7146912 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L230) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md index 2ff5476cb..dbe417ced 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L62) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L62) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md index 1ff92ba53..6d6247340 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L68) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L68) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md index 92c036106..3c8540f41 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L74) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L74) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md index f15a3c73d..96f4d77bd 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L80) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L80) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index a902df578..78658b9dd 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L86) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L86) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md index 0525e65d2..4ff16e34c 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L92) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L92) ## 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 27a0f93ad..5edad9990 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L154) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L154) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md index 52434e3aa..704c03b61 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L160) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L160) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md index bc5f48271..d2900cd1d 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L178) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L178) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md index 94390d03e..a3d5c3d9a 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L184) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L184) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md index 5f0f59c6f..12485aba7 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L166) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L166) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md index 63a41d066..b2d545d13 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L172) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L172) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md index 08e8799a1..4635b1cac 100644 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -2,7 +2,7 @@ > `const` **SPECIAL\_TOKENS**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:202](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/types/llm.ts#L202) +Defined in: [packages/react-native-executorch/src/types/llm.ts:205](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L205) ## Type Declaration 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 d2fe5c90b..49b32b6ee 100644 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `const` **SSDLITE\_320\_MOBILENET\_V3\_LARGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L267) ## 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 5ca9786da..9f431fcfd 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_CANDY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L289) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L289) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md index f90bb9fd6..855997348 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_MOSAIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L293) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L293) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md index 2b915cac5..53792959b 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_RAIN\_PRINCESS**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md index b9677f850..5be727258 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_UDNIE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L301) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L301) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md index bf36e3b4c..59b040ac0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L42) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L42) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md index 6e6c30701..2dd637a63 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L48) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L48) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md index 72b515c91..7b0627a7f 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L54) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L54) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md index 99c611ca9..1c0a1ec46 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L363) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L363) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md index 0bf26aa2d..c7b36a7de 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L60) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L60) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md index bcb5ea577..8a932fa0b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L66) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L66) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md index ace29f99b..4658b6f46 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L72) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L72) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md index 309934de9..eba795a8a 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L84) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L84) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md index b6bf2b83d..b16107a25 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L78) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L78) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md index 75aa7904a..1dba4a134 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L99) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L99) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md index a4b879a65..61a26bf7b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L165) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L165) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md index 409bb16a8..b577ea666 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L105) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L105) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md index 51fa69ae3..249b24a6d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L117) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L117) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md index 5cda0fc80..a8f271179 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L123) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L123) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md index 907c56b9e..cd4c8d921 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L285) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L285) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md index d8b97097e..b98287d08 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L135) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L135) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md index 0c7ba8517..be008b59b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L147) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L147) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md index 84add4d1d..f87a20193 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L153) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L153) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md index 53df487d9..c3697458d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L129) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L129) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md index fe7193f4a..a142a2932 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L171) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L171) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md index 7e05b2df9..cd747da33 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L189) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L189) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md index 8240a8243..448f9df04 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L177) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L177) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md index ec4f0f173..6adf0f724 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L183) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L183) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md index 1b2e45ab0..3c7b9f863 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L159) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L159) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md index 833c7c052..87cd99a22 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L195) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L195) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md index 5bb22d0ab..de58c5588 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L201) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L201) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md index b15e9c4de..af7bb2ca7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L213) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L213) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md index 849faad42..dc580d62e 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L207) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L207) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md index 5d422cf26..01c731cce 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L219) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L219) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md index d3ebe60d9..4ba4dc669 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L225) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L225) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md index c752d3125..59749c45b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L237) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L237) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md index 4d5596c0c..c09ec141d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L231) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L231) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md index 87b508d2e..8ed6339c7 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L255) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L255) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md index 3ba0f0b48..027cc06aa 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L243) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L243) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md index 4a2dfe1e1..aa916c56d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L249) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L249) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md index 27bdd5e12..52b0b0119 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L273) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L273) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md index 061b510d1..ad9578731 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L279) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L279) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md index 88643f94a..1079a7529 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L261) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L261) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md index de1ed3161..2465a328b 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L267) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md index 0694d9f0f..09d8a49bd 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L291) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L291) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md index 6dae18aec..287b7823d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md index a5172b473..5767b25d4 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L303) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L303) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md index 26c052990..2835d5d47 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L309) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L309) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md index e2a67a61d..6b7f0fcbf 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L315) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L315) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md index b7abc31bd..75b72f7f8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L321) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L321) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md index ae2d5887a..ebb0febfc 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L327) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L327) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md index 1901edb1c..92f104c26 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L336) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L336) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md index 458dcb1b9..50482bdf8 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L345) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L345) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md index 8862d5e6b..f1599ebe6 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L93) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L93) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md index c2a744ea3..428fe61a4 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L351) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L351) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md index 8588e9d0c..020ff3437 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L357) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L357) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md index b48506347..a94ba6434 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L141) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L141) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md index 1bc36e48d..8e7b14dcf 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md index 5cde0e029..3c977a235 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L369) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L369) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md index eebae30b5..b410bc688 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L381) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L381) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md index 76035f70b..542a41e69 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L399) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L399) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md index b11464f5e..ba87affbb 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L393) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L393) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md index ad1a34ac2..7d917f93d 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L387) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L387) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md index 51abd6e86..fc8d0d3ae 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L405) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L405) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md index b9afdef40..8c6e183a0 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L411) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L411) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md index 29dd37960..88e360fcc 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L417) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L417) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md index e747aa76d..47f7b95c3 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L423) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md index 960e7dcd2..327700266 100644 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **VERTICAL\_OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/ocr/models.ts#L111) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L111) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md index 29f055ccd..aaa1e030c 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L368) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md index 79447d772..4c30911d8 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L347) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L347) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md index c03fece88..afa3ed256 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L375) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md index ff6c8919c..adca5de74 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L354) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L354) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md index 23fd86a13..45a57bd04 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L361) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L361) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md index c81ec5090..4c0e00ecf 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L333) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L333) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md index 24263911b..0770d0d67 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/constants/modelUrls.ts#L340) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L340) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md index fc6e92a23..d5fddcfad 100644 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -2,7 +2,7 @@ > `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] -Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/378038b2ca252093c86e64cbbe998c6201d1ff7a/packages/react-native-executorch/src/utils/llm.ts#L9) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/llm.ts#L9) ## Parameters diff --git a/packages/react-native-executorch/common/rnexecutorch/ErrorCodes.h b/packages/react-native-executorch/common/rnexecutorch/ErrorCodes.h index 2a95ce847..fa6137930 100644 --- a/packages/react-native-executorch/common/rnexecutorch/ErrorCodes.h +++ b/packages/react-native-executorch/common/rnexecutorch/ErrorCodes.h @@ -9,33 +9,27 @@ namespace rnexecutorch { enum class RnExecutorchErrorCode : int32_t { /** - * An umbrella-error that is thrown usually when something unexpected happens, - * for example a 3rd-party library error. + * An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. */ UnknownError = 101, /** - * Thrown when a user tries to run a model that is not yet downloaded or - * loaded into memory. + * Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. */ ModuleNotLoaded = 102, /** - * An error ocurred when saving a file. This could be, for instance a result - * image from an image model. + * An error ocurred when saving a file. This could be, for instance a result image from an image model. */ FileWriteFailed = 103, /** - * Thrown when a user tries to run a model that is currently processing. It is - * only allowed to run a single model prediction at a time. + * Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. */ ModelGenerating = 104, /** - * Thrown when a language is passed to a multi-language model that is not - * supported. For example OCR or Speech To Text. + * Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. */ LanguageNotSupported = 105, /** - * Thrown when config parameters passed to a model are invalid. For example, - * when LLM's topp is outside of range [0, 1]. + * Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. */ InvalidConfig = 112, /** @@ -43,8 +37,7 @@ enum class RnExecutorchErrorCode : int32_t { */ InvalidModelSource = 255, /** - * Thrown when the number of passed inputs to the model is different than the - * model metadata specifies. + * Thrown when the number of passed inputs to the model is different than the model metadata specifies. */ UnexpectedNumInputs = 97, /** @@ -52,8 +45,7 @@ enum class RnExecutorchErrorCode : int32_t { */ ThreadPoolError = 113, /** - * Thrown when a file read operation failed. This could be invalid image url - * passed to image models, or unsupported format. + * Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. */ FileReadFailed = 114, /** @@ -61,43 +53,35 @@ enum class RnExecutorchErrorCode : int32_t { */ InvalidModelOutput = 115, /** - * Thrown when the dimensions of input tensors don't match the model's - * expected dimensions. + * Thrown when the dimensions of input tensors don't match the model's expected dimensions. */ WrongDimensions = 116, /** - * Thrown when the input passed to our APIs is invalid, for example when - * passing an empty message aray to LLM's generate(). + * Thrown when the input passed to our APIs is invalid, for example when passing an empty message aray to LLM's generate(). */ InvalidUserInput = 117, /** - * Thrown when the number of downloaded files is unexpected, due to download - * interruptions. + * Thrown when the number of downloaded files is unexpected, due to download interruptions. */ DownloadInterrupted = 118, /** - * Thrown when there's a configuration mismatch between multilingual and - * language settings in Speech-to-Text models. + * Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. */ MultilingualConfiguration = 160, /** - * Thrown when streaming transcription is attempted but audio data chunk is - * missing. + * Thrown when streaming transcription is attempted but audio data chunk is missing. */ MissingDataChunk = 161, /** - * Thrown when trying to stop or insert data into a stream that hasn't been - * started. + * Thrown when trying to stop or insert data into a stream that hasn't been started. */ StreamingNotStarted = 162, /** - * Thrown when trying to start a new streaming session while another is - * already in progress. + * Thrown when trying to start a new streaming session while another is already in progress. */ StreamingInProgress = 163, /** - * Thrown when a resource fails to download. This could be due to invalid URL, - * or for example a network problem. + * Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. */ ResourceFetcherDownloadFailed = 180, /** @@ -113,8 +97,7 @@ enum class RnExecutorchErrorCode : int32_t { */ ResourceFetcherAlreadyOngoing = 183, /** - * Thrown when trying to pause, resume, or cancel a download that is not - * active. + * Thrown when trying to pause, resume, or cancel a download that is not active. */ ResourceFetcherNotActive = 184, /** diff --git a/packages/react-native-executorch/src/constants/llmDefaults.ts b/packages/react-native-executorch/src/constants/llmDefaults.ts index d58648855..2d0555991 100644 --- a/packages/react-native-executorch/src/constants/llmDefaults.ts +++ b/packages/react-native-executorch/src/constants/llmDefaults.ts @@ -1,8 +1,17 @@ import { ChatConfig, Message } from '../types/llm'; +/** + * Default system prompt used to guide the behavior of Large Language Models (LLMs). + */ export const DEFAULT_SYSTEM_PROMPT = "You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."; +/** + * Generates a default structured output prompt based on the provided JSON schema. + * + * @param structuredOutputSchema - A string representing the JSON schema for the desired output format. + * @returns A prompt string instructing the model to format its output according to the given schema. + */ export const DEFAULT_STRUCTURED_OUTPUT_PROMPT = ( structuredOutputSchema: string ) => `The output should be formatted as a JSON instance that conforms to the JSON schema below. @@ -14,10 +23,19 @@ Here is the output schema: ${structuredOutputSchema} `; +/** + * Default message history for Large Language Models (LLMs). + */ export const DEFAULT_MESSAGE_HISTORY: Message[] = []; +/** + * Default context window length for Large Language Models (LLMs). + */ export const DEFAULT_CONTEXT_WINDOW_LENGTH = 5; +/** + * Default chat configuration for Large Language Models (LLMs). + */ export const DEFAULT_CHAT_CONFIG: ChatConfig = { systemPrompt: DEFAULT_SYSTEM_PROMPT, initialMessageHistory: DEFAULT_MESSAGE_HISTORY, diff --git a/packages/react-native-executorch/src/constants/ocr/symbols.ts b/packages/react-native-executorch/src/constants/ocr/symbols.ts index aaf2241e2..e122958c6 100644 --- a/packages/react-native-executorch/src/constants/ocr/symbols.ts +++ b/packages/react-native-executorch/src/constants/ocr/symbols.ts @@ -19,6 +19,9 @@ export const alphabets = { '0123456789!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZಂಃಅಆಇಈಉಊಋಎಏಐಒಓಔಕಖಗಘಙಚಛಜಝಞಟಠಡಢಣತಥದಧನಪಫಬಭಮಯರಲಳವಶಷಸಹಾಿೀುೂೃೆೇೈೊೋೌ್೦೧೨೩೪೫೬೭೮೯', }; +/** + * Mapping of language codes to their corresponding symbol sets. + */ export const symbols = { // Abaza abq: alphabets.cyrillic, diff --git a/packages/react-native-executorch/src/errors/ErrorCodes.ts b/packages/react-native-executorch/src/errors/ErrorCodes.ts index a3e6e28ee..26378f9b1 100644 --- a/packages/react-native-executorch/src/errors/ErrorCodes.ts +++ b/packages/react-native-executorch/src/errors/ErrorCodes.ts @@ -51,7 +51,7 @@ export enum RnExecutorchErrorCode { */ WrongDimensions = 116, /** - * Thrown when the input passed to our APIs is invalid, for example when passing an empty message array to LLM's generate(). + * Thrown when the input passed to our APIs is invalid, for example when passing an empty message aray to LLM's generate(). */ InvalidUserInput = 117, /** @@ -98,22 +98,76 @@ export enum RnExecutorchErrorCode { * Thrown when required URI information is missing for a download operation. */ ResourceFetcherMissingUri = 185, + /** + * Status indicating a successful operation. + */ Ok = 0, + /** + * An internal error occurred. + */ Internal = 1, + /** + * Status indicating the executor is in an invalid state for a targeted operation. + */ InvalidState = 2, + /** + * Status indicating there are no more steps of execution to run + */ EndOfMethod = 3, + /** + * Operation is not supported in the current context. + */ NotSupported = 16, + /** + * Operation is not yet implemented. + */ NotImplemented = 17, + /** + * User provided an invalid argument. + */ InvalidArgument = 18, + /** + * Object is an invalid type for the operation. + */ InvalidType = 19, + /** + * Operator(s) missing in the operator registry. + */ OperatorMissing = 20, + /** + * Requested resource could not be found. + */ NotFound = 32, + /** + * Could not allocate the requested memory. + */ MemoryAllocationFailed = 33, + /** + * Could not access a resource. + */ AccessFailed = 34, + /** + * Error caused by the contents of a program. + */ InvalidProgram = 35, + /** + * Error caused by the contents of external data. + */ InvalidExternalData = 36, + /** + * Does not have enough resources to perform the requested operation. + */ OutOfResources = 37, + /** + * Init stage: Backend receives an incompatible delegate version. + */ DelegateInvalidCompatibility = 48, + /** + * Init stage: Backend fails to allocate memory. + */ DelegateMemoryAllocationFailed = 49, + /** + * Execute stage: The handle is invalid. + */ DelegateInvalidHandle = 50, } 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 772beeded..dfdeffa6c 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts @@ -4,7 +4,17 @@ import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; import { BaseModule } from '../BaseModule'; +/** + * Module for style transfer tasks. + */ export class StyleTransferModule extends BaseModule { + /** + * 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`. + * + * @param model - Object containing `modelSource`. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( model: { modelSource: ResourceSource }, onDownloadProgressCallback: (progress: number) => void = () => {} @@ -22,6 +32,12 @@ export class StyleTransferModule extends BaseModule { this.nativeModule = global.loadStyleTransfer(paths[0] || ''); } + /** + * Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. + * + * @param imageSource - The image source to be processed. + * @returns The stylized image as a Base64-encoded string. + */ async forward(imageSource: string): Promise { if (this.nativeModule == null) throw new RnExecutorchError( diff --git a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts b/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts index 5526fcc8e..7cb75abf4 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts @@ -6,9 +6,17 @@ import { PNG } from 'pngjs/browser'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; +/** + * Module for text-to-image generation tasks. + */ export class TextToImageModule extends BaseModule { private inferenceCallback: (stepIdx: number) => void; + /** + * Creates a new instance of `TextToImageModule` with optional callback on inference step. + * + * @param inferenceCallback - Optional callback function that receives the current step index during inference. + */ constructor(inferenceCallback?: (stepIdx: number) => void) { super(); this.inferenceCallback = (stepIdx: number) => { @@ -16,6 +24,12 @@ export class TextToImageModule extends BaseModule { }; } + /** + * Loads the model from specified resources. + * + * @param model - Object containing sources for tokenizer, scheduler, encoder, unet, and decoder. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( model: { tokenizerSource: ResourceSource; @@ -71,6 +85,16 @@ export class TextToImageModule extends BaseModule { ); } + /** + * Runs the model to generate an image described by `input`, and conditioned by `seed`, performing `numSteps` inference steps. + * The resulting image, with dimensions `imageSize`×`imageSize` pixels, is returned as a base64-encoded string. + * + * @param input - The text prompt to generate the image from. + * @param imageSize - The desired width and height of the output image in pixels. + * @param numSteps - The number of inference steps to perform. + * @param seed - An optional seed for random number generation to ensure reproducibility. + * @returns A Base64-encoded string representing the generated PNG image. + */ async forward( input: string, imageSize: number = 512, @@ -95,6 +119,9 @@ export class TextToImageModule extends BaseModule { return pngString; } + /** + * Interrupts model generation. The model is stopped in the nearest step. + */ public interrupt(): void { this.nativeModule.interrupt(); } diff --git a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts b/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts index 3eebec716..192550bd5 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts @@ -9,6 +9,15 @@ export class VerticalOCRModule { this.controller = new VerticalOCRController(); } + /** + * Loads the model, where `detectorSource` is a string that specifies the location of the detector binary, + * `recognizerSource` is a string that specifies the location of the recognizer binary, + * and `language` is a parameter that specifies the language of the text to be recognized by the OCR. + * + * @param model - Object containing `detectorSource`, `recognizerSource`, and `language`. + * @param independentCharacters - Whether to treat characters independently during recognition. + * @param onDownloadProgressCallback - Optional callback to monitor download progress. + */ async load( model: { detectorSource: ResourceSource; @@ -27,10 +36,20 @@ export class VerticalOCRModule { ); } + /** + * Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. + * + * @param imageSource - The image source to be processed. + * @returns The OCR result as a string. + */ async forward(imageSource: string) { return await this.controller.forward(imageSource); } + /** + * Release the memory held by the module. Calling `forward` afterwards is invalid. + * Note that you cannot delete model while it's generating. + */ delete() { this.controller.delete(); } diff --git a/packages/react-native-executorch/src/types/common.ts b/packages/react-native-executorch/src/types/common.ts index 088ed4d43..342c722c0 100644 --- a/packages/react-native-executorch/src/types/common.ts +++ b/packages/react-native-executorch/src/types/common.ts @@ -11,27 +11,93 @@ export type ResourceSource = string | number | object; * Enum representing the scalar types of tensors. */ export enum ScalarType { + /** + * Byte type (8-bit unsigned integer). + */ BYTE = 0, + /** + * Character type (8-bit signed integer). + */ CHAR = 1, + /** + * Short integer type (16-bit signed integer). + */ SHORT = 2, + /** + * Integer type (32-bit signed integer). + */ INT = 3, + /** + * Long integer type (64-bit signed integer). + */ LONG = 4, + /** + * Half-precision floating point type (16-bit). + */ HALF = 5, + /** + * Single-precision floating point type (32-bit). + */ FLOAT = 6, + /** + * Double-precision floating point type (64-bit). + */ DOUBLE = 7, + /** + * Boolean type. + */ BOOL = 11, + /** + * Quantized 8-bit signed integer type. + */ QINT8 = 12, + /** + * Quantized 8-bit unsigned integer type. + */ QUINT8 = 13, + /** + * Quantized 32-bit signed integer type. + */ QINT32 = 14, + /** + * Packed Quantized Unsigned 4-bit Integers type (2 number in 1 byte). + */ QUINT4X2 = 16, + /** + * Packed Quantized Unsigned 2-bit Integer type (4 numbers in 1 byte). + */ QUINT2X4 = 17, + /** + * Raw Bits type. + */ BITS16 = 22, + /** + * Quantized 8-bit floating point type: Sign bit, 5 Exponent bits, 2 Mantissa bits. + */ FLOAT8E5M2 = 23, + /** + * Quantized 8-bit floating point type: Sign bit, 4 Exponent bits, 3 Mantissa bits. + */ FLOAT8E4M3FN = 24, + /** + * Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 5 Exponent bits, 2 Mantissa bits. + */ FLOAT8E5M2FNUZ = 25, + /** + * Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 4 Exponent bits, 3 Mantissa bits. + */ FLOAT8E4M3FNUZ = 26, + /** + * Unsigned 16-bit integer type. + */ UINT16 = 27, + /** + * Unsigned 32-bit integer type. + */ UINT32 = 28, + /** + * Unsigned 64-bit integer type. + */ UINT64 = 29, } diff --git a/packages/react-native-executorch/src/types/imageSegmentation.ts b/packages/react-native-executorch/src/types/imageSegmentation.ts index 927294eab..834f50fa1 100644 --- a/packages/react-native-executorch/src/types/imageSegmentation.ts +++ b/packages/react-native-executorch/src/types/imageSegmentation.ts @@ -1,6 +1,9 @@ import { RnExecutorchError } from "../errors/errorUtils"; import { ResourceSource } from "./common"; +/** + * Labels used in the DeepLab image segmentation model. + */ /* eslint-disable @cspell/spellchecker */ export enum DeeplabLabel { BACKGROUND, diff --git a/packages/react-native-executorch/src/types/llm.ts b/packages/react-native-executorch/src/types/llm.ts index 7ccd9339b..45ada3a45 100644 --- a/packages/react-native-executorch/src/types/llm.ts +++ b/packages/react-native-executorch/src/types/llm.ts @@ -154,8 +154,11 @@ export interface ToolCall { arguments: Object; } -// usually tool is represented with dictionary (Object), but fields depend on the model -// unfortunately there's no one standard so it's hard to type it better +/** + * Represents a tool that can be used by the model. + * Usually tool is represented with dictionary (Object), but fields depend on the model. + * Unfortunately there's no one standard so it's hard to type it better. + */ export type LLMTool = Object; /** diff --git a/packages/react-native-executorch/src/utils/llm.ts b/packages/react-native-executorch/src/utils/llm.ts index 05e09c45d..146c91770 100644 --- a/packages/react-native-executorch/src/utils/llm.ts +++ b/packages/react-native-executorch/src/utils/llm.ts @@ -47,6 +47,12 @@ const filterObjectKeys = (obj: object, keysToRemove: string[]) => { return Object.fromEntries(filteredEntries); }; +/** + * Generates a structured output prompt based on the provided schema. + * + * @param responseSchema - The schema (Zod or JSON Schema) defining the desired output format. + * @returns A prompt string instructing the model to format its output according to the given schema. + */ export const getStructuredOutputPrompt = ( responseSchema: T | Schema ) => { @@ -77,7 +83,13 @@ const extractBetweenBrackets = (text: string): string => { ); }; -// this is a bit hacky typing +/** + * Fixes and validates structured output from LLMs against a provided schema. + * + * @param output - The raw output string from the LLM. + * @param responseSchema - The schema (Zod or JSON Schema) to validate the output against. + * @returns The validated and parsed output. + */ export const fixAndValidateStructuredOutput = ( output: string, responseSchema: T | Schema diff --git a/scripts/errors.config.ts b/scripts/errors.config.ts index f272211ea..0458a103d 100644 --- a/scripts/errors.config.ts +++ b/scripts/errors.config.ts @@ -106,30 +106,85 @@ export const errorDefinitions = { // ExecuTorch mapped errors // Based on: https://github.com/pytorch/executorch/blob/main/runtime/core/error.h + // System errors + /** + * Status indicating a successful operation. + */ Ok: 0x00, + /** + * An internal error occurred. + */ Internal: 0x01, + /** + * Status indicating the executor is in an invalid state for a targeted operation. + */ InvalidState: 0x02, + /** + * Status indicating there are no more steps of execution to run + */ EndOfMethod: 0x03, // Logical errors + /** + * Operation is not supported in the current context. + */ NotSupported: 0x10, + /** + * Operation is not yet implemented. + */ NotImplemented: 0x11, + /** + * User provided an invalid argument. + */ InvalidArgument: 0x12, + /** + * Object is an invalid type for the operation. + */ InvalidType: 0x13, + /** + * Operator(s) missing in the operator registry. + */ OperatorMissing: 0x14, // Resource errors + /** + * Requested resource could not be found. + */ NotFound: 0x20, + /** + * Could not allocate the requested memory. + */ MemoryAllocationFailed: 0x21, + /** + * Could not access a resource. + */ AccessFailed: 0x22, + /** + * Error caused by the contents of a program. + */ InvalidProgram: 0x23, + /** + * Error caused by the contents of external data. + */ InvalidExternalData: 0x24, + /** + * Does not have enough resources to perform the requested operation. + */ OutOfResources: 0x25, // Delegate errors + /** + * Init stage: Backend receives an incompatible delegate version. + */ DelegateInvalidCompatibility: 0x30, + /** + * Init stage: Backend fails to allocate memory. + */ DelegateMemoryAllocationFailed: 0x31, + /** + * Execute stage: The handle is invalid. + */ DelegateInvalidHandle: 0x32, } as const; From fb8c4994a25bab9bbad2c87a565a246cf0b7c346 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20S=C5=82uszniak?= Date: Wed, 28 Jan 2026 16:34:08 +0100 Subject: [PATCH 15/15] Organize docs into clean sections --- .../app/ocr_vertical/index.tsx | 4 +- .../01-natural-language-processing/useLLM.md | 99 +--- .../02-computer-vision/useVerticalOCR.md | 8 +- .../02-computer-vision/VerticalOCRModule.md | 4 +- .../classes/ClassificationModule.md | 14 +- .../classes/ExecutorchModule.md | 16 +- .../classes/ImageEmbeddingsModule.md | 14 +- .../classes/ImageSegmentationModule.md | 14 +- .../06-api-reference/classes/LLMModule.md | 24 +- .../06-api-reference/classes/OCRModule.md | 12 +- .../classes/ObjectDetectionModule.md | 14 +- .../classes/ResourceFetcher.md | 71 ++- .../classes/RnExecutorchError.md | 10 +- .../classes/SpeechToTextModule.md | 18 +- .../classes/StyleTransferModule.md | 14 +- .../classes/TextEmbeddingsModule.md | 14 +- .../classes/TextToImageModule.md | 18 +- .../classes/TextToSpeechModule.md | 14 +- .../classes/TokenizerModule.md | 18 +- .../06-api-reference/classes/VADModule.md | 16 +- .../classes/VerticalOCRModule.md | 12 +- .../enumerations/CocoLabel.md | 182 +++---- .../enumerations/DeeplabLabel.md | 46 +- .../enumerations/RnExecutorchErrorCode.md | 86 ++-- .../enumerations/ScalarType.md | 46 +- .../DEFAULT_STRUCTURED_OUTPUT_PROMPT.md | 2 +- .../fixAndValidateStructuredOutput.md | 2 +- .../functions/getStructuredOutputPrompt.md | 2 +- .../functions/useClassification.md | 2 +- .../functions/useExecutorchModule.md | 2 +- .../functions/useImageEmbeddings.md | 2 +- .../functions/useImageSegmentation.md | 2 +- .../docs/06-api-reference/functions/useLLM.md | 2 +- .../docs/06-api-reference/functions/useOCR.md | 2 +- .../functions/useObjectDetection.md | 2 +- .../functions/useSpeechToText.md | 2 +- .../functions/useStyleTransfer.md | 2 +- .../functions/useTextEmbeddings.md | 2 +- .../functions/useTextToImage.md | 2 +- .../functions/useTextToSpeech.md | 2 +- .../functions/useTokenizer.md | 2 +- .../docs/06-api-reference/functions/useVAD.md | 2 +- .../functions/useVerticalOCR.md | 2 +- docs/docs/06-api-reference/index.md | 402 ++++++++-------- docs/docs/06-api-reference/interfaces/Bbox.md | 10 +- .../06-api-reference/interfaces/ChatConfig.md | 8 +- .../interfaces/ClassificationProps.md | 6 +- .../interfaces/ClassificationType.md | 12 +- .../interfaces/DecodingOptions.md | 4 +- .../06-api-reference/interfaces/Detection.md | 8 +- .../interfaces/ExecutorchModuleProps.md | 6 +- .../interfaces/ExecutorchModuleType.md | 12 +- .../interfaces/GenerationConfig.md | 10 +- .../interfaces/ImageEmbeddingsProps.md | 6 +- .../interfaces/ImageEmbeddingsType.md | 12 +- .../interfaces/ImageSegmentationProps.md | 6 +- .../interfaces/ImageSegmentationType.md | 12 +- .../interfaces/KokoroConfig.md | 8 +- .../interfaces/KokoroVoiceExtras.md | 6 +- .../06-api-reference/interfaces/LLMConfig.md | 8 +- .../06-api-reference/interfaces/LLMType.md | 28 +- .../06-api-reference/interfaces/Message.md | 6 +- .../interfaces/OCRDetection.md | 8 +- .../06-api-reference/interfaces/OCRProps.md | 6 +- .../06-api-reference/interfaces/OCRType.md | 12 +- .../interfaces/ObjectDetectionProps.md | 6 +- .../interfaces/ObjectDetectionType.md | 12 +- .../docs/06-api-reference/interfaces/Point.md | 6 +- .../06-api-reference/interfaces/Segment.md | 6 +- .../interfaces/SpeechToTextModelConfig.md | 10 +- .../interfaces/SpeechToTextType.md | 26 +- .../interfaces/StyleTransferProps.md | 6 +- .../interfaces/StyleTransferType.md | 12 +- .../06-api-reference/interfaces/TensorPtr.md | 8 +- .../interfaces/TextEmbeddingsProps.md | 6 +- .../interfaces/TextEmbeddingsType.md | 12 +- .../interfaces/TextToImageParams.md | 8 +- .../interfaces/TextToImageType.md | 14 +- .../interfaces/TextToSpeechConfig.md | 6 +- .../interfaces/TextToSpeechInput.md | 6 +- .../interfaces/TextToSpeechProps.md | 8 +- .../interfaces/TextToSpeechStreamingInput.md | 12 +- .../interfaces/TextToSpeechType.md | 16 +- .../interfaces/TokenizerType.md | 20 +- .../06-api-reference/interfaces/ToolCall.md | 6 +- .../interfaces/ToolsConfig.md | 8 +- .../06-api-reference/interfaces/VADProps.md | 6 +- .../06-api-reference/interfaces/VADType.md | 12 +- .../interfaces/VerticalOCRProps.md | 8 +- .../interfaces/VoiceConfig.md | 8 +- .../06-api-reference/type-aliases/LLMTool.md | 2 +- .../type-aliases/MessageRole.md | 2 +- .../type-aliases/OCRLanguage.md | 2 +- .../type-aliases/ResourceSource.md | 2 +- .../type-aliases/SpeechToTextLanguage.md | 4 +- .../type-aliases/TensorBuffer.md | 2 +- .../type-aliases/TextToSpeechLanguage.md | 4 +- .../docs/06-api-reference/typedoc-sidebar.cjs | 2 +- .../variables/ALL_MINILM_L6_V2.md | 2 +- .../variables/ALL_MPNET_BASE_V2.md | 2 +- .../variables/BK_SDM_TINY_VPRED_256.md | 2 +- .../variables/BK_SDM_TINY_VPRED_512.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_IMAGE.md | 2 +- .../variables/CLIP_VIT_BASE_PATCH32_TEXT.md | 2 +- .../variables/DEEPLAB_V3_RESNET50.md | 2 +- .../variables/DEFAULT_CHAT_CONFIG.md | 2 +- .../DEFAULT_CONTEXT_WINDOW_LENGTH.md | 2 +- .../variables/DEFAULT_MESSAGE_HISTORY.md | 2 +- .../variables/DEFAULT_SYSTEM_PROMPT.md | 2 +- .../variables/EFFICIENTNET_V2_S.md | 2 +- .../06-api-reference/variables/FSMN_VAD.md | 2 +- .../variables/HAMMER2_1_0_5B.md | 2 +- .../variables/HAMMER2_1_0_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_1_5B.md | 2 +- .../variables/HAMMER2_1_1_5B_QUANTIZED.md | 2 +- .../variables/HAMMER2_1_3B.md | 2 +- .../variables/HAMMER2_1_3B_QUANTIZED.md | 2 +- .../variables/KOKORO_MEDIUM.md | 2 +- .../variables/KOKORO_SMALL.md | 2 +- .../variables/KOKORO_VOICE_AF_HEART.md | 2 +- .../variables/KOKORO_VOICE_AF_RIVER.md | 2 +- .../variables/KOKORO_VOICE_AF_SARAH.md | 2 +- .../variables/KOKORO_VOICE_AM_ADAM.md | 2 +- .../variables/KOKORO_VOICE_AM_MICHAEL.md | 2 +- .../variables/KOKORO_VOICE_AM_SANTA.md | 2 +- .../variables/KOKORO_VOICE_BF_EMMA.md | 2 +- .../variables/KOKORO_VOICE_BM_DANIEL.md | 2 +- .../06-api-reference/variables/LLAMA3_2_1B.md | 2 +- .../variables/LLAMA3_2_1B_QLORA.md | 2 +- .../variables/LLAMA3_2_1B_SPINQUANT.md | 2 +- .../06-api-reference/variables/LLAMA3_2_3B.md | 2 +- .../variables/LLAMA3_2_3B_QLORA.md | 2 +- .../variables/LLAMA3_2_3B_SPINQUANT.md | 2 +- .../variables/MULTI_QA_MINILM_L6_COS_V1.md | 2 +- .../variables/MULTI_QA_MPNET_BASE_DOT_V1.md | 2 +- .../06-api-reference/variables/OCR_ABAZA.md | 2 +- .../06-api-reference/variables/OCR_ADYGHE.md | 2 +- .../variables/OCR_AFRIKAANS.md | 2 +- .../variables/OCR_ALBANIAN.md | 2 +- .../06-api-reference/variables/OCR_AVAR.md | 2 +- .../variables/OCR_AZERBAIJANI.md | 2 +- .../variables/OCR_BELARUSIAN.md | 2 +- .../06-api-reference/variables/OCR_BOSNIAN.md | 2 +- .../variables/OCR_BULGARIAN.md | 2 +- .../06-api-reference/variables/OCR_CHECHEN.md | 2 +- .../variables/OCR_CROATIAN.md | 2 +- .../06-api-reference/variables/OCR_CZECH.md | 2 +- .../06-api-reference/variables/OCR_DANISH.md | 2 +- .../06-api-reference/variables/OCR_DARGWA.md | 2 +- .../06-api-reference/variables/OCR_DUTCH.md | 2 +- .../06-api-reference/variables/OCR_ENGLISH.md | 2 +- .../variables/OCR_ESTONIAN.md | 2 +- .../06-api-reference/variables/OCR_FRENCH.md | 2 +- .../06-api-reference/variables/OCR_GERMAN.md | 2 +- .../variables/OCR_HUNGARIAN.md | 2 +- .../variables/OCR_ICELANDIC.md | 2 +- .../variables/OCR_INDONESIAN.md | 2 +- .../06-api-reference/variables/OCR_INGUSH.md | 2 +- .../06-api-reference/variables/OCR_IRISH.md | 2 +- .../06-api-reference/variables/OCR_ITALIAN.md | 2 +- .../variables/OCR_JAPANESE.md | 2 +- .../06-api-reference/variables/OCR_KANNADA.md | 2 +- .../variables/OCR_KARBADIAN.md | 2 +- .../06-api-reference/variables/OCR_KOREAN.md | 2 +- .../06-api-reference/variables/OCR_KURDISH.md | 2 +- .../06-api-reference/variables/OCR_LAK.md | 2 +- .../06-api-reference/variables/OCR_LATIN.md | 2 +- .../06-api-reference/variables/OCR_LATVIAN.md | 2 +- .../variables/OCR_LEZGHIAN.md | 2 +- .../variables/OCR_LITHUANIAN.md | 2 +- .../06-api-reference/variables/OCR_MALAY.md | 2 +- .../06-api-reference/variables/OCR_MALTESE.md | 2 +- .../06-api-reference/variables/OCR_MAORI.md | 2 +- .../variables/OCR_MONGOLIAN.md | 2 +- .../variables/OCR_NORWEGIAN.md | 2 +- .../06-api-reference/variables/OCR_OCCITAN.md | 2 +- .../06-api-reference/variables/OCR_PALI.md | 2 +- .../06-api-reference/variables/OCR_POLISH.md | 2 +- .../variables/OCR_PORTUGUESE.md | 2 +- .../variables/OCR_ROMANIAN.md | 2 +- .../06-api-reference/variables/OCR_RUSSIAN.md | 2 +- .../variables/OCR_SERBIAN_CYRILLIC.md | 2 +- .../variables/OCR_SERBIAN_LATIN.md | 2 +- .../variables/OCR_SIMPLIFIED_CHINESE.md | 2 +- .../06-api-reference/variables/OCR_SLOVAK.md | 2 +- .../variables/OCR_SLOVENIAN.md | 2 +- .../06-api-reference/variables/OCR_SPANISH.md | 2 +- .../06-api-reference/variables/OCR_SWAHILI.md | 2 +- .../06-api-reference/variables/OCR_SWEDISH.md | 2 +- .../variables/OCR_TABASSARAN.md | 2 +- .../06-api-reference/variables/OCR_TAGALOG.md | 2 +- .../06-api-reference/variables/OCR_TAJIK.md | 2 +- .../06-api-reference/variables/OCR_TELUGU.md | 2 +- .../06-api-reference/variables/OCR_TURKISH.md | 2 +- .../variables/OCR_UKRAINIAN.md | 2 +- .../06-api-reference/variables/OCR_UZBEK.md | 2 +- .../variables/OCR_VIETNAMESE.md | 2 +- .../06-api-reference/variables/OCR_WELSH.md | 2 +- .../variables/PHI_4_MINI_4B.md | 2 +- .../variables/PHI_4_MINI_4B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_0_5B.md | 2 +- .../variables/QWEN2_5_0_5B_QUANTIZED.md | 2 +- .../variables/QWEN2_5_1_5B.md | 2 +- .../variables/QWEN2_5_1_5B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN2_5_3B.md | 2 +- .../variables/QWEN2_5_3B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_0_6B.md | 2 +- .../variables/QWEN3_0_6B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_1_7B.md | 2 +- .../variables/QWEN3_1_7B_QUANTIZED.md | 2 +- .../06-api-reference/variables/QWEN3_4B.md | 2 +- .../variables/QWEN3_4B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_135M.md | 2 +- .../variables/SMOLLM2_1_135M_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_1_7B.md | 2 +- .../variables/SMOLLM2_1_1_7B_QUANTIZED.md | 2 +- .../variables/SMOLLM2_1_360M.md | 2 +- .../variables/SMOLLM2_1_360M_QUANTIZED.md | 2 +- .../variables/SPECIAL_TOKENS.md | 4 +- .../SSDLITE_320_MOBILENET_V3_LARGE.md | 2 +- .../variables/STYLE_TRANSFER_CANDY.md | 2 +- .../variables/STYLE_TRANSFER_MOSAIC.md | 2 +- .../variables/STYLE_TRANSFER_RAIN_PRINCESS.md | 2 +- .../variables/STYLE_TRANSFER_UDNIE.md | 2 +- .../variables/VERTICAL_OCR_ABAZA.md | 19 - .../variables/VERTICAL_OCR_ADYGHE.md | 19 - .../variables/VERTICAL_OCR_AFRIKAANS.md | 19 - .../variables/VERTICAL_OCR_ALBANIAN.md | 19 - .../variables/VERTICAL_OCR_AVAR.md | 19 - .../variables/VERTICAL_OCR_AZERBAIJANI.md | 19 - .../variables/VERTICAL_OCR_BELARUSIAN.md | 19 - .../variables/VERTICAL_OCR_BOSNIAN.md | 19 - .../variables/VERTICAL_OCR_BULGARIAN.md | 19 - .../variables/VERTICAL_OCR_CHECHEN.md | 19 - .../variables/VERTICAL_OCR_CROATIAN.md | 19 - .../variables/VERTICAL_OCR_CZECH.md | 19 - .../variables/VERTICAL_OCR_DANISH.md | 19 - .../variables/VERTICAL_OCR_DARGWA.md | 19 - .../variables/VERTICAL_OCR_DUTCH.md | 19 - .../variables/VERTICAL_OCR_ENGLISH.md | 19 - .../variables/VERTICAL_OCR_ESTONIAN.md | 19 - .../variables/VERTICAL_OCR_FRENCH.md | 19 - .../variables/VERTICAL_OCR_GERMAN.md | 19 - .../variables/VERTICAL_OCR_HUNGARIAN.md | 19 - .../variables/VERTICAL_OCR_ICELANDIC.md | 19 - .../variables/VERTICAL_OCR_INDONESIAN.md | 19 - .../variables/VERTICAL_OCR_INGUSH.md | 19 - .../variables/VERTICAL_OCR_IRISH.md | 19 - .../variables/VERTICAL_OCR_ITALIAN.md | 19 - .../variables/VERTICAL_OCR_JAPANESE.md | 19 - .../variables/VERTICAL_OCR_KANNADA.md | 19 - .../variables/VERTICAL_OCR_KARBADIAN.md | 19 - .../variables/VERTICAL_OCR_KOREAN.md | 19 - .../variables/VERTICAL_OCR_KURDISH.md | 19 - .../variables/VERTICAL_OCR_LAK.md | 19 - .../variables/VERTICAL_OCR_LATIN.md | 19 - .../variables/VERTICAL_OCR_LATVIAN.md | 19 - .../variables/VERTICAL_OCR_LEZGHIAN.md | 19 - .../variables/VERTICAL_OCR_LITHUANIAN.md | 19 - .../variables/VERTICAL_OCR_MALAY.md | 19 - .../variables/VERTICAL_OCR_MALTESE.md | 19 - .../variables/VERTICAL_OCR_MAORI.md | 19 - .../variables/VERTICAL_OCR_MONGOLIAN.md | 19 - .../variables/VERTICAL_OCR_NORWEGIAN.md | 19 - .../variables/VERTICAL_OCR_OCCITAN.md | 19 - .../variables/VERTICAL_OCR_PALI.md | 19 - .../variables/VERTICAL_OCR_POLISH.md | 19 - .../variables/VERTICAL_OCR_PORTUGUESE.md | 19 - .../variables/VERTICAL_OCR_ROMANIAN.md | 19 - .../variables/VERTICAL_OCR_RUSSIAN.md | 19 - .../VERTICAL_OCR_SERBIAN_CYRILLIC.md | 19 - .../variables/VERTICAL_OCR_SERBIAN_LATIN.md | 19 - .../VERTICAL_OCR_SIMPLIFIED_CHINESE.md | 19 - .../variables/VERTICAL_OCR_SLOVAK.md | 19 - .../variables/VERTICAL_OCR_SLOVENIAN.md | 19 - .../variables/VERTICAL_OCR_SPANISH.md | 19 - .../variables/VERTICAL_OCR_SWAHILI.md | 19 - .../variables/VERTICAL_OCR_SWEDISH.md | 19 - .../variables/VERTICAL_OCR_TABASSARAN.md | 19 - .../variables/VERTICAL_OCR_TAGALOG.md | 19 - .../variables/VERTICAL_OCR_TAJIK.md | 19 - .../variables/VERTICAL_OCR_TELUGU.md | 19 - .../variables/VERTICAL_OCR_TURKISH.md | 19 - .../variables/VERTICAL_OCR_UKRAINIAN.md | 19 - .../variables/VERTICAL_OCR_UZBEK.md | 19 - .../variables/VERTICAL_OCR_VIETNAMESE.md | 19 - .../variables/VERTICAL_OCR_WELSH.md | 19 - .../variables/WHISPER_BASE.md | 2 +- .../variables/WHISPER_BASE_EN.md | 2 +- .../variables/WHISPER_SMALL.md | 2 +- .../variables/WHISPER_SMALL_EN.md | 2 +- .../variables/WHISPER_TINY.md | 2 +- .../variables/WHISPER_TINY_EN.md | 2 +- .../variables/WHISPER_TINY_EN_QUANTIZED.md | 2 +- .../variables/parseToolCall.md | 8 +- .../src/constants/llmDefaults.ts | 9 + .../src/constants/modelUrls.ts | 168 ++++++- .../src/constants/ocr/models.ts | 454 ++++++++---------- .../src/constants/tts/models.ts | 4 + .../src/constants/tts/voices.ts | 24 + .../src/errors/errorUtils.ts | 3 + .../computer_vision/useClassification.ts | 3 +- .../computer_vision/useImageEmbeddings.ts | 1 + .../computer_vision/useImageSegmentation.ts | 1 + .../src/hooks/computer_vision/useOCR.ts | 1 + .../computer_vision/useObjectDetection.ts | 1 + .../hooks/computer_vision/useStyleTransfer.ts | 1 + .../hooks/computer_vision/useTextToImage.ts | 1 + .../hooks/computer_vision/useVerticalOCR.ts | 1 + .../src/hooks/general/useExecutorchModule.ts | 1 + .../natural_language_processing/useLLM.ts | 3 +- .../useSpeechToText.ts | 1 + .../useTextEmbeddings.ts | 1 + .../useTextToSpeech.ts | 1 + .../useTokenizer.ts | 1 + .../natural_language_processing/useVAD.ts | 1 + .../computer_vision/ClassificationModule.ts | 2 + .../computer_vision/ImageEmbeddingsModule.ts | 2 + .../ImageSegmentationModule.ts | 2 + .../src/modules/computer_vision/OCRModule.ts | 5 + .../computer_vision/ObjectDetectionModule.ts | 2 + .../computer_vision/StyleTransferModule.ts | 2 + .../computer_vision/TextToImageModule.ts | 2 + .../computer_vision/VerticalOCRModule.ts | 5 + .../src/modules/general/ExecutorchModule.ts | 5 + .../natural_language_processing/LLMModule.ts | 2 + .../SpeechToTextModule.ts | 2 + .../TextEmbeddingsModule.ts | 2 + .../TextToSpeechModule.ts | 2 + .../TokenizerModule.ts | 5 + .../natural_language_processing/VADModule.ts | 5 + .../src/types/classification.ts | 3 + .../src/types/common.ts | 7 + .../src/types/executorchModule.ts | 3 + .../src/types/imageEmbeddings.ts | 3 + .../src/types/imageSegmentation.ts | 6 + .../react-native-executorch/src/types/llm.ts | 18 + .../src/types/objectDetection.ts | 7 + .../react-native-executorch/src/types/ocr.ts | 10 + .../react-native-executorch/src/types/stt.ts | 11 +- .../src/types/styleTransfer.ts | 3 + .../src/types/textEmbeddings.ts | 3 + .../src/types/tokenizer.ts | 2 + .../react-native-executorch/src/types/tti.ts | 4 + .../react-native-executorch/src/types/tts.ts | 16 +- .../react-native-executorch/src/types/vad.ts | 4 + .../src/utils/ResourceFetcher.ts | 55 +++ .../react-native-executorch/src/utils/llm.ts | 9 + 348 files changed, 1583 insertions(+), 2468 deletions(-) delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md delete mode 100644 docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md diff --git a/apps/computer-vision/app/ocr_vertical/index.tsx b/apps/computer-vision/app/ocr_vertical/index.tsx index 3e78ead6b..f298a3d5c 100644 --- a/apps/computer-vision/app/ocr_vertical/index.tsx +++ b/apps/computer-vision/app/ocr_vertical/index.tsx @@ -1,7 +1,7 @@ import Spinner from '../../components/Spinner'; import { BottomBar } from '../../components/BottomBar'; import { getImage } from '../../utils'; -import { useVerticalOCR, VERTICAL_OCR_ENGLISH } from 'react-native-executorch'; +import { useVerticalOCR, OCR_ENGLISH } from 'react-native-executorch'; import { View, StyleSheet, Image, Text, ScrollView } from 'react-native'; import ImageWithBboxes2 from '../../components/ImageWithOCRBboxes'; import React, { useContext, useEffect, useState } from 'react'; @@ -16,7 +16,7 @@ export default function VerticalOCRScree() { height: number; }>(); const model = useVerticalOCR({ - model: VERTICAL_OCR_ENGLISH, + model: OCR_ENGLISH, independentCharacters: true, }); const { setGlobalGenerating } = useContext(GeneratingContext); diff --git a/docs/docs/03-hooks/01-natural-language-processing/useLLM.md b/docs/docs/03-hooks/01-natural-language-processing/useLLM.md index 0a3bb483f..ffd407b8b 100644 --- a/docs/docs/03-hooks/01-natural-language-processing/useLLM.md +++ b/docs/docs/03-hooks/01-natural-language-processing/useLLM.md @@ -30,6 +30,10 @@ React Native ExecuTorch supports a variety of LLMs (checkout our [HuggingFace re Lower-end devices might not be able to fit LLMs into memory. We recommend using quantized models to reduce the memory footprint. ::: +## API Reference + +For detailed API Reference for `useLLM` see: [useLLM API Reference](../../06-api-reference/functions/useLLM.md) + ## Initializing In order to load a model into the app, you need to run the following code: @@ -58,101 +62,6 @@ The code snippet above fetches the model from the specified URL, loads it into m For more information on loading resources, take a look at [loading models](../../01-fundamentals/02-loading-models.md) page. -### Returns - -| Field | Type | Description | -| ------------------------ | -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `generate()` | `(messages: Message[], tools?: LLMTool[]) => Promise` | Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. | -| `interrupt()` | `() => void` | Function to interrupt the current inference. | -| `response` | `string` | State of the generated response. This field is updated with each token generated by the model. | -| `token` | `string` | The most recently generated token. | -| `isReady` | `boolean` | Indicates whether the model is ready. | -| `isGenerating` | `boolean` | Indicates whether the model is currently generating a response. | -| `downloadProgress` | `number` | Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. | -| `error` | string | null | Contains the error message if the model failed to load. | -| `configure` | `({chatConfig?: Partial, toolsConfig?: ToolsConfig, generationConfig?: GenerationConfig}) => void` | Configures chat and tool calling. See more details in [configuring the model](#configuring-the-model). | -| `sendMessage` | `(message: string) => Promise` | Function to add user message to conversation. After model responds, `messageHistory` will be updated with both user message and model response. | -| `deleteMessage` | `(index: number) => void` | Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. | -| `messageHistory` | `Message[]` | History containing all messages in conversation. This field is updated after model responds to `sendMessage`. | -| `getGeneratedTokenCount` | `() => number` | Returns the number of tokens generated in the last response. | - -
-Type definitions - -```typescript -const useLLM: ({ - model, - preventLoad, -}: { - model: { - modelSource: ResourceSource; - tokenizerSource: ResourceSource; - tokenizerConfigSource: ResourceSource; - }; - preventLoad?: boolean; -}) => LLMType; - -interface LLMType { - messageHistory: Message[]; - response: string; - token: string; - isReady: boolean; - isGenerating: boolean; - downloadProgress: number; - error: string | null; - configure: ({ - chatConfig, - toolsConfig, - generationConfig, - }: { - chatConfig?: Partial; - toolsConfig?: ToolsConfig; - generationConfig?: GenerationConfig; - }) => void; - getGeneratedTokenCount: () => number; - generate: (messages: Message[], tools?: LLMTool[]) => Promise; - sendMessage: (message: string) => Promise; - deleteMessage: (index: number) => void; - interrupt: () => void; -} - -type ResourceSource = string | number | object; - -type MessageRole = 'user' | 'assistant' | 'system'; - -interface Message { - role: MessageRole; - content: string; -} -interface ChatConfig { - initialMessageHistory: Message[]; - contextWindowLength: number; - systemPrompt: string; -} - -interface GenerationConfig { - temperature?: number; - topp?: number; - outputTokenBatchSize?: number; - batchTimeInterval?: number; -} - -// tool calling -interface ToolsConfig { - tools: LLMTool[]; - executeToolCallback: (call: ToolCall) => Promise; - displayToolCalls?: boolean; -} - -interface ToolCall { - toolName: string; - arguments: Object; -} - -type LLMTool = Object; -``` - -
## Functional vs managed diff --git a/docs/docs/03-hooks/02-computer-vision/useVerticalOCR.md b/docs/docs/03-hooks/02-computer-vision/useVerticalOCR.md index 0ff3dccd8..af4e0aaf1 100644 --- a/docs/docs/03-hooks/02-computer-vision/useVerticalOCR.md +++ b/docs/docs/03-hooks/02-computer-vision/useVerticalOCR.md @@ -15,11 +15,11 @@ It is recommended to use models provided by us, which are available at our [Hugg ## Reference ```tsx -import { useVerticalOCR, VERTICAL_OCR_ENGLISH } from 'react-native-executorch'; +import { useVerticalOCR, OCR_ENGLISH } from 'react-native-executorch'; function App() { const model = useVerticalOCR({ - model: VERTICAL_OCR_ENGLISH, + model: OCR_ENGLISH, independentCharacters: true, }); @@ -180,11 +180,11 @@ The `text` property contains the text recognized within detected text region. Th ## Example ```tsx -import { useVerticalOCR, VERTICAL_OCR_ENGLISH } from 'react-native-executorch'; +import { useVerticalOCR, OCR_ENGLISH } from 'react-native-executorch'; function App() { const model = useVerticalOCR({ - model: VERTICAL_OCR_ENGLISH, + model: OCR_ENGLISH, independentCharacters: true, }); diff --git a/docs/docs/04-typescript-api/02-computer-vision/VerticalOCRModule.md b/docs/docs/04-typescript-api/02-computer-vision/VerticalOCRModule.md index 677b82d32..d92356967 100644 --- a/docs/docs/04-typescript-api/02-computer-vision/VerticalOCRModule.md +++ b/docs/docs/04-typescript-api/02-computer-vision/VerticalOCRModule.md @@ -9,7 +9,7 @@ TypeScript API implementation of the [useVerticalOCR](../../03-hooks/02-computer ```typescript import { VerticalOCRModule, - VERTICAL_OCR_ENGLISH, + OCR_ENGLISH, } from 'react-native-executorch'; const imageUri = 'path/to/image.png'; @@ -18,7 +18,7 @@ const imageUri = 'path/to/image.png'; const verticalOCRModule = new VerticalOCRModule(); // Loading the model -await verticalOCRModule.load(VERTICAL_OCR_ENGLISH); +await verticalOCRModule.load(OCR_ENGLISH); // Running the model const detections = await verticalOCRModule.forward(imageUri); diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md index ca68dc52f..7cb913786 100644 --- a/docs/docs/06-api-reference/classes/ClassificationModule.md +++ b/docs/docs/06-api-reference/classes/ClassificationModule.md @@ -1,6 +1,6 @@ # Class: ClassificationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L12) Module for image classification tasks. @@ -28,7 +28,7 @@ Module for image classification tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:43](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L43) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -84,7 +84,7 @@ The classification result. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L18) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L20) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md index 5b6f6f133..174701ce2 100644 --- a/docs/docs/06-api-reference/classes/ExecutorchModule.md +++ b/docs/docs/06-api-reference/classes/ExecutorchModule.md @@ -1,6 +1,8 @@ # Class: ExecutorchModule -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L13) + +General module for executing custom Executorch models. ## Extends @@ -26,7 +28,7 @@ Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModu > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +60,7 @@ Unloads the model from memory. > **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L40) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L45) Executes the model's forward pass, where input is an array of `TensorPtr` objects. If the inference is successful, an array of tensor pointers is returned. @@ -83,7 +85,7 @@ An array of output tensor pointers. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -112,7 +114,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -146,7 +148,7 @@ The input shape as an array of numbers. > **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L16) +Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L21) Loads the model, where `modelSource` is a string, number, or object that specifies the location of the model binary. Optionally accepts a download progress callback. diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md index 46cf15bd5..5541edc66 100644 --- a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: ImageEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L12) Module for generating image embeddings from input images. @@ -28,7 +28,7 @@ Module for generating image embeddings from input images. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L40) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L42) Executes the model's forward pass, where `imageSource` is a URI/URL to image that will be embedded. @@ -84,7 +84,7 @@ A Float32Array containing the image embeddings. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L17) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageEmbeddingsModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L19) Loads the model, where `modelSource` is a string that specifies the location of the model binary. diff --git a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md index 560156592..051d4a5ae 100644 --- a/docs/docs/06-api-reference/classes/ImageSegmentationModule.md +++ b/docs/docs/06-api-reference/classes/ImageSegmentationModule.md @@ -1,6 +1,6 @@ # Class: ImageSegmentationModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L11) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L13) Module for image segmentation tasks. @@ -28,7 +28,7 @@ Module for image segmentation tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`, `classesOfInterest?`, `resize?`): `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L45) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:47](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L47) Executes the model's forward pass @@ -96,7 +96,7 @@ A dictionary where keys are `DeeplabLabel` and values are arrays of probabilitie > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -125,7 +125,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -159,7 +159,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ImageSegmentationModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts#L22) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md index c42d98ca6..a034bc620 100644 --- a/docs/docs/06-api-reference/classes/LLMModule.md +++ b/docs/docs/06-api-reference/classes/LLMModule.md @@ -1,6 +1,6 @@ # Class: LLMModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L14) Module for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Module for managing a Large Language Model (LLM) instance. > **new LLMModule**(`optionalCallbacks`): `LLMModule` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L23) Creates a new instance of LLMModule with optional callbacks. @@ -50,7 +50,7 @@ A new LLMModule instance. > **configure**(`configuration`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:88](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L88) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:90](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L90) Configures chat and tool calling and generation settings. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -73,7 +73,7 @@ Configuration object containing `chatConfig`, `toolsConfig`, and `generationConf > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:169](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L169) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:171](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L171) Method to delete the model from memory. Note you cannot delete model while it's generating. @@ -89,7 +89,7 @@ You need to interrupt it first and make sure model stopped generation. > **deleteMessage**(`index`): [`Message`](../interfaces/Message.md)[] -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:143](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L143) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:145](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L145) Deletes all messages starting with message on `index` position. After deletion it will call `messageHistoryCallback()` containing new history. @@ -115,7 +115,7 @@ The index of the message to delete from history. > **forward**(`input`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:105](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L105) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:107](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L107) Runs model inference with raw input string. You need to provide entire conversation and prompt (in correct format and with special tokens!) in input string to this method. @@ -142,7 +142,7 @@ The generated response as a string. > **generate**(`messages`, `tools?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:117](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L117) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:119](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L119) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -172,7 +172,7 @@ The generated response as a string. > **getGeneratedTokenCount**(): `number` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:160](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L160) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:162](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L162) Returns the number of tokens generated in the last response. @@ -188,7 +188,7 @@ The count of generated tokens. > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L151) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:153](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L153) Interrupts model generation. It may return one more token after interrupt. @@ -202,7 +202,7 @@ Interrupts model generation. It may return one more token after interrupt. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L55) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:57](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L57) Loads the LLM model and tokenizer. @@ -246,7 +246,7 @@ Optional callback to track download progress (value between 0 and 1). > **sendMessage**(`message`): `Promise`\<[`Message`](../interfaces/Message.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:130](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L130) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:132](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L132) Method to add user message to conversation. After model responds it will call `messageHistoryCallback()` containing both user message and model response. @@ -272,7 +272,7 @@ The message string to send. > **setTokenCallback**(`tokenCallback`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:74](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L74) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/LLMModule.ts:76](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L76) Sets new token callback invoked on every token batch. diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md index 195635fcc..3fc3af5e2 100644 --- a/docs/docs/06-api-reference/classes/OCRModule.md +++ b/docs/docs/06-api-reference/classes/OCRModule.md @@ -1,6 +1,8 @@ # Class: OCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L10) + +Module for Optical Character Recognition (OCR) tasks. ## Constructors @@ -8,7 +10,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **new OCRModule**(): `OCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L13) #### Returns @@ -20,7 +22,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRMo > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L50) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L55) Release the memory held by the module. Calling `forward` afterwards is invalid. Note that you cannot delete model while it's generating. @@ -35,7 +37,7 @@ Note that you cannot delete model while it's generating. > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L42) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:47](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L47) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -59,7 +61,7 @@ The OCR result as a string. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/OCRModule.ts:25](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L25) Loads the model, where `detectorSource` is a string that specifies the location of the detector binary, `recognizerSource` is a string that specifies the location of the recognizer binary, diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md index a9a0747c0..ebd0ffa10 100644 --- a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md +++ b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md @@ -1,6 +1,6 @@ # Class: ObjectDetectionModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L11) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L13) Module for object detection tasks. @@ -28,7 +28,7 @@ Module for object detection tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L45) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:47](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L47) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. `detectionThreshold` can be supplied to alter the sensitivity of the detection. @@ -91,7 +91,7 @@ An array of Detection objects representing detected items in the image. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -120,7 +120,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -154,7 +154,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ObjectDetectionModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L22) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md index 95b19b12d..5c4425015 100644 --- a/docs/docs/06-api-reference/classes/ResourceFetcher.md +++ b/docs/docs/06-api-reference/classes/ResourceFetcher.md @@ -1,6 +1,9 @@ # Class: ResourceFetcher -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L57) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:63](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L63) + +This module provides functions to download and work with downloaded files stored in the application's document directory inside the `react-native-executorch/` directory. +These utilities can help you manage your storage and clean up the downloaded files when they are no longer needed. ## Constructors @@ -18,7 +21,7 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:57](h > `static` **downloads**: `Map`\<[`ResourceSource`](../type-aliases/ResourceSource.md), `DownloadResource`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L58) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:64](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L64) ## Methods @@ -26,7 +29,9 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:58](h > `static` **cancelFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L251) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:284](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L284) + +Cancels an ongoing/paused download of files. #### Parameters @@ -34,17 +39,23 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:251]( ...[`ResourceSource`](../type-aliases/ResourceSource.md)[] +The resource identifiers used when calling `fetch()`. + #### Returns `Promise`\<`void`\> +A promise that resolves once the download is canceled. + *** ### deleteResources() > `static` **deleteResources**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L278) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:327](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L327) + +Deletes downloaded resources from the local filesystem. #### Parameters @@ -52,17 +63,23 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:278]( ...[`ResourceSource`](../type-aliases/ResourceSource.md)[] +The resource identifiers used when calling `fetch`. + #### Returns `Promise`\<`void`\> +A promise that resolves once all specified resources have been removed. + *** ### fetch() > `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L60) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:74](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L74) + +Fetches resources (remote URLs, local files or embedded assets), downloads or stores them locally for use by React Native ExecuTorch. #### Parameters @@ -70,21 +87,30 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:60](h (`downloadProgress`) => `void` +Optional callback to track progress of all downloads, reported between 0 and 1. + ##### sources ...[`ResourceSource`](../type-aliases/ResourceSource.md)[] +Multiple resources that can be strings, asset references, or objects. + #### Returns `Promise`\<`string`[] \| `null`\> +If the fetch was successful, it returns a promise which resolves to an array of local file paths for the downloaded/stored resources (without file:// prefix). +If the fetch was interrupted by `pauseFetching` or `cancelFetching`, it returns a promise which resolves to `null`. + *** ### getFilesTotalSize() > `static` **getFilesTotalSize**(...`sources`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L290) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:345](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L345) + +Fetches the info about files size. Works only for remote files. #### Parameters @@ -92,41 +118,55 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:290]( ...[`ResourceSource`](../type-aliases/ResourceSource.md)[] +The resource identifiers (URLs). + #### Returns `Promise`\<`number`\> +A promise that resolves to combined size of files in bytes. + *** ### listDownloadedFiles() > `static` **listDownloadedFiles**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:268](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L268) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:306](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L306) + +Lists all the downloaded files used by React Native ExecuTorch. #### Returns `Promise`\<`string`[]\> +A promise, which resolves to an array of URIs for all the downloaded files. + *** ### listDownloadedModels() > `static` **listDownloadedModels**(): `Promise`\<`string`[]\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:316](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L316) + +Lists all the downloaded models used by React Native ExecuTorch. #### Returns `Promise`\<`string`[]\> +A promise, which resolves to an array of URIs for all the downloaded models. + *** ### pauseFetching() > `static` **pauseFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L241) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:261](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L261) + +Pauses an ongoing download of files. #### Parameters @@ -134,17 +174,23 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:241]( ...[`ResourceSource`](../type-aliases/ResourceSource.md)[] +The resource identifiers used when calling `fetch`. + #### Returns `Promise`\<`void`\> +A promise that resolves once the download is paused. + *** ### resumeFetching() > `static` **resumeFetching**(...`sources`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L246) +Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:273](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L273) + +Resumes a paused download of files. #### Parameters @@ -152,6 +198,11 @@ Defined in: [packages/react-native-executorch/src/utils/ResourceFetcher.ts:246]( ...[`ResourceSource`](../type-aliases/ResourceSource.md)[] +The resource identifiers used when calling fetch. + #### Returns `Promise`\<`void`\> + +If the fetch was successful, it returns a promise which resolves to an array of local file paths for the downloaded resources (without file:// prefix). +If the fetch was again interrupted by `pauseFetching` or `cancelFetching`, it returns a promise which resolves to `null`. diff --git a/docs/docs/06-api-reference/classes/RnExecutorchError.md b/docs/docs/06-api-reference/classes/RnExecutorchError.md index 164880514..63c706b55 100644 --- a/docs/docs/06-api-reference/classes/RnExecutorchError.md +++ b/docs/docs/06-api-reference/classes/RnExecutorchError.md @@ -1,6 +1,8 @@ # Class: RnExecutorchError -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/errorUtils.ts#L3) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:6](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/errorUtils.ts#L6) + +Custom error class for React Native ExecuTorch errors. ## Extends @@ -12,7 +14,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:3](https: > **new RnExecutorchError**(`code`, `message`, `cause?`): `RnExecutorchError` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/errorUtils.ts#L14) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:17](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/errorUtils.ts#L17) #### Parameters @@ -42,7 +44,7 @@ Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:14](https > `optional` **cause**: `unknown` -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/errorUtils.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:15](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/errorUtils.ts#L15) The original cause of the error, if any. @@ -56,7 +58,7 @@ The original cause of the error, if any. > **code**: [`RnExecutorchErrorCode`](../enumerations/RnExecutorchErrorCode.md) -Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:7](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/errorUtils.ts#L7) +Defined in: [packages/react-native-executorch/src/errors/errorUtils.ts:10](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/errorUtils.ts#L10) The error code representing the type of error. diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md index 8720863aa..b27452f13 100644 --- a/docs/docs/06-api-reference/classes/SpeechToTextModule.md +++ b/docs/docs/06-api-reference/classes/SpeechToTextModule.md @@ -1,6 +1,6 @@ # Class: SpeechToTextModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L12) Module for Speech to Text (STT) functionalities. @@ -20,7 +20,7 @@ Module for Speech to Text (STT) functionalities. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:94](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L94) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:96](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L96) Runs the decoder of the model. Passing number[] is deprecated. @@ -50,7 +50,7 @@ Decoded output. > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L64) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L66) Unloads the model from memory. @@ -64,7 +64,7 @@ Unloads the model from memory. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:75](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L75) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:77](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L77) Runs the encoding part of the model on the provided waveform. Returns the encoded waveform as a Float32Array. Passing `number[]` is deprecated. @@ -89,7 +89,7 @@ The encoded output. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:29](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L29) Loads the model specified by the config object. `onDownloadProgressCallback` allows you to monitor the current progress of the model download. @@ -118,7 +118,7 @@ Optional callback to monitor download progress. > **stream**(`options`): `AsyncGenerator`\<\{ `committed`: `string`; `nonCommitted`: `string`; \}\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:151](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L151) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:153](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L153) Starts a streaming transcription session. Yields objects with `committed` and `nonCommitted` transcriptions. @@ -144,7 +144,7 @@ An async generator yielding transcription updates. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:211](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L211) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:213](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L213) Inserts a new audio chunk into the streaming transcription session. Passing `number[]` is deprecated. @@ -166,7 +166,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:224](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L224) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:226](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L226) Stops the current streaming transcription session. @@ -180,7 +180,7 @@ Stops the current streaming transcription session. > **transcribe**(`waveform`, `options`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:124](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L124) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/SpeechToTextModule.ts:126](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L126) Starts a transcription process for a given input array (16kHz waveform). For multilingual models, specify the language in `options`. diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md index bf2e4d487..637311211 100644 --- a/docs/docs/06-api-reference/classes/StyleTransferModule.md +++ b/docs/docs/06-api-reference/classes/StyleTransferModule.md @@ -1,6 +1,6 @@ # Class: StyleTransferModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L12) Module for style transfer tasks. @@ -28,7 +28,7 @@ Module for style transfer tasks. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`imageSource`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:43](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L43) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -84,7 +84,7 @@ The stylized image as a Base64-encoded string. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L18) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/StyleTransferModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L20) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md index 0804f9fb8..a598f7f5a 100644 --- a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md +++ b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md @@ -1,6 +1,6 @@ # Class: TextEmbeddingsModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L12) Module for generating text embeddings from input text. @@ -28,7 +28,7 @@ Module for generating text embeddings from input text. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -42,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -60,7 +60,7 @@ Unloads the model from memory. > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L53) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:55](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L55) Executes the model's forward pass, where `input` is a text that will be embedded. @@ -84,7 +84,7 @@ A Float32Array containing the vector embeddings. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -113,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -147,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextEmbeddingsModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L22) Loads the model and tokenizer specified by the config object. diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md index eb85b7b67..c17e47797 100644 --- a/docs/docs/06-api-reference/classes/TextToImageModule.md +++ b/docs/docs/06-api-reference/classes/TextToImageModule.md @@ -1,6 +1,6 @@ # Class: TextToImageModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L12) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L14) Module for text-to-image generation tasks. @@ -14,7 +14,7 @@ Module for text-to-image generation tasks. > **new TextToImageModule**(`inferenceCallback?`): `TextToImageModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L20) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L22) Creates a new instance of `TextToImageModule` with optional callback on inference step. @@ -40,7 +40,7 @@ Optional callback function that receives the current step index during inference > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -54,7 +54,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -72,7 +72,7 @@ Unloads the model from memory. > **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:98](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L98) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:100](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L100) Runs the model to generate an image described by `input`, and conditioned by `seed`, performing `numSteps` inference steps. The resulting image, with dimensions `imageSize`×`imageSize` pixels, is returned as a base64-encoded string. @@ -115,7 +115,7 @@ A Base64-encoded string representing the generated PNG image. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -144,7 +144,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -178,7 +178,7 @@ The input shape as an array of numbers. > **interrupt**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:125](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L125) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:127](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L127) Interrupts model generation. The model is stopped in the nearest step. @@ -192,7 +192,7 @@ Interrupts model generation. The model is stopped in the nearest step. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L33) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/TextToImageModule.ts:35](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L35) Loads the model from specified resources. diff --git a/docs/docs/06-api-reference/classes/TextToSpeechModule.md b/docs/docs/06-api-reference/classes/TextToSpeechModule.md index b126fe55c..6ff5ad51f 100644 --- a/docs/docs/06-api-reference/classes/TextToSpeechModule.md +++ b/docs/docs/06-api-reference/classes/TextToSpeechModule.md @@ -1,6 +1,6 @@ # Class: TextToSpeechModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L14) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L16) Module for Text to Speech (TTS) functionalities. @@ -20,7 +20,7 @@ Module for Text to Speech (TTS) functionalities. > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L18) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L20) Native module instance @@ -30,7 +30,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:164](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L164) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:166](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L166) Unloads the model from memory. @@ -44,7 +44,7 @@ Unloads the model from memory. > **forward**(`text`, `speed`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:97](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L97) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:99](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L99) Synthesizes the provided text into speech. Returns a promise that resolves to the full audio waveform as a `Float32Array`. @@ -75,7 +75,7 @@ A promise resolving to the synthesized audio waveform. > **load**(`config`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L27) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:29](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L29) Loads the model and voice assets specified by the config object. `onDownloadProgressCallback` allows you to monitor the current progress. @@ -104,7 +104,7 @@ Optional callback to monitor download progress. > **stream**(`input`): `AsyncGenerator`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:112](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L112) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:114](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L114) Starts a streaming synthesis session. Yields audio chunks as they are generated. @@ -128,7 +128,7 @@ An async generator yielding Float32Array audio chunks. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:157](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L157) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TextToSpeechModule.ts:159](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts#L159) Stops the streaming process if there is any ongoing. diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md index 5fd6929f1..c7ed096dc 100644 --- a/docs/docs/06-api-reference/classes/TokenizerModule.md +++ b/docs/docs/06-api-reference/classes/TokenizerModule.md @@ -1,6 +1,8 @@ # Class: TokenizerModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:6](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L6) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L11) + +Module for Tokenizer functionalities. ## Constructors @@ -18,7 +20,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L10) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:15](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L15) Native module instance @@ -28,7 +30,7 @@ Native module instance > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L54) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:59](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L59) Converts an array of token IDs into a string. @@ -58,7 +60,7 @@ The decoded string. > **encode**(`input`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:43](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L43) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:48](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L48) Converts a string into an array of token IDs. @@ -82,7 +84,7 @@ An array of token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:66](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L66) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:71](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L71) Returns the size of the tokenizer's vocabulary. @@ -98,7 +100,7 @@ The vocabulary size. > **idToToken**(`tokenId`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L76) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:81](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L81) Returns the token associated to the ID. @@ -122,7 +124,7 @@ The token string associated to ID. > **load**(`tokenizer`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L19) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:24](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L24) Loads the tokenizer from the specified source. `tokenizerSource` is a string that points to the location of the tokenizer JSON file. @@ -153,7 +155,7 @@ Optional callback to monitor download progress. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:86](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L86) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/TokenizerModule.ts:91](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts#L91) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md index 5c0ef83e4..8bf2ecd35 100644 --- a/docs/docs/06-api-reference/classes/VADModule.md +++ b/docs/docs/06-api-reference/classes/VADModule.md @@ -1,6 +1,8 @@ # Class: VADModule -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L13) + +Module for Voice Activity Detection (VAD) functionalities. ## Extends @@ -26,7 +28,7 @@ Defined in: [packages/react-native-executorch/src/modules/natural\_language\_pro > **nativeModule**: `any` = `null` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L8) Native module instance @@ -40,7 +42,7 @@ Native module instance > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L41) Unloads the model from memory. @@ -58,7 +60,7 @@ Unloads the model from memory. > **forward**(`waveform`): `Promise`\<[`Segment`](../interfaces/Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L39) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:44](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L44) Executes the model's forward pass, where `waveform` is a Float32Array representing the audio signal. @@ -82,7 +84,7 @@ A promise resolving to an array of detected speech segments. > `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L23) Runs the model's forward method with the given input tensors. It returns the output tensors that mimic the structure of output from ExecuTorch. @@ -111,7 +113,7 @@ Array of output tensors. > **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) +Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/BaseModule.ts#L34) Gets the input shape for a given method and index. @@ -145,7 +147,7 @@ The input shape as an array of numbers. > **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L16) +Defined in: [packages/react-native-executorch/src/modules/natural\_language\_processing/VADModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/natural_language_processing/VADModule.ts#L21) Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md index 85075d8cb..de1bacdcb 100644 --- a/docs/docs/06-api-reference/classes/VerticalOCRModule.md +++ b/docs/docs/06-api-reference/classes/VerticalOCRModule.md @@ -1,6 +1,8 @@ # Class: VerticalOCRModule -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:5](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L5) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L10) + +Module for Vertical Optical Character Recognition (Vertical OCR) tasks. ## Constructors @@ -8,7 +10,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **new VerticalOCRModule**(): `VerticalOCRModule` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L8) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L13) #### Returns @@ -20,7 +22,7 @@ Defined in: [packages/react-native-executorch/src/modules/computer\_vision/Verti > **delete**(): `void` -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L53) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:58](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L58) Release the memory held by the module. Calling `forward` afterwards is invalid. Note that you cannot delete model while it's generating. @@ -35,7 +37,7 @@ Note that you cannot delete model while it's generating. > **forward**(`imageSource`): `Promise`\<`any`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L45) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:50](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L50) Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. @@ -59,7 +61,7 @@ The OCR result as a string. > **load**(`model`, `independentCharacters`, `onDownloadProgressCallback`): `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L21) +Defined in: [packages/react-native-executorch/src/modules/computer\_vision/VerticalOCRModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts#L26) Loads the model, where `detectorSource` is a string that specifies the location of the detector binary, `recognizerSource` is a string that specifies the location of the recognizer binary, diff --git a/docs/docs/06-api-reference/enumerations/CocoLabel.md b/docs/docs/06-api-reference/enumerations/CocoLabel.md index 784862d56..edf9ac52b 100644 --- a/docs/docs/06-api-reference/enumerations/CocoLabel.md +++ b/docs/docs/06-api-reference/enumerations/CocoLabel.md @@ -1,6 +1,6 @@ # Enumeration: CocoLabel -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:35](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L35) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L39) COCO dataset class labels used for object detection. @@ -10,7 +10,7 @@ COCO dataset class labels used for object detection. > **AIRPLANE**: `5` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L40) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L44) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](h > **APPLE**: `53` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L87) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L91) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](h > **BACKPACK**: `27` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L62) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L66) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](h > **BANANA**: `52` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L86) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L90) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](h > **BASEBALL**: `39` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L74) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L78) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](h > **BEAR**: `23` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L58) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:62](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L62) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](h > **BED**: `65` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L99) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L103) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](h > **BENCH**: `15` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L50) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L54) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](h > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L37) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L41) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:37](h > **BIRD**: `16` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L51) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L55) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](h > **BLENDER**: `83` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L117) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L121) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117]( > **BOAT**: `9` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L44) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L48) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:44](h > **BOOK**: `84` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L118) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L122) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118]( > **BOTTLE**: `44` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L78) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L82) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:78](h > **BOWL**: `51` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L85) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L89) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](h > **BROCCOLI**: `56` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L90) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L94) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:90](h > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L41) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L45) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:41](h > **CAKE**: `61` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L95) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:99](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L99) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](h > **CAR**: `3` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L38) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L42) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:38](h > **CARROT**: `57` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L91) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:95](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L95) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:91](h > **CAT**: `17` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L52) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L56) *** @@ -178,7 +178,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](h > **CELL\_PHONE**: `77` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L111) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L115) *** @@ -186,7 +186,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111]( > **CHAIR**: `62` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L96) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L100) *** @@ -194,7 +194,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](h > **CLOCK**: `85` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L119) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L123) *** @@ -202,7 +202,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119]( > **COUCH**: `63` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L97) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L101) *** @@ -210,7 +210,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](h > **COW**: `21` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L56) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L60) *** @@ -218,7 +218,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:56](h > **CUP**: `47` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L81) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:85](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L85) *** @@ -226,7 +226,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](h > **DESK**: `69` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L103) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L107) *** @@ -234,7 +234,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:103]( > **DINING\_TABLE**: `67` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L101) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L105) *** @@ -242,7 +242,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:101]( > **DOG**: `18` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L53) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L57) *** @@ -250,7 +250,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](h > **DONUT**: `60` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L94) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L98) *** @@ -258,7 +258,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:94](h > **DOOR**: `71` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L105) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L109) *** @@ -266,7 +266,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:105]( > **ELEPHANT**: `22` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L57) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L61) *** @@ -274,7 +274,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:57](h > **EYE**: `30` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L65) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L69) *** @@ -282,7 +282,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](h > **FIRE\_HYDRANT**: `11` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L46) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:50](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L50) *** @@ -290,7 +290,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](h > **FORK**: `48` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L82) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:86](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L86) *** @@ -298,7 +298,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:82](h > **FRISBEE**: `34` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L69) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L73) *** @@ -306,7 +306,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:69](h > **GIRAFFE**: `25` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L60) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L64) *** @@ -314,7 +314,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:60](h > **HAIR\_BRUSH**: `91` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L125) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:129](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L129) *** @@ -322,7 +322,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125]( > **HAIR\_DRIER**: `89` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L123) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:127](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L127) *** @@ -330,7 +330,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:123]( > **HANDBAG**: `31` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L66) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L70) *** @@ -338,7 +338,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:66](h > **HAT**: `26` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L61) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:65](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L65) *** @@ -346,7 +346,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:61](h > **HORSE**: `19` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L54) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:58](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L58) *** @@ -354,7 +354,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:54](h > **HOT\_DOG**: `58` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L92) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:96](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L96) *** @@ -362,7 +362,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](h > **KEYBOARD**: `76` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L110) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L114) *** @@ -370,7 +370,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110]( > **KITE**: `38` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L73) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L77) *** @@ -378,7 +378,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:73](h > **KNIFE**: `49` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L83) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:87](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L87) *** @@ -386,7 +386,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](h > **LAPTOP**: `73` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L107) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:111](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L111) *** @@ -394,7 +394,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:107]( > **MICROWAVE**: `78` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L112) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L116) *** @@ -402,7 +402,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112]( > **MIRROR**: `66` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L100) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L104) *** @@ -410,7 +410,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:100]( > **MOTORCYCLE**: `4` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L39) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L43) *** @@ -418,7 +418,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:39](h > **MOUSE**: `74` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L108) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:112](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L112) *** @@ -426,7 +426,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108]( > **ORANGE**: `55` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L89) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L93) *** @@ -434,7 +434,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:89](h > **OVEN**: `79` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L113) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:117](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L117) *** @@ -442,7 +442,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113]( > **PARKING**: `14` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L49) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:53](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L53) *** @@ -450,7 +450,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](h > **PERSON**: `1` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L36) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:40](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L40) *** @@ -458,7 +458,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:36](h > **PIZZA**: `59` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L93) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:97](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L97) *** @@ -466,7 +466,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:93](h > **PLATE**: `45` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L79) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:83](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L83) *** @@ -474,7 +474,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](h > **POTTED\_PLANT**: `64` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L98) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L102) *** @@ -482,7 +482,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:98](h > **REFRIGERATOR**: `82` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L116) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L120) *** @@ -490,7 +490,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:116]( > **REMOTE**: `75` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L109) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:113](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L113) *** @@ -498,7 +498,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:109]( > **SANDWICH**: `54` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L88) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:92](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L92) *** @@ -506,7 +506,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](h > **SCISSORS**: `87` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L121) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:125](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L125) *** @@ -514,7 +514,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:121]( > **SHEEP**: `20` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L55) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L59) *** @@ -522,7 +522,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:55](h > **SHOE**: `29` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L64) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L68) *** @@ -530,7 +530,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:64](h > **SINK**: `81` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L115) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:119](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L119) *** @@ -538,7 +538,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:115]( > **SKATEBOARD**: `41` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L75) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:79](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L79) *** @@ -546,7 +546,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](h > **SKIS**: `35` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L70) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:74](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L74) *** @@ -554,7 +554,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:70](h > **SNOWBOARD**: `36` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L71) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:75](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L75) *** @@ -562,7 +562,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](h > **SPOON**: `50` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L84) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:88](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L88) *** @@ -570,7 +570,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](h > **SPORTS**: `37` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L72) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L76) *** @@ -578,7 +578,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](h > **STOP\_SIGN**: `13` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L48) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:52](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L52) *** @@ -586,7 +586,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:48](h > **STREET\_SIGN**: `12` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L47) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:51](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L51) *** @@ -594,7 +594,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](h > **SUITCASE**: `33` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L68) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:72](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L72) *** @@ -602,7 +602,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:68](h > **SURFBOARD**: `42` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L76) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L80) *** @@ -610,7 +610,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:76](h > **TEDDY\_BEAR**: `88` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L122) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:126](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L126) *** @@ -618,7 +618,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:122]( > **TENNIS\_RACKET**: `43` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L77) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:81](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L81) *** @@ -626,7 +626,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:77](h > **TIE**: `32` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L67) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:71](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L71) *** @@ -634,7 +634,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](h > **TOASTER**: `80` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L114) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:118](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L118) *** @@ -642,7 +642,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:114]( > **TOILET**: `70` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L104) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:108](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L108) *** @@ -650,7 +650,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:104]( > **TOOTHBRUSH**: `90` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L124) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:128](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L128) *** @@ -658,7 +658,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124]( > **TRAFFIC\_LIGHT**: `10` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L45) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:49](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L49) *** @@ -666,7 +666,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:45](h > **TRAIN**: `7` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L42) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:46](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L46) *** @@ -674,7 +674,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:42](h > **TRUCK**: `8` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L43) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:47](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L47) *** @@ -682,7 +682,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:43](h > **TV**: `72` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L106) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:110](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L110) *** @@ -690,7 +690,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106]( > **UMBRELLA**: `28` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L63) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:67](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L67) *** @@ -698,7 +698,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](h > **VASE**: `86` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L120) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:124](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L124) *** @@ -706,7 +706,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:120]( > **WINDOW**: `68` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L102) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:106](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L106) *** @@ -714,7 +714,7 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:102]( > **WINE\_GLASS**: `46` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L80) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:84](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L84) *** @@ -722,4 +722,4 @@ Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:80](h > **ZEBRA**: `24` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:59](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L59) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:63](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L63) diff --git a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md index 180a52132..63d4be37d 100644 --- a/docs/docs/06-api-reference/enumerations/DeeplabLabel.md +++ b/docs/docs/06-api-reference/enumerations/DeeplabLabel.md @@ -1,6 +1,6 @@ # Enumeration: DeeplabLabel -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L8) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) Labels used in the DeepLab image segmentation model. @@ -10,7 +10,7 @@ Labels used in the DeepLab image segmentation model. > **AEROPLANE**: `1` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L10) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) *** @@ -18,7 +18,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:10] > **ARGMAX**: `21` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L30) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:32](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L32) *** @@ -26,7 +26,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:30] > **BACKGROUND**: `0` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L9) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) *** @@ -34,7 +34,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:9]( > **BICYCLE**: `2` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) *** @@ -42,7 +42,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:11] > **BIRD**: `3` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) *** @@ -50,7 +50,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:12] > **BOAT**: `4` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) *** @@ -58,7 +58,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:13] > **BOTTLE**: `5` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L14) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) *** @@ -66,7 +66,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:14] > **BUS**: `6` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L15) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) *** @@ -74,7 +74,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:15] > **CAR**: `7` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L16) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) *** @@ -82,7 +82,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:16] > **CAT**: `8` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L17) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) *** @@ -90,7 +90,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:17] > **CHAIR**: `9` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L18) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) *** @@ -98,7 +98,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:18] > **COW**: `10` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L19) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) *** @@ -106,7 +106,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:19] > **DININGTABLE**: `11` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) *** @@ -114,7 +114,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:20] > **DOG**: `12` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L21) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) *** @@ -122,7 +122,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:21] > **HORSE**: `13` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L22) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) *** @@ -130,7 +130,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:22] > **MOTORBIKE**: `14` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L23) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) *** @@ -138,7 +138,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:23] > **PERSON**: `15` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) *** @@ -146,7 +146,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:24] > **POTTEDPLANT**: `16` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L25) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) *** @@ -154,7 +154,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:25] > **SHEEP**: `17` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L26) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:28](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L28) *** @@ -162,7 +162,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:26] > **SOFA**: `18` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L27) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:29](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L29) *** @@ -170,7 +170,7 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:27] > **TRAIN**: `19` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L28) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:30](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L30) *** @@ -178,4 +178,4 @@ Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:28] > **TVMONITOR**: `20` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L29) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:31](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L31) diff --git a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md index 7e12e541a..c02a3e587 100644 --- a/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md +++ b/docs/docs/06-api-reference/enumerations/RnExecutorchErrorCode.md @@ -1,6 +1,6 @@ # Enumeration: RnExecutorchErrorCode -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L4) ## Enumeration Members @@ -8,7 +8,7 @@ Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:4](https: > **AccessFailed**: `34` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:148](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L148) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:148](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L148) Could not access a resource. @@ -18,7 +18,7 @@ Could not access a resource. > **DelegateInvalidCompatibility**: `48` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:164](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L164) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:164](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L164) Init stage: Backend receives an incompatible delegate version. @@ -28,7 +28,7 @@ Init stage: Backend receives an incompatible delegate version. > **DelegateInvalidHandle**: `50` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:172](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L172) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:172](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L172) Execute stage: The handle is invalid. @@ -38,7 +38,7 @@ Execute stage: The handle is invalid. > **DelegateMemoryAllocationFailed**: `49` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:168](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L168) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:168](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L168) Init stage: Backend fails to allocate memory. @@ -48,7 +48,7 @@ Init stage: Backend fails to allocate memory. > **DownloadInterrupted**: `118` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:60](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L60) Thrown when the number of downloaded files is unexpected, due to download interruptions. @@ -58,7 +58,7 @@ Thrown when the number of downloaded files is unexpected, due to download interr > **EndOfMethod**: `3` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:116](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L116) Status indicating there are no more steps of execution to run @@ -68,7 +68,7 @@ Status indicating there are no more steps of execution to run > **FileReadFailed**: `114` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:44](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L44) Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format. @@ -78,7 +78,7 @@ Thrown when a file read operation failed. This could be invalid image url passed > **FileWriteFailed**: `103` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:16](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L16) An error ocurred when saving a file. This could be, for instance a result image from an image model. @@ -88,7 +88,7 @@ An error ocurred when saving a file. This could be, for instance a result image > **Internal**: `1` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:108](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L108) An internal error occurred. @@ -98,7 +98,7 @@ An internal error occurred. > **InvalidArgument**: `18` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L128) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:128](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L128) User provided an invalid argument. @@ -108,7 +108,7 @@ User provided an invalid argument. > **InvalidConfig**: `112` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:28](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L28) Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1]. @@ -118,7 +118,7 @@ Thrown when config parameters passed to a model are invalid. For example, when L > **InvalidExternalData**: `36` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:156](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L156) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:156](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L156) Error caused by the contents of external data. @@ -128,7 +128,7 @@ Error caused by the contents of external data. > **InvalidModelOutput**: `115` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:48](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L48) Thrown when the size of model output is unexpected. @@ -138,7 +138,7 @@ Thrown when the size of model output is unexpected. > **InvalidModelSource**: `255` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:32](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L32) Thrown when the type of model source passed by the user is invalid. @@ -148,7 +148,7 @@ Thrown when the type of model source passed by the user is invalid. > **InvalidProgram**: `35` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:152](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L152) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:152](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L152) Error caused by the contents of a program. @@ -158,7 +158,7 @@ Error caused by the contents of a program. > **InvalidState**: `2` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:112](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L112) Status indicating the executor is in an invalid state for a targeted operation. @@ -168,7 +168,7 @@ Status indicating the executor is in an invalid state for a targeted operation. > **InvalidType**: `19` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:132](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L132) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:132](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L132) Object is an invalid type for the operation. @@ -178,7 +178,7 @@ Object is an invalid type for the operation. > **InvalidUserInput**: `117` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:56](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L56) Thrown when the input passed to our APIs is invalid, for example when passing an empty message aray to LLM's generate(). @@ -188,7 +188,7 @@ Thrown when the input passed to our APIs is invalid, for example when passing an > **LanguageNotSupported**: `105` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:24](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L24) Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text. @@ -198,7 +198,7 @@ Thrown when a language is passed to a multi-language model that is not supported > **MemoryAllocationFailed**: `33` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:144](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L144) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:144](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L144) Could not allocate the requested memory. @@ -208,7 +208,7 @@ Could not allocate the requested memory. > **MissingDataChunk**: `161` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:68](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L68) Thrown when streaming transcription is attempted but audio data chunk is missing. @@ -218,7 +218,7 @@ Thrown when streaming transcription is attempted but audio data chunk is missing > **ModelGenerating**: `104` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:20](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L20) Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time. @@ -228,7 +228,7 @@ Thrown when a user tries to run a model that is currently processing. It is only > **ModuleNotLoaded**: `102` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L12) Thrown when a user tries to run a model that is not yet downloaded or loaded into memory. @@ -238,7 +238,7 @@ Thrown when a user tries to run a model that is not yet downloaded or loaded int > **MultilingualConfiguration**: `160` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:64](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L64) Thrown when there's a configuration mismatch between multilingual and language settings in Speech-to-Text models. @@ -248,7 +248,7 @@ Thrown when there's a configuration mismatch between multilingual and language s > **NotFound**: `32` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:140](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L140) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:140](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L140) Requested resource could not be found. @@ -258,7 +258,7 @@ Requested resource could not be found. > **NotImplemented**: `17` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:124](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L124) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:124](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L124) Operation is not yet implemented. @@ -268,7 +268,7 @@ Operation is not yet implemented. > **NotSupported**: `16` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:120](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L120) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:120](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L120) Operation is not supported in the current context. @@ -278,7 +278,7 @@ Operation is not supported in the current context. > **Ok**: `0` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:104](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L104) Status indicating a successful operation. @@ -288,7 +288,7 @@ Status indicating a successful operation. > **OperatorMissing**: `20` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:136](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L136) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:136](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L136) Operator(s) missing in the operator registry. @@ -298,7 +298,7 @@ Operator(s) missing in the operator registry. > **OutOfResources**: `37` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:160](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L160) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:160](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L160) Does not have enough resources to perform the requested operation. @@ -308,7 +308,7 @@ Does not have enough resources to perform the requested operation. > **ResourceFetcherAlreadyOngoing**: `183` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:92](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L92) Thrown when trying to resume a download that is already ongoing. @@ -318,7 +318,7 @@ Thrown when trying to resume a download that is already ongoing. > **ResourceFetcherAlreadyPaused**: `182` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:88](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L88) Thrown when trying to pause a download that is already paused. @@ -328,7 +328,7 @@ Thrown when trying to pause a download that is already paused. > **ResourceFetcherDownloadFailed**: `180` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:80](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L80) Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem. @@ -338,7 +338,7 @@ Thrown when a resource fails to download. This could be due to invalid URL, or f > **ResourceFetcherDownloadInProgress**: `181` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:84](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L84) Thrown when a user tries to trigger a download that's already in progress. @@ -348,7 +348,7 @@ Thrown when a user tries to trigger a download that's already in progress. > **ResourceFetcherMissingUri**: `185` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:100](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L100) Thrown when required URI information is missing for a download operation. @@ -358,7 +358,7 @@ Thrown when required URI information is missing for a download operation. > **ResourceFetcherNotActive**: `184` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:96](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L96) Thrown when trying to pause, resume, or cancel a download that is not active. @@ -368,7 +368,7 @@ Thrown when trying to pause, resume, or cancel a download that is not active. > **StreamingInProgress**: `163` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:76](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L76) Thrown when trying to start a new streaming session while another is already in progress. @@ -378,7 +378,7 @@ Thrown when trying to start a new streaming session while another is already in > **StreamingNotStarted**: `162` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:72](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L72) Thrown when trying to stop or insert data into a stream that hasn't been started. @@ -388,7 +388,7 @@ Thrown when trying to stop or insert data into a stream that hasn't been started > **ThreadPoolError**: `113` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:40](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L40) Thrown when React Native ExecuTorch threadpool problem occurs. @@ -398,7 +398,7 @@ Thrown when React Native ExecuTorch threadpool problem occurs. > **UnexpectedNumInputs**: `97` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:36](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L36) Thrown when the number of passed inputs to the model is different than the model metadata specifies. @@ -408,7 +408,7 @@ Thrown when the number of passed inputs to the model is different than the model > **UnknownError**: `101` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L8) An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error. @@ -418,6 +418,6 @@ An umbrella-error that is thrown usually when something unexpected happens, for > **WrongDimensions**: `116` -Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) +Defined in: [packages/react-native-executorch/src/errors/ErrorCodes.ts:52](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/errors/ErrorCodes.ts#L52) Thrown when the dimensions of input tensors don't match the model's expected dimensions. diff --git a/docs/docs/06-api-reference/enumerations/ScalarType.md b/docs/docs/06-api-reference/enumerations/ScalarType.md index 6a5cc884a..23efe3125 100644 --- a/docs/docs/06-api-reference/enumerations/ScalarType.md +++ b/docs/docs/06-api-reference/enumerations/ScalarType.md @@ -1,6 +1,6 @@ # Enumeration: ScalarType -Defined in: [packages/react-native-executorch/src/types/common.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L13) +Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L17) Enum representing the scalar types of tensors. @@ -10,7 +10,7 @@ Enum representing the scalar types of tensors. > **BITS16**: `22` -Defined in: [packages/react-native-executorch/src/types/common.ts:73](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L73) +Defined in: [packages/react-native-executorch/src/types/common.ts:77](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L77) Raw Bits type. @@ -20,7 +20,7 @@ Raw Bits type. > **BOOL**: `11` -Defined in: [packages/react-native-executorch/src/types/common.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L49) +Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L53) Boolean type. @@ -30,7 +30,7 @@ Boolean type. > **BYTE**: `0` -Defined in: [packages/react-native-executorch/src/types/common.ts:17](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L17) +Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L21) Byte type (8-bit unsigned integer). @@ -40,7 +40,7 @@ Byte type (8-bit unsigned integer). > **CHAR**: `1` -Defined in: [packages/react-native-executorch/src/types/common.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L21) +Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L25) Character type (8-bit signed integer). @@ -50,7 +50,7 @@ Character type (8-bit signed integer). > **DOUBLE**: `7` -Defined in: [packages/react-native-executorch/src/types/common.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L45) +Defined in: [packages/react-native-executorch/src/types/common.ts:49](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L49) Double-precision floating point type (64-bit). @@ -60,7 +60,7 @@ Double-precision floating point type (64-bit). > **FLOAT**: `6` -Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L41) +Defined in: [packages/react-native-executorch/src/types/common.ts:45](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L45) Single-precision floating point type (32-bit). @@ -70,7 +70,7 @@ Single-precision floating point type (32-bit). > **FLOAT8E4M3FN**: `24` -Defined in: [packages/react-native-executorch/src/types/common.ts:81](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L81) +Defined in: [packages/react-native-executorch/src/types/common.ts:85](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L85) Quantized 8-bit floating point type: Sign bit, 4 Exponent bits, 3 Mantissa bits. @@ -80,7 +80,7 @@ Quantized 8-bit floating point type: Sign bit, 4 Exponent bits, 3 Mantissa bits. > **FLOAT8E4M3FNUZ**: `26` -Defined in: [packages/react-native-executorch/src/types/common.ts:89](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L89) +Defined in: [packages/react-native-executorch/src/types/common.ts:93](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L93) Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 4 Exponent bits, 3 Mantissa bits. @@ -90,7 +90,7 @@ Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 4 Exp > **FLOAT8E5M2**: `23` -Defined in: [packages/react-native-executorch/src/types/common.ts:77](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L77) +Defined in: [packages/react-native-executorch/src/types/common.ts:81](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L81) Quantized 8-bit floating point type: Sign bit, 5 Exponent bits, 2 Mantissa bits. @@ -100,7 +100,7 @@ Quantized 8-bit floating point type: Sign bit, 5 Exponent bits, 2 Mantissa bits. > **FLOAT8E5M2FNUZ**: `25` -Defined in: [packages/react-native-executorch/src/types/common.ts:85](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L85) +Defined in: [packages/react-native-executorch/src/types/common.ts:89](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L89) Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 5 Exponent bits, 2 Mantissa bits. @@ -110,7 +110,7 @@ Quantized 8-bit floating point type with No Unsigned Zero (NUZ): Sign bit, 5 Exp > **HALF**: `5` -Defined in: [packages/react-native-executorch/src/types/common.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L37) +Defined in: [packages/react-native-executorch/src/types/common.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L41) Half-precision floating point type (16-bit). @@ -120,7 +120,7 @@ Half-precision floating point type (16-bit). > **INT**: `3` -Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L29) +Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L33) Integer type (32-bit signed integer). @@ -130,7 +130,7 @@ Integer type (32-bit signed integer). > **LONG**: `4` -Defined in: [packages/react-native-executorch/src/types/common.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L33) +Defined in: [packages/react-native-executorch/src/types/common.ts:37](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L37) Long integer type (64-bit signed integer). @@ -140,7 +140,7 @@ Long integer type (64-bit signed integer). > **QINT32**: `14` -Defined in: [packages/react-native-executorch/src/types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L61) +Defined in: [packages/react-native-executorch/src/types/common.ts:65](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L65) Quantized 32-bit signed integer type. @@ -150,7 +150,7 @@ Quantized 32-bit signed integer type. > **QINT8**: `12` -Defined in: [packages/react-native-executorch/src/types/common.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L53) +Defined in: [packages/react-native-executorch/src/types/common.ts:57](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L57) Quantized 8-bit signed integer type. @@ -160,7 +160,7 @@ Quantized 8-bit signed integer type. > **QUINT2X4**: `17` -Defined in: [packages/react-native-executorch/src/types/common.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L69) +Defined in: [packages/react-native-executorch/src/types/common.ts:73](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L73) Packed Quantized Unsigned 2-bit Integer type (4 numbers in 1 byte). @@ -170,7 +170,7 @@ Packed Quantized Unsigned 2-bit Integer type (4 numbers in 1 byte). > **QUINT4X2**: `16` -Defined in: [packages/react-native-executorch/src/types/common.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L65) +Defined in: [packages/react-native-executorch/src/types/common.ts:69](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L69) Packed Quantized Unsigned 4-bit Integers type (2 number in 1 byte). @@ -180,7 +180,7 @@ Packed Quantized Unsigned 4-bit Integers type (2 number in 1 byte). > **QUINT8**: `13` -Defined in: [packages/react-native-executorch/src/types/common.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L57) +Defined in: [packages/react-native-executorch/src/types/common.ts:61](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L61) Quantized 8-bit unsigned integer type. @@ -190,7 +190,7 @@ Quantized 8-bit unsigned integer type. > **SHORT**: `2` -Defined in: [packages/react-native-executorch/src/types/common.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L25) +Defined in: [packages/react-native-executorch/src/types/common.ts:29](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L29) Short integer type (16-bit signed integer). @@ -200,7 +200,7 @@ Short integer type (16-bit signed integer). > **UINT16**: `27` -Defined in: [packages/react-native-executorch/src/types/common.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L93) +Defined in: [packages/react-native-executorch/src/types/common.ts:97](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L97) Unsigned 16-bit integer type. @@ -210,7 +210,7 @@ Unsigned 16-bit integer type. > **UINT32**: `28` -Defined in: [packages/react-native-executorch/src/types/common.ts:97](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L97) +Defined in: [packages/react-native-executorch/src/types/common.ts:101](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L101) Unsigned 32-bit integer type. @@ -220,6 +220,6 @@ Unsigned 32-bit integer type. > **UINT64**: `29` -Defined in: [packages/react-native-executorch/src/types/common.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L101) +Defined in: [packages/react-native-executorch/src/types/common.ts:105](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L105) Unsigned 64-bit integer type. diff --git a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md index d0563044d..bc2018c54 100644 --- a/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md +++ b/docs/docs/06-api-reference/functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md @@ -2,7 +2,7 @@ > **DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT**(`structuredOutputSchema`): `string` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/llmDefaults.ts#L15) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:18](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/llmDefaults.ts#L18) Generates a default structured output prompt based on the provided JSON schema. diff --git a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md index 3e12457bd..c3469fdf3 100644 --- a/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md +++ b/docs/docs/06-api-reference/functions/fixAndValidateStructuredOutput.md @@ -2,7 +2,7 @@ > **fixAndValidateStructuredOutput**\<`T`\>(`output`, `responseSchema`): `output`\<`T`\> -Defined in: [packages/react-native-executorch/src/utils/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/llm.ts#L93) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:102](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/llm.ts#L102) Fixes and validates structured output from LLMs against a provided schema. diff --git a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md index ce22fb7b4..03a61c963 100644 --- a/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md +++ b/docs/docs/06-api-reference/functions/getStructuredOutputPrompt.md @@ -2,7 +2,7 @@ > **getStructuredOutputPrompt**\<`T`\>(`responseSchema`): `string` -Defined in: [packages/react-native-executorch/src/utils/llm.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/llm.ts#L56) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:64](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/llm.ts#L64) Generates a structured output prompt based on the provided schema. diff --git a/docs/docs/06-api-reference/functions/useClassification.md b/docs/docs/06-api-reference/functions/useClassification.md index 2148caa71..c460e3e10 100644 --- a/docs/docs/06-api-reference/functions/useClassification.md +++ b/docs/docs/06-api-reference/functions/useClassification.md @@ -2,7 +2,7 @@ > **useClassification**(`ClassificationConfiguration`): [`ClassificationType`](../interfaces/ClassificationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useClassification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts#L12) React hook for managing a Classification model instance. diff --git a/docs/docs/06-api-reference/functions/useExecutorchModule.md b/docs/docs/06-api-reference/functions/useExecutorchModule.md index e954c9fa5..dfff840d0 100644 --- a/docs/docs/06-api-reference/functions/useExecutorchModule.md +++ b/docs/docs/06-api-reference/functions/useExecutorchModule.md @@ -2,7 +2,7 @@ > **useExecutorchModule**(`executorchModuleConfiguration`): [`ExecutorchModuleType`](../interfaces/ExecutorchModuleType.md) -Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts#L12) React hook for managing an arbitrary Executorch module instance. diff --git a/docs/docs/06-api-reference/functions/useImageEmbeddings.md b/docs/docs/06-api-reference/functions/useImageEmbeddings.md index 790c1bd01..883499670 100644 --- a/docs/docs/06-api-reference/functions/useImageEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useImageEmbeddings.md @@ -2,7 +2,7 @@ > **useImageEmbeddings**(`ImageEmbeddingsConfiguration`): `object` -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts#L12) React hook for managing an Image Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useImageSegmentation.md b/docs/docs/06-api-reference/functions/useImageSegmentation.md index 080c9d0eb..5122189dd 100644 --- a/docs/docs/06-api-reference/functions/useImageSegmentation.md +++ b/docs/docs/06-api-reference/functions/useImageSegmentation.md @@ -2,7 +2,7 @@ > **useImageSegmentation**(`ImageSegmentationConfiguration`): [`ImageSegmentationType`](../interfaces/ImageSegmentationType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useImageSegmentation.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts#L12) React hook for managing an Image Segmentation model instance. diff --git a/docs/docs/06-api-reference/functions/useLLM.md b/docs/docs/06-api-reference/functions/useLLM.md index 2f439adc9..dd3e41cc6 100644 --- a/docs/docs/06-api-reference/functions/useLLM.md +++ b/docs/docs/06-api-reference/functions/useLLM.md @@ -2,7 +2,7 @@ > **useLLM**(`model`): [`LLMType`](../interfaces/LLMType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L18) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useLLM.ts:19](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts#L19) React hook for managing a Large Language Model (LLM) instance. diff --git a/docs/docs/06-api-reference/functions/useOCR.md b/docs/docs/06-api-reference/functions/useOCR.md index ec2e3f0d6..de6b04346 100644 --- a/docs/docs/06-api-reference/functions/useOCR.md +++ b/docs/docs/06-api-reference/functions/useOCR.md @@ -2,7 +2,7 @@ > **useOCR**(`OCRConfiguration`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L12) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useOCR.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts#L13) React hook for managing an OCR instance. diff --git a/docs/docs/06-api-reference/functions/useObjectDetection.md b/docs/docs/06-api-reference/functions/useObjectDetection.md index 74b431b3b..565ff7db1 100644 --- a/docs/docs/06-api-reference/functions/useObjectDetection.md +++ b/docs/docs/06-api-reference/functions/useObjectDetection.md @@ -2,7 +2,7 @@ > **useObjectDetection**(`ObjectDetectionConfiguration`): [`ObjectDetectionType`](../interfaces/ObjectDetectionType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useObjectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts#L12) React hook for managing an Object Detection model instance. diff --git a/docs/docs/06-api-reference/functions/useSpeechToText.md b/docs/docs/06-api-reference/functions/useSpeechToText.md index 9eb6164d2..9d0d4f010 100644 --- a/docs/docs/06-api-reference/functions/useSpeechToText.md +++ b/docs/docs/06-api-reference/functions/useSpeechToText.md @@ -2,7 +2,7 @@ > **useSpeechToText**(`speechToTextConfiguration`): [`SpeechToTextType`](../interfaces/SpeechToTextType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useSpeechToText.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts#L14) React hook for managing a Speech to Text (STT) instance. diff --git a/docs/docs/06-api-reference/functions/useStyleTransfer.md b/docs/docs/06-api-reference/functions/useStyleTransfer.md index 898003553..daa53005a 100644 --- a/docs/docs/06-api-reference/functions/useStyleTransfer.md +++ b/docs/docs/06-api-reference/functions/useStyleTransfer.md @@ -2,7 +2,7 @@ > **useStyleTransfer**(`StyleTransferConfiguration`): [`StyleTransferType`](../interfaces/StyleTransferType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useStyleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts#L12) React hook for managing a Style Transfer model instance. diff --git a/docs/docs/06-api-reference/functions/useTextEmbeddings.md b/docs/docs/06-api-reference/functions/useTextEmbeddings.md index 5f7549b2b..24eb13f17 100644 --- a/docs/docs/06-api-reference/functions/useTextEmbeddings.md +++ b/docs/docs/06-api-reference/functions/useTextEmbeddings.md @@ -2,7 +2,7 @@ > **useTextEmbeddings**(`TextEmbeddingsConfiguration`): [`TextEmbeddingsType`](../interfaces/TextEmbeddingsType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts#L12) React hook for managing a Text Embeddings model instance. diff --git a/docs/docs/06-api-reference/functions/useTextToImage.md b/docs/docs/06-api-reference/functions/useTextToImage.md index 2e0397baf..67799d386 100644 --- a/docs/docs/06-api-reference/functions/useTextToImage.md +++ b/docs/docs/06-api-reference/functions/useTextToImage.md @@ -2,7 +2,7 @@ > **useTextToImage**(`TextToImageConfiguration`): [`TextToImageType`](../interfaces/TextToImageType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L13) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useTextToImage.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts#L14) React hook for managing a Text to Image instance. diff --git a/docs/docs/06-api-reference/functions/useTextToSpeech.md b/docs/docs/06-api-reference/functions/useTextToSpeech.md index 771717d98..fafad955e 100644 --- a/docs/docs/06-api-reference/functions/useTextToSpeech.md +++ b/docs/docs/06-api-reference/functions/useTextToSpeech.md @@ -2,7 +2,7 @@ > **useTextToSpeech**(`TextToSpeechConfiguration`): [`TextToSpeechType`](../interfaces/TextToSpeechType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L18) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTextToSpeech.ts:19](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts#L19) React hook for managing Text to Speech instance. diff --git a/docs/docs/06-api-reference/functions/useTokenizer.md b/docs/docs/06-api-reference/functions/useTokenizer.md index e5a687233..3a0ef7dcd 100644 --- a/docs/docs/06-api-reference/functions/useTokenizer.md +++ b/docs/docs/06-api-reference/functions/useTokenizer.md @@ -2,7 +2,7 @@ > **useTokenizer**(`tokenizerConfiguration`): [`TokenizerType`](../interfaces/TokenizerType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L14) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useTokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts#L15) React hook for managing a Tokenizer instance. diff --git a/docs/docs/06-api-reference/functions/useVAD.md b/docs/docs/06-api-reference/functions/useVAD.md index 747b29f8e..65492f124 100644 --- a/docs/docs/06-api-reference/functions/useVAD.md +++ b/docs/docs/06-api-reference/functions/useVAD.md @@ -2,7 +2,7 @@ > **useVAD**(`VADConfiguration`): [`VADType`](../interfaces/VADType.md) -Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L11) +Defined in: [packages/react-native-executorch/src/hooks/natural\_language\_processing/useVAD.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts#L12) React hook for managing a VAD model instance. diff --git a/docs/docs/06-api-reference/functions/useVerticalOCR.md b/docs/docs/06-api-reference/functions/useVerticalOCR.md index 3c6deb180..8c00dffdf 100644 --- a/docs/docs/06-api-reference/functions/useVerticalOCR.md +++ b/docs/docs/06-api-reference/functions/useVerticalOCR.md @@ -2,7 +2,7 @@ > **useVerticalOCR**(`VerticalOCRConfiguration`): [`OCRType`](../interfaces/OCRType.md) -Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L12) +Defined in: [packages/react-native-executorch/src/hooks/computer\_vision/useVerticalOCR.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts#L13) React hook for managing a Vertical OCR instance. diff --git a/docs/docs/06-api-reference/index.md b/docs/docs/06-api-reference/index.md index e6224515d..ff5ec3cf9 100644 --- a/docs/docs/06-api-reference/index.md +++ b/docs/docs/06-api-reference/index.md @@ -1,130 +1,115 @@ # react-native-executorch -## Enumerations +## Hooks -- [CocoLabel](enumerations/CocoLabel.md) -- [DeeplabLabel](enumerations/DeeplabLabel.md) -- [RnExecutorchErrorCode](enumerations/RnExecutorchErrorCode.md) -- [ScalarType](enumerations/ScalarType.md) - -## Classes - -- [ClassificationModule](classes/ClassificationModule.md) -- [ExecutorchModule](classes/ExecutorchModule.md) -- [ImageEmbeddingsModule](classes/ImageEmbeddingsModule.md) -- [ImageSegmentationModule](classes/ImageSegmentationModule.md) -- [LLMModule](classes/LLMModule.md) -- [ObjectDetectionModule](classes/ObjectDetectionModule.md) -- [OCRModule](classes/OCRModule.md) -- [ResourceFetcher](classes/ResourceFetcher.md) -- [RnExecutorchError](classes/RnExecutorchError.md) -- [SpeechToTextModule](classes/SpeechToTextModule.md) -- [StyleTransferModule](classes/StyleTransferModule.md) -- [TextEmbeddingsModule](classes/TextEmbeddingsModule.md) -- [TextToImageModule](classes/TextToImageModule.md) -- [TextToSpeechModule](classes/TextToSpeechModule.md) -- [TokenizerModule](classes/TokenizerModule.md) -- [VADModule](classes/VADModule.md) -- [VerticalOCRModule](classes/VerticalOCRModule.md) +- [useClassification](functions/useClassification.md) +- [useExecutorchModule](functions/useExecutorchModule.md) +- [useImageEmbeddings](functions/useImageEmbeddings.md) +- [useImageSegmentation](functions/useImageSegmentation.md) +- [useLLM](functions/useLLM.md) +- [useObjectDetection](functions/useObjectDetection.md) +- [useOCR](functions/useOCR.md) +- [useSpeechToText](functions/useSpeechToText.md) +- [useStyleTransfer](functions/useStyleTransfer.md) +- [useTextEmbeddings](functions/useTextEmbeddings.md) +- [useTextToImage](functions/useTextToImage.md) +- [useTextToSpeech](functions/useTextToSpeech.md) +- [useTokenizer](functions/useTokenizer.md) +- [useVAD](functions/useVAD.md) +- [useVerticalOCR](functions/useVerticalOCR.md) -## Interfaces +## Models - Classification -- [Bbox](interfaces/Bbox.md) -- [ChatConfig](interfaces/ChatConfig.md) -- [ClassificationProps](interfaces/ClassificationProps.md) -- [ClassificationType](interfaces/ClassificationType.md) -- [DecodingOptions](interfaces/DecodingOptions.md) -- [Detection](interfaces/Detection.md) -- [ExecutorchModuleProps](interfaces/ExecutorchModuleProps.md) -- [ExecutorchModuleType](interfaces/ExecutorchModuleType.md) -- [GenerationConfig](interfaces/GenerationConfig.md) -- [ImageEmbeddingsProps](interfaces/ImageEmbeddingsProps.md) -- [ImageEmbeddingsType](interfaces/ImageEmbeddingsType.md) -- [ImageSegmentationProps](interfaces/ImageSegmentationProps.md) -- [ImageSegmentationType](interfaces/ImageSegmentationType.md) -- [KokoroConfig](interfaces/KokoroConfig.md) -- [KokoroVoiceExtras](interfaces/KokoroVoiceExtras.md) -- [LLMConfig](interfaces/LLMConfig.md) -- [LLMType](interfaces/LLMType.md) -- [Message](interfaces/Message.md) -- [ObjectDetectionProps](interfaces/ObjectDetectionProps.md) -- [ObjectDetectionType](interfaces/ObjectDetectionType.md) -- [OCRDetection](interfaces/OCRDetection.md) -- [OCRProps](interfaces/OCRProps.md) -- [OCRType](interfaces/OCRType.md) -- [Point](interfaces/Point.md) -- [Segment](interfaces/Segment.md) -- [SpeechToTextModelConfig](interfaces/SpeechToTextModelConfig.md) -- [SpeechToTextType](interfaces/SpeechToTextType.md) -- [StyleTransferProps](interfaces/StyleTransferProps.md) -- [StyleTransferType](interfaces/StyleTransferType.md) -- [TensorPtr](interfaces/TensorPtr.md) -- [TextEmbeddingsProps](interfaces/TextEmbeddingsProps.md) -- [TextEmbeddingsType](interfaces/TextEmbeddingsType.md) -- [TextToImageParams](interfaces/TextToImageParams.md) -- [TextToImageType](interfaces/TextToImageType.md) -- [TextToSpeechConfig](interfaces/TextToSpeechConfig.md) -- [TextToSpeechInput](interfaces/TextToSpeechInput.md) -- [TextToSpeechProps](interfaces/TextToSpeechProps.md) -- [TextToSpeechStreamingInput](interfaces/TextToSpeechStreamingInput.md) -- [TextToSpeechType](interfaces/TextToSpeechType.md) -- [TokenizerType](interfaces/TokenizerType.md) -- [ToolCall](interfaces/ToolCall.md) -- [ToolsConfig](interfaces/ToolsConfig.md) -- [VADProps](interfaces/VADProps.md) -- [VADType](interfaces/VADType.md) -- [VerticalOCRProps](interfaces/VerticalOCRProps.md) -- [VoiceConfig](interfaces/VoiceConfig.md) +- [EFFICIENTNET\_V2\_S](variables/EFFICIENTNET_V2_S.md) -## Type Aliases +## Models - Image Embeddings -- [LLMTool](type-aliases/LLMTool.md) -- [MessageRole](type-aliases/MessageRole.md) -- [OCRLanguage](type-aliases/OCRLanguage.md) -- [ResourceSource](type-aliases/ResourceSource.md) -- [SpeechToTextLanguage](type-aliases/SpeechToTextLanguage.md) -- [TensorBuffer](type-aliases/TensorBuffer.md) -- [TextToSpeechLanguage](type-aliases/TextToSpeechLanguage.md) +- [CLIP\_VIT\_BASE\_PATCH32\_IMAGE](variables/CLIP_VIT_BASE_PATCH32_IMAGE.md) -## Variables +## Models - Image Generation -- [ALL\_MINILM\_L6\_V2](variables/ALL_MINILM_L6_V2.md) -- [ALL\_MPNET\_BASE\_V2](variables/ALL_MPNET_BASE_V2.md) - [BK\_SDM\_TINY\_VPRED\_256](variables/BK_SDM_TINY_VPRED_256.md) - [BK\_SDM\_TINY\_VPRED\_512](variables/BK_SDM_TINY_VPRED_512.md) -- [CLIP\_VIT\_BASE\_PATCH32\_IMAGE](variables/CLIP_VIT_BASE_PATCH32_IMAGE.md) -- [CLIP\_VIT\_BASE\_PATCH32\_TEXT](variables/CLIP_VIT_BASE_PATCH32_TEXT.md) + +## Models - Image Segmentation + - [DEEPLAB\_V3\_RESNET50](variables/DEEPLAB_V3_RESNET50.md) -- [DEFAULT\_CHAT\_CONFIG](variables/DEFAULT_CHAT_CONFIG.md) -- [DEFAULT\_CONTEXT\_WINDOW\_LENGTH](variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md) -- [DEFAULT\_MESSAGE\_HISTORY](variables/DEFAULT_MESSAGE_HISTORY.md) -- [DEFAULT\_SYSTEM\_PROMPT](variables/DEFAULT_SYSTEM_PROMPT.md) -- [EFFICIENTNET\_V2\_S](variables/EFFICIENTNET_V2_S.md) -- [FSMN\_VAD](variables/FSMN_VAD.md) + +## Models - LMM + - [HAMMER2\_1\_0\_5B](variables/HAMMER2_1_0_5B.md) - [HAMMER2\_1\_0\_5B\_QUANTIZED](variables/HAMMER2_1_0_5B_QUANTIZED.md) - [HAMMER2\_1\_1\_5B](variables/HAMMER2_1_1_5B.md) - [HAMMER2\_1\_1\_5B\_QUANTIZED](variables/HAMMER2_1_1_5B_QUANTIZED.md) - [HAMMER2\_1\_3B](variables/HAMMER2_1_3B.md) - [HAMMER2\_1\_3B\_QUANTIZED](variables/HAMMER2_1_3B_QUANTIZED.md) -- [KOKORO\_MEDIUM](variables/KOKORO_MEDIUM.md) -- [KOKORO\_SMALL](variables/KOKORO_SMALL.md) -- [KOKORO\_VOICE\_AF\_HEART](variables/KOKORO_VOICE_AF_HEART.md) -- [KOKORO\_VOICE\_AF\_RIVER](variables/KOKORO_VOICE_AF_RIVER.md) -- [KOKORO\_VOICE\_AF\_SARAH](variables/KOKORO_VOICE_AF_SARAH.md) -- [KOKORO\_VOICE\_AM\_ADAM](variables/KOKORO_VOICE_AM_ADAM.md) -- [KOKORO\_VOICE\_AM\_MICHAEL](variables/KOKORO_VOICE_AM_MICHAEL.md) -- [KOKORO\_VOICE\_AM\_SANTA](variables/KOKORO_VOICE_AM_SANTA.md) -- [KOKORO\_VOICE\_BF\_EMMA](variables/KOKORO_VOICE_BF_EMMA.md) -- [KOKORO\_VOICE\_BM\_DANIEL](variables/KOKORO_VOICE_BM_DANIEL.md) - [LLAMA3\_2\_1B](variables/LLAMA3_2_1B.md) - [LLAMA3\_2\_1B\_QLORA](variables/LLAMA3_2_1B_QLORA.md) - [LLAMA3\_2\_1B\_SPINQUANT](variables/LLAMA3_2_1B_SPINQUANT.md) - [LLAMA3\_2\_3B](variables/LLAMA3_2_3B.md) - [LLAMA3\_2\_3B\_QLORA](variables/LLAMA3_2_3B_QLORA.md) - [LLAMA3\_2\_3B\_SPINQUANT](variables/LLAMA3_2_3B_SPINQUANT.md) +- [PHI\_4\_MINI\_4B](variables/PHI_4_MINI_4B.md) +- [PHI\_4\_MINI\_4B\_QUANTIZED](variables/PHI_4_MINI_4B_QUANTIZED.md) +- [QWEN2\_5\_0\_5B](variables/QWEN2_5_0_5B.md) +- [QWEN2\_5\_0\_5B\_QUANTIZED](variables/QWEN2_5_0_5B_QUANTIZED.md) +- [QWEN2\_5\_1\_5B](variables/QWEN2_5_1_5B.md) +- [QWEN2\_5\_1\_5B\_QUANTIZED](variables/QWEN2_5_1_5B_QUANTIZED.md) +- [QWEN2\_5\_3B](variables/QWEN2_5_3B.md) +- [QWEN2\_5\_3B\_QUANTIZED](variables/QWEN2_5_3B_QUANTIZED.md) +- [QWEN3\_0\_6B](variables/QWEN3_0_6B.md) +- [QWEN3\_0\_6B\_QUANTIZED](variables/QWEN3_0_6B_QUANTIZED.md) +- [QWEN3\_1\_7B](variables/QWEN3_1_7B.md) +- [QWEN3\_1\_7B\_QUANTIZED](variables/QWEN3_1_7B_QUANTIZED.md) +- [QWEN3\_4B](variables/QWEN3_4B.md) +- [QWEN3\_4B\_QUANTIZED](variables/QWEN3_4B_QUANTIZED.md) +- [SMOLLM2\_1\_1\_7B](variables/SMOLLM2_1_1_7B.md) +- [SMOLLM2\_1\_1\_7B\_QUANTIZED](variables/SMOLLM2_1_1_7B_QUANTIZED.md) +- [SMOLLM2\_1\_135M](variables/SMOLLM2_1_135M.md) +- [SMOLLM2\_1\_135M\_QUANTIZED](variables/SMOLLM2_1_135M_QUANTIZED.md) +- [SMOLLM2\_1\_360M](variables/SMOLLM2_1_360M.md) +- [SMOLLM2\_1\_360M\_QUANTIZED](variables/SMOLLM2_1_360M_QUANTIZED.md) + +## Models - Object Detection + +- [SSDLITE\_320\_MOBILENET\_V3\_LARGE](variables/SSDLITE_320_MOBILENET_V3_LARGE.md) + +## Models - Speech To Text + +- [WHISPER\_BASE](variables/WHISPER_BASE.md) +- [WHISPER\_BASE\_EN](variables/WHISPER_BASE_EN.md) +- [WHISPER\_SMALL](variables/WHISPER_SMALL.md) +- [WHISPER\_SMALL\_EN](variables/WHISPER_SMALL_EN.md) +- [WHISPER\_TINY](variables/WHISPER_TINY.md) +- [WHISPER\_TINY\_EN](variables/WHISPER_TINY_EN.md) +- [WHISPER\_TINY\_EN\_QUANTIZED](variables/WHISPER_TINY_EN_QUANTIZED.md) + +## Models - Style Transfer + +- [STYLE\_TRANSFER\_CANDY](variables/STYLE_TRANSFER_CANDY.md) +- [STYLE\_TRANSFER\_MOSAIC](variables/STYLE_TRANSFER_MOSAIC.md) +- [STYLE\_TRANSFER\_RAIN\_PRINCESS](variables/STYLE_TRANSFER_RAIN_PRINCESS.md) +- [STYLE\_TRANSFER\_UDNIE](variables/STYLE_TRANSFER_UDNIE.md) + +## Models - Text Embeddings + +- [ALL\_MINILM\_L6\_V2](variables/ALL_MINILM_L6_V2.md) +- [ALL\_MPNET\_BASE\_V2](variables/ALL_MPNET_BASE_V2.md) +- [CLIP\_VIT\_BASE\_PATCH32\_TEXT](variables/CLIP_VIT_BASE_PATCH32_TEXT.md) - [MULTI\_QA\_MINILM\_L6\_COS\_V1](variables/MULTI_QA_MINILM_L6_COS_V1.md) - [MULTI\_QA\_MPNET\_BASE\_DOT\_V1](variables/MULTI_QA_MPNET_BASE_DOT_V1.md) + +## Models - Text to Speech + +- [KOKORO\_MEDIUM](variables/KOKORO_MEDIUM.md) +- [KOKORO\_SMALL](variables/KOKORO_SMALL.md) + +## Models - Voice Activity Detection + +- [FSMN\_VAD](variables/FSMN_VAD.md) + +## OCR Supported Alphabets + - [OCR\_ABAZA](variables/OCR_ABAZA.md) - [OCR\_ADYGHE](variables/OCR_ADYGHE.md) - [OCR\_AFRIKAANS](variables/OCR_AFRIKAANS.md) @@ -188,121 +173,112 @@ - [OCR\_UZBEK](variables/OCR_UZBEK.md) - [OCR\_VIETNAMESE](variables/OCR_VIETNAMESE.md) - [OCR\_WELSH](variables/OCR_WELSH.md) -- [parseToolCall](variables/parseToolCall.md) -- [PHI\_4\_MINI\_4B](variables/PHI_4_MINI_4B.md) -- [PHI\_4\_MINI\_4B\_QUANTIZED](variables/PHI_4_MINI_4B_QUANTIZED.md) -- [QWEN2\_5\_0\_5B](variables/QWEN2_5_0_5B.md) -- [QWEN2\_5\_0\_5B\_QUANTIZED](variables/QWEN2_5_0_5B_QUANTIZED.md) -- [QWEN2\_5\_1\_5B](variables/QWEN2_5_1_5B.md) -- [QWEN2\_5\_1\_5B\_QUANTIZED](variables/QWEN2_5_1_5B_QUANTIZED.md) -- [QWEN2\_5\_3B](variables/QWEN2_5_3B.md) -- [QWEN2\_5\_3B\_QUANTIZED](variables/QWEN2_5_3B_QUANTIZED.md) -- [QWEN3\_0\_6B](variables/QWEN3_0_6B.md) -- [QWEN3\_0\_6B\_QUANTIZED](variables/QWEN3_0_6B_QUANTIZED.md) -- [QWEN3\_1\_7B](variables/QWEN3_1_7B.md) -- [QWEN3\_1\_7B\_QUANTIZED](variables/QWEN3_1_7B_QUANTIZED.md) -- [QWEN3\_4B](variables/QWEN3_4B.md) -- [QWEN3\_4B\_QUANTIZED](variables/QWEN3_4B_QUANTIZED.md) -- [SMOLLM2\_1\_1\_7B](variables/SMOLLM2_1_1_7B.md) -- [SMOLLM2\_1\_1\_7B\_QUANTIZED](variables/SMOLLM2_1_1_7B_QUANTIZED.md) -- [SMOLLM2\_1\_135M](variables/SMOLLM2_1_135M.md) -- [SMOLLM2\_1\_135M\_QUANTIZED](variables/SMOLLM2_1_135M_QUANTIZED.md) -- [SMOLLM2\_1\_360M](variables/SMOLLM2_1_360M.md) -- [SMOLLM2\_1\_360M\_QUANTIZED](variables/SMOLLM2_1_360M_QUANTIZED.md) + +## Other + +- [RnExecutorchErrorCode](enumerations/RnExecutorchErrorCode.md) +- [RnExecutorchError](classes/RnExecutorchError.md) + +## TTS Supported Voices + +- [KOKORO\_VOICE\_AF\_HEART](variables/KOKORO_VOICE_AF_HEART.md) +- [KOKORO\_VOICE\_AF\_RIVER](variables/KOKORO_VOICE_AF_RIVER.md) +- [KOKORO\_VOICE\_AF\_SARAH](variables/KOKORO_VOICE_AF_SARAH.md) +- [KOKORO\_VOICE\_AM\_ADAM](variables/KOKORO_VOICE_AM_ADAM.md) +- [KOKORO\_VOICE\_AM\_MICHAEL](variables/KOKORO_VOICE_AM_MICHAEL.md) +- [KOKORO\_VOICE\_AM\_SANTA](variables/KOKORO_VOICE_AM_SANTA.md) +- [KOKORO\_VOICE\_BF\_EMMA](variables/KOKORO_VOICE_BF_EMMA.md) +- [KOKORO\_VOICE\_BM\_DANIEL](variables/KOKORO_VOICE_BM_DANIEL.md) + +## Types + +- [CocoLabel](enumerations/CocoLabel.md) +- [DeeplabLabel](enumerations/DeeplabLabel.md) +- [ScalarType](enumerations/ScalarType.md) +- [Bbox](interfaces/Bbox.md) +- [ChatConfig](interfaces/ChatConfig.md) +- [ClassificationProps](interfaces/ClassificationProps.md) +- [ClassificationType](interfaces/ClassificationType.md) +- [DecodingOptions](interfaces/DecodingOptions.md) +- [Detection](interfaces/Detection.md) +- [ExecutorchModuleProps](interfaces/ExecutorchModuleProps.md) +- [ExecutorchModuleType](interfaces/ExecutorchModuleType.md) +- [GenerationConfig](interfaces/GenerationConfig.md) +- [ImageEmbeddingsProps](interfaces/ImageEmbeddingsProps.md) +- [ImageEmbeddingsType](interfaces/ImageEmbeddingsType.md) +- [ImageSegmentationProps](interfaces/ImageSegmentationProps.md) +- [ImageSegmentationType](interfaces/ImageSegmentationType.md) +- [KokoroConfig](interfaces/KokoroConfig.md) +- [KokoroVoiceExtras](interfaces/KokoroVoiceExtras.md) +- [LLMConfig](interfaces/LLMConfig.md) +- [LLMType](interfaces/LLMType.md) +- [Message](interfaces/Message.md) +- [ObjectDetectionProps](interfaces/ObjectDetectionProps.md) +- [ObjectDetectionType](interfaces/ObjectDetectionType.md) +- [OCRDetection](interfaces/OCRDetection.md) +- [OCRProps](interfaces/OCRProps.md) +- [OCRType](interfaces/OCRType.md) +- [Point](interfaces/Point.md) +- [Segment](interfaces/Segment.md) +- [SpeechToTextModelConfig](interfaces/SpeechToTextModelConfig.md) +- [SpeechToTextType](interfaces/SpeechToTextType.md) +- [StyleTransferProps](interfaces/StyleTransferProps.md) +- [StyleTransferType](interfaces/StyleTransferType.md) +- [TensorPtr](interfaces/TensorPtr.md) +- [TextEmbeddingsProps](interfaces/TextEmbeddingsProps.md) +- [TextEmbeddingsType](interfaces/TextEmbeddingsType.md) +- [TextToImageParams](interfaces/TextToImageParams.md) +- [TextToImageType](interfaces/TextToImageType.md) +- [TextToSpeechConfig](interfaces/TextToSpeechConfig.md) +- [TextToSpeechInput](interfaces/TextToSpeechInput.md) +- [TextToSpeechProps](interfaces/TextToSpeechProps.md) +- [TextToSpeechStreamingInput](interfaces/TextToSpeechStreamingInput.md) +- [TextToSpeechType](interfaces/TextToSpeechType.md) +- [TokenizerType](interfaces/TokenizerType.md) +- [ToolCall](interfaces/ToolCall.md) +- [ToolsConfig](interfaces/ToolsConfig.md) +- [VADProps](interfaces/VADProps.md) +- [VADType](interfaces/VADType.md) +- [VerticalOCRProps](interfaces/VerticalOCRProps.md) +- [VoiceConfig](interfaces/VoiceConfig.md) +- [LLMTool](type-aliases/LLMTool.md) +- [MessageRole](type-aliases/MessageRole.md) +- [OCRLanguage](type-aliases/OCRLanguage.md) +- [ResourceSource](type-aliases/ResourceSource.md) +- [SpeechToTextLanguage](type-aliases/SpeechToTextLanguage.md) +- [TensorBuffer](type-aliases/TensorBuffer.md) +- [TextToSpeechLanguage](type-aliases/TextToSpeechLanguage.md) - [SPECIAL\_TOKENS](variables/SPECIAL_TOKENS.md) -- [SSDLITE\_320\_MOBILENET\_V3\_LARGE](variables/SSDLITE_320_MOBILENET_V3_LARGE.md) -- [STYLE\_TRANSFER\_CANDY](variables/STYLE_TRANSFER_CANDY.md) -- [STYLE\_TRANSFER\_MOSAIC](variables/STYLE_TRANSFER_MOSAIC.md) -- [STYLE\_TRANSFER\_RAIN\_PRINCESS](variables/STYLE_TRANSFER_RAIN_PRINCESS.md) -- [STYLE\_TRANSFER\_UDNIE](variables/STYLE_TRANSFER_UDNIE.md) -- [VERTICAL\_OCR\_ABAZA](variables/VERTICAL_OCR_ABAZA.md) -- [VERTICAL\_OCR\_ADYGHE](variables/VERTICAL_OCR_ADYGHE.md) -- [VERTICAL\_OCR\_AFRIKAANS](variables/VERTICAL_OCR_AFRIKAANS.md) -- [VERTICAL\_OCR\_ALBANIAN](variables/VERTICAL_OCR_ALBANIAN.md) -- [VERTICAL\_OCR\_AVAR](variables/VERTICAL_OCR_AVAR.md) -- [VERTICAL\_OCR\_AZERBAIJANI](variables/VERTICAL_OCR_AZERBAIJANI.md) -- [VERTICAL\_OCR\_BELARUSIAN](variables/VERTICAL_OCR_BELARUSIAN.md) -- [VERTICAL\_OCR\_BOSNIAN](variables/VERTICAL_OCR_BOSNIAN.md) -- [VERTICAL\_OCR\_BULGARIAN](variables/VERTICAL_OCR_BULGARIAN.md) -- [VERTICAL\_OCR\_CHECHEN](variables/VERTICAL_OCR_CHECHEN.md) -- [VERTICAL\_OCR\_CROATIAN](variables/VERTICAL_OCR_CROATIAN.md) -- [VERTICAL\_OCR\_CZECH](variables/VERTICAL_OCR_CZECH.md) -- [VERTICAL\_OCR\_DANISH](variables/VERTICAL_OCR_DANISH.md) -- [VERTICAL\_OCR\_DARGWA](variables/VERTICAL_OCR_DARGWA.md) -- [VERTICAL\_OCR\_DUTCH](variables/VERTICAL_OCR_DUTCH.md) -- [VERTICAL\_OCR\_ENGLISH](variables/VERTICAL_OCR_ENGLISH.md) -- [VERTICAL\_OCR\_ESTONIAN](variables/VERTICAL_OCR_ESTONIAN.md) -- [VERTICAL\_OCR\_FRENCH](variables/VERTICAL_OCR_FRENCH.md) -- [VERTICAL\_OCR\_GERMAN](variables/VERTICAL_OCR_GERMAN.md) -- [VERTICAL\_OCR\_HUNGARIAN](variables/VERTICAL_OCR_HUNGARIAN.md) -- [VERTICAL\_OCR\_ICELANDIC](variables/VERTICAL_OCR_ICELANDIC.md) -- [VERTICAL\_OCR\_INDONESIAN](variables/VERTICAL_OCR_INDONESIAN.md) -- [VERTICAL\_OCR\_INGUSH](variables/VERTICAL_OCR_INGUSH.md) -- [VERTICAL\_OCR\_IRISH](variables/VERTICAL_OCR_IRISH.md) -- [VERTICAL\_OCR\_ITALIAN](variables/VERTICAL_OCR_ITALIAN.md) -- [VERTICAL\_OCR\_JAPANESE](variables/VERTICAL_OCR_JAPANESE.md) -- [VERTICAL\_OCR\_KANNADA](variables/VERTICAL_OCR_KANNADA.md) -- [VERTICAL\_OCR\_KARBADIAN](variables/VERTICAL_OCR_KARBADIAN.md) -- [VERTICAL\_OCR\_KOREAN](variables/VERTICAL_OCR_KOREAN.md) -- [VERTICAL\_OCR\_KURDISH](variables/VERTICAL_OCR_KURDISH.md) -- [VERTICAL\_OCR\_LAK](variables/VERTICAL_OCR_LAK.md) -- [VERTICAL\_OCR\_LATIN](variables/VERTICAL_OCR_LATIN.md) -- [VERTICAL\_OCR\_LATVIAN](variables/VERTICAL_OCR_LATVIAN.md) -- [VERTICAL\_OCR\_LEZGHIAN](variables/VERTICAL_OCR_LEZGHIAN.md) -- [VERTICAL\_OCR\_LITHUANIAN](variables/VERTICAL_OCR_LITHUANIAN.md) -- [VERTICAL\_OCR\_MALAY](variables/VERTICAL_OCR_MALAY.md) -- [VERTICAL\_OCR\_MALTESE](variables/VERTICAL_OCR_MALTESE.md) -- [VERTICAL\_OCR\_MAORI](variables/VERTICAL_OCR_MAORI.md) -- [VERTICAL\_OCR\_MONGOLIAN](variables/VERTICAL_OCR_MONGOLIAN.md) -- [VERTICAL\_OCR\_NORWEGIAN](variables/VERTICAL_OCR_NORWEGIAN.md) -- [VERTICAL\_OCR\_OCCITAN](variables/VERTICAL_OCR_OCCITAN.md) -- [VERTICAL\_OCR\_PALI](variables/VERTICAL_OCR_PALI.md) -- [VERTICAL\_OCR\_POLISH](variables/VERTICAL_OCR_POLISH.md) -- [VERTICAL\_OCR\_PORTUGUESE](variables/VERTICAL_OCR_PORTUGUESE.md) -- [VERTICAL\_OCR\_ROMANIAN](variables/VERTICAL_OCR_ROMANIAN.md) -- [VERTICAL\_OCR\_RUSSIAN](variables/VERTICAL_OCR_RUSSIAN.md) -- [VERTICAL\_OCR\_SERBIAN\_CYRILLIC](variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md) -- [VERTICAL\_OCR\_SERBIAN\_LATIN](variables/VERTICAL_OCR_SERBIAN_LATIN.md) -- [VERTICAL\_OCR\_SIMPLIFIED\_CHINESE](variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md) -- [VERTICAL\_OCR\_SLOVAK](variables/VERTICAL_OCR_SLOVAK.md) -- [VERTICAL\_OCR\_SLOVENIAN](variables/VERTICAL_OCR_SLOVENIAN.md) -- [VERTICAL\_OCR\_SPANISH](variables/VERTICAL_OCR_SPANISH.md) -- [VERTICAL\_OCR\_SWAHILI](variables/VERTICAL_OCR_SWAHILI.md) -- [VERTICAL\_OCR\_SWEDISH](variables/VERTICAL_OCR_SWEDISH.md) -- [VERTICAL\_OCR\_TABASSARAN](variables/VERTICAL_OCR_TABASSARAN.md) -- [VERTICAL\_OCR\_TAGALOG](variables/VERTICAL_OCR_TAGALOG.md) -- [VERTICAL\_OCR\_TAJIK](variables/VERTICAL_OCR_TAJIK.md) -- [VERTICAL\_OCR\_TELUGU](variables/VERTICAL_OCR_TELUGU.md) -- [VERTICAL\_OCR\_TURKISH](variables/VERTICAL_OCR_TURKISH.md) -- [VERTICAL\_OCR\_UKRAINIAN](variables/VERTICAL_OCR_UKRAINIAN.md) -- [VERTICAL\_OCR\_UZBEK](variables/VERTICAL_OCR_UZBEK.md) -- [VERTICAL\_OCR\_VIETNAMESE](variables/VERTICAL_OCR_VIETNAMESE.md) -- [VERTICAL\_OCR\_WELSH](variables/VERTICAL_OCR_WELSH.md) -- [WHISPER\_BASE](variables/WHISPER_BASE.md) -- [WHISPER\_BASE\_EN](variables/WHISPER_BASE_EN.md) -- [WHISPER\_SMALL](variables/WHISPER_SMALL.md) -- [WHISPER\_SMALL\_EN](variables/WHISPER_SMALL_EN.md) -- [WHISPER\_TINY](variables/WHISPER_TINY.md) -- [WHISPER\_TINY\_EN](variables/WHISPER_TINY_EN.md) -- [WHISPER\_TINY\_EN\_QUANTIZED](variables/WHISPER_TINY_EN_QUANTIZED.md) -## Functions +## Typescript API + +- [ClassificationModule](classes/ClassificationModule.md) +- [ExecutorchModule](classes/ExecutorchModule.md) +- [ImageEmbeddingsModule](classes/ImageEmbeddingsModule.md) +- [ImageSegmentationModule](classes/ImageSegmentationModule.md) +- [LLMModule](classes/LLMModule.md) +- [ObjectDetectionModule](classes/ObjectDetectionModule.md) +- [OCRModule](classes/OCRModule.md) +- [SpeechToTextModule](classes/SpeechToTextModule.md) +- [StyleTransferModule](classes/StyleTransferModule.md) +- [TextEmbeddingsModule](classes/TextEmbeddingsModule.md) +- [TextToImageModule](classes/TextToImageModule.md) +- [TextToSpeechModule](classes/TextToSpeechModule.md) +- [TokenizerModule](classes/TokenizerModule.md) +- [VADModule](classes/VADModule.md) +- [VerticalOCRModule](classes/VerticalOCRModule.md) +## Utilities - General + +- [ResourceFetcher](classes/ResourceFetcher.md) + +## Utilities - LLM + +- [DEFAULT\_CHAT\_CONFIG](variables/DEFAULT_CHAT_CONFIG.md) +- [DEFAULT\_CONTEXT\_WINDOW\_LENGTH](variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md) +- [DEFAULT\_MESSAGE\_HISTORY](variables/DEFAULT_MESSAGE_HISTORY.md) +- [DEFAULT\_SYSTEM\_PROMPT](variables/DEFAULT_SYSTEM_PROMPT.md) +- [parseToolCall](variables/parseToolCall.md) - [DEFAULT\_STRUCTURED\_OUTPUT\_PROMPT](functions/DEFAULT_STRUCTURED_OUTPUT_PROMPT.md) - [fixAndValidateStructuredOutput](functions/fixAndValidateStructuredOutput.md) - [getStructuredOutputPrompt](functions/getStructuredOutputPrompt.md) -- [useClassification](functions/useClassification.md) -- [useExecutorchModule](functions/useExecutorchModule.md) -- [useImageEmbeddings](functions/useImageEmbeddings.md) -- [useImageSegmentation](functions/useImageSegmentation.md) -- [useLLM](functions/useLLM.md) -- [useObjectDetection](functions/useObjectDetection.md) -- [useOCR](functions/useOCR.md) -- [useSpeechToText](functions/useSpeechToText.md) -- [useStyleTransfer](functions/useStyleTransfer.md) -- [useTextEmbeddings](functions/useTextEmbeddings.md) -- [useTextToImage](functions/useTextToImage.md) -- [useTextToSpeech](functions/useTextToSpeech.md) -- [useTokenizer](functions/useTokenizer.md) -- [useVAD](functions/useVAD.md) -- [useVerticalOCR](functions/useVerticalOCR.md) diff --git a/docs/docs/06-api-reference/interfaces/Bbox.md b/docs/docs/06-api-reference/interfaces/Bbox.md index 0475d7efd..e5773df85 100644 --- a/docs/docs/06-api-reference/interfaces/Bbox.md +++ b/docs/docs/06-api-reference/interfaces/Bbox.md @@ -1,6 +1,6 @@ # Interface: Bbox -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L12) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L13) Represents a bounding box for a detected object in an image. @@ -10,7 +10,7 @@ Represents a bounding box for a detected object in an image. > **x1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L13) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L14) The x-coordinate of the bottom-left corner of the bounding box. @@ -20,7 +20,7 @@ The x-coordinate of the bottom-left corner of the bounding box. > **x2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L14) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L15) The x-coordinate of the top-right corner of the bounding box. @@ -30,7 +30,7 @@ The x-coordinate of the top-right corner of the bounding box. > **y1**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L15) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L16) The y-coordinate of the bottom-left corner of the bounding box. @@ -40,6 +40,6 @@ The y-coordinate of the bottom-left corner of the bounding box. > **y2**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L16) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:17](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L17) The y-coordinate of the top-right corner of the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/ChatConfig.md b/docs/docs/06-api-reference/interfaces/ChatConfig.md index 0597ad996..6fb0ee352 100644 --- a/docs/docs/06-api-reference/interfaces/ChatConfig.md +++ b/docs/docs/06-api-reference/interfaces/ChatConfig.md @@ -1,6 +1,6 @@ # Interface: ChatConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:171](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L171) +Defined in: [packages/react-native-executorch/src/types/llm.ts:182](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L182) Object configuring chat management. @@ -10,7 +10,7 @@ Object configuring chat management. > **contextWindowLength**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:173](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L173) +Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L184) The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. @@ -20,7 +20,7 @@ The number of messages from the current conversation that the model will use to > **initialMessageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:172](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L172) +Defined in: [packages/react-native-executorch/src/types/llm.ts:183](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L183) An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. @@ -30,6 +30,6 @@ An array of `Message` objects that represent the conversation history. This can > **systemPrompt**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:174](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L174) +Defined in: [packages/react-native-executorch/src/types/llm.ts:185](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L185) Often used to tell the model what is its purpose, for example - "Be a helpful translator". diff --git a/docs/docs/06-api-reference/interfaces/ClassificationProps.md b/docs/docs/06-api-reference/interfaces/ClassificationProps.md index cd98ac888..16cc76720 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationProps.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationProps.md @@ -1,6 +1,6 @@ # Interface: ClassificationProps -Defined in: [packages/react-native-executorch/src/types/classification.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L11) +Defined in: [packages/react-native-executorch/src/types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/classification.ts#L12) Props for the `useClassification` hook. @@ -10,7 +10,7 @@ Props for the `useClassification` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/classification.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L12) +Defined in: [packages/react-native-executorch/src/types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/classification.ts#L13) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L13) +Defined in: [packages/react-native-executorch/src/types/classification.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/classification.ts#L14) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ClassificationType.md b/docs/docs/06-api-reference/interfaces/ClassificationType.md index a747c795a..e29392754 100644 --- a/docs/docs/06-api-reference/interfaces/ClassificationType.md +++ b/docs/docs/06-api-reference/interfaces/ClassificationType.md @@ -1,6 +1,6 @@ # Interface: ClassificationType -Defined in: [packages/react-native-executorch/src/types/classification.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L20) +Defined in: [packages/react-native-executorch/src/types/classification.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/classification.ts#L23) Return type for the `useClassification` hook. Manages the state and operations for Computer Vision image classification. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image classification. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/classification.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L39) +Defined in: [packages/react-native-executorch/src/types/classification.ts:42](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/classification.ts#L42) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/classification.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L24) +Defined in: [packages/react-native-executorch/src/types/classification.ts:27](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/classification.ts#L27) Contains the error object if the model failed to load, download, or encountered a runtime error during classification. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<\{\[`category`: `string`\]: `number`; \}\> -Defined in: [packages/react-native-executorch/src/types/classification.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L47) +Defined in: [packages/react-native-executorch/src/types/classification.ts:50](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/classification.ts#L50) Executes the model's forward pass to classify the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L34) +Defined in: [packages/react-native-executorch/src/types/classification.ts:37](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/classification.ts#L37) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/classification.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/classification.ts#L29) +Defined in: [packages/react-native-executorch/src/types/classification.ts:32](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/classification.ts#L32) Indicates whether the classification model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/DecodingOptions.md b/docs/docs/06-api-reference/interfaces/DecodingOptions.md index 3bc9aca5f..4a14ac75d 100644 --- a/docs/docs/06-api-reference/interfaces/DecodingOptions.md +++ b/docs/docs/06-api-reference/interfaces/DecodingOptions.md @@ -1,6 +1,6 @@ # Interface: DecodingOptions -Defined in: [packages/react-native-executorch/src/types/stt.ts:169](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L169) +Defined in: [packages/react-native-executorch/src/types/stt.ts:176](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L176) Options for decoding speech to text. @@ -10,6 +10,6 @@ Options for decoding speech to text. > `optional` **language**: [`SpeechToTextLanguage`](../type-aliases/SpeechToTextLanguage.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:170](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L170) +Defined in: [packages/react-native-executorch/src/types/stt.ts:177](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L177) Optional language code to guide the transcription. diff --git a/docs/docs/06-api-reference/interfaces/Detection.md b/docs/docs/06-api-reference/interfaces/Detection.md index 719b249c6..5ba98bb8b 100644 --- a/docs/docs/06-api-reference/interfaces/Detection.md +++ b/docs/docs/06-api-reference/interfaces/Detection.md @@ -1,6 +1,6 @@ # Interface: Detection -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L26) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L28) Represents a detected object within an image, including its bounding box, label, and confidence score. @@ -10,7 +10,7 @@ Represents a detected object within an image, including its bounding box, label, > **bbox**: [`Bbox`](Bbox.md) -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L27) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L29) The bounding box of the detected object, defined by its top-left (x1, y1) and bottom-right (x2, y2) coordinates. @@ -20,7 +20,7 @@ The bounding box of the detected object, defined by its top-left (x1, y1) and bo > **label**: `"PERSON"` \| `"BICYCLE"` \| `"CAR"` \| `"MOTORCYCLE"` \| `"AIRPLANE"` \| `"BUS"` \| `"TRAIN"` \| `"TRUCK"` \| `"BOAT"` \| `"TRAFFIC_LIGHT"` \| `"FIRE_HYDRANT"` \| `"STREET_SIGN"` \| `"STOP_SIGN"` \| `"PARKING"` \| `"BENCH"` \| `"BIRD"` \| `"CAT"` \| `"DOG"` \| `"HORSE"` \| `"SHEEP"` \| `"COW"` \| `"ELEPHANT"` \| `"BEAR"` \| `"ZEBRA"` \| `"GIRAFFE"` \| `"HAT"` \| `"BACKPACK"` \| `"UMBRELLA"` \| `"SHOE"` \| `"EYE"` \| `"HANDBAG"` \| `"TIE"` \| `"SUITCASE"` \| `"FRISBEE"` \| `"SKIS"` \| `"SNOWBOARD"` \| `"SPORTS"` \| `"KITE"` \| `"BASEBALL"` \| `"SKATEBOARD"` \| `"SURFBOARD"` \| `"TENNIS_RACKET"` \| `"BOTTLE"` \| `"PLATE"` \| `"WINE_GLASS"` \| `"CUP"` \| `"FORK"` \| `"KNIFE"` \| `"SPOON"` \| `"BOWL"` \| `"BANANA"` \| `"APPLE"` \| `"SANDWICH"` \| `"ORANGE"` \| `"BROCCOLI"` \| `"CARROT"` \| `"HOT_DOG"` \| `"PIZZA"` \| `"DONUT"` \| `"CAKE"` \| `"CHAIR"` \| `"COUCH"` \| `"POTTED_PLANT"` \| `"BED"` \| `"MIRROR"` \| `"DINING_TABLE"` \| `"WINDOW"` \| `"DESK"` \| `"TOILET"` \| `"DOOR"` \| `"TV"` \| `"LAPTOP"` \| `"MOUSE"` \| `"REMOTE"` \| `"KEYBOARD"` \| `"CELL_PHONE"` \| `"MICROWAVE"` \| `"OVEN"` \| `"TOASTER"` \| `"SINK"` \| `"REFRIGERATOR"` \| `"BLENDER"` \| `"BOOK"` \| `"CLOCK"` \| `"VASE"` \| `"SCISSORS"` \| `"TEDDY_BEAR"` \| `"HAIR_DRIER"` \| `"TOOTHBRUSH"` \| `"HAIR_BRUSH"` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L28) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:30](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L30) The class label of the detected object, represented as a key from the `CocoLabel` enum. @@ -30,6 +30,6 @@ The class label of the detected object, represented as a key from the `CocoLabel > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L29) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:31](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L31) The confidence score of the detection, typically ranging from 0 to 1. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md index 008a4a69d..bd6f400a2 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleProps.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleProps -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L10) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/executorchModule.ts#L11) Props for the `useExecutorchModule` hook. @@ -10,7 +10,7 @@ Props for the `useExecutorchModule` hook. > **modelSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L11) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/executorchModule.ts#L12) The source of the ExecuTorch model binary. @@ -20,6 +20,6 @@ The source of the ExecuTorch model binary. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L12) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/executorchModule.ts#L13) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md index c382518a1..cde30ba6a 100644 --- a/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md +++ b/docs/docs/06-api-reference/interfaces/ExecutorchModuleType.md @@ -1,6 +1,6 @@ # Interface: ExecutorchModuleType -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L19) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/executorchModule.ts#L22) Return type for the `useExecutorchModule` hook. Manages the state and core execution methods for a general ExecuTorch model. @@ -11,7 +11,7 @@ Manages the state and core execution methods for a general ExecuTorch model. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:38](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L38) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/executorchModule.ts#L41) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L23) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:26](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/executorchModule.ts#L26) Contains the error object if the model failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`inputTensor`) => `Promise`\<[`TensorPtr`](TensorPtr.md)[]\> -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L46) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:49](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/executorchModule.ts#L49) Executes the model's forward pass with the provided input tensors. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another request. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L33) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:36](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/executorchModule.ts#L36) Indicates whether the model is currently processing a forward pass. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing a forward pass. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/executorchModule.ts#L28) +Defined in: [packages/react-native-executorch/src/types/executorchModule.ts:31](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/executorchModule.ts#L31) Indicates whether the ExecuTorch model binary has successfully loaded into memory and is ready for inference. diff --git a/docs/docs/06-api-reference/interfaces/GenerationConfig.md b/docs/docs/06-api-reference/interfaces/GenerationConfig.md index a7ff71733..e9c4a45d7 100644 --- a/docs/docs/06-api-reference/interfaces/GenerationConfig.md +++ b/docs/docs/06-api-reference/interfaces/GenerationConfig.md @@ -1,6 +1,6 @@ # Interface: GenerationConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L198) +Defined in: [packages/react-native-executorch/src/types/llm.ts:211](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L211) Object configuring generation settings. @@ -10,7 +10,7 @@ Object configuring generation settings. > `optional` **batchTimeInterval**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:202](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L202) +Defined in: [packages/react-native-executorch/src/types/llm.ts:215](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L215) Upper limit on the time interval between consecutive token batches. @@ -20,7 +20,7 @@ Upper limit on the time interval between consecutive token batches. > `optional` **outputTokenBatchSize**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:201](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L201) +Defined in: [packages/react-native-executorch/src/types/llm.ts:214](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L214) Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). @@ -30,7 +30,7 @@ Soft upper limit on the number of tokens in each token batch (in certain cases t > `optional` **temperature**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L199) +Defined in: [packages/react-native-executorch/src/types/llm.ts:212](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L212) Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. @@ -40,6 +40,6 @@ Scales output logits by the inverse of temperature. Controls the randomness / cr > `optional` **topp**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:200](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L200) +Defined in: [packages/react-native-executorch/src/types/llm.ts:213](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L213) Only samples from the smallest set of tokens whose cumulative probability exceeds topp. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md index c8f156fc2..093618901 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) Props for the `useImageEmbeddings` hook. @@ -10,7 +10,7 @@ Props for the `useImageEmbeddings` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L12) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L13) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L14) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md index 55c790620..35fb7a247 100644 --- a/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/ImageEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: ImageEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L20) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L23) Return type for the `useImageEmbeddings` hook. Manages the state and operations for generating image embeddings (feature vectors) used in Computer Vision tasks. @@ -11,7 +11,7 @@ Manages the state and operations for generating image embeddings (feature vector > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L39) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:42](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L42) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L24) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:27](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L27) Contains the error object if the model failed to load, download, or encountered a runtime error during embedding generation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L47) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L50) Executes the model's forward pass to generate embeddings (a feature vector) for the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L34) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:37](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L37) Indicates whether the model is currently generating embeddings for an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently generating embeddings for an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L29) +Defined in: [packages/react-native-executorch/src/types/imageEmbeddings.ts:32](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageEmbeddings.ts#L32) Indicates whether the image embeddings model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md index 39662d317..aa2a0bbc6 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationProps.md @@ -1,6 +1,6 @@ # Interface: ImageSegmentationProps -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L40) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:44](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L44) Props for the `useImageSegmentation` hook. @@ -10,7 +10,7 @@ Props for the `useImageSegmentation` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L41) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:45](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L45) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L42) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:46](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L46) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md index f493c7612..1a4564d1e 100644 --- a/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md +++ b/docs/docs/06-api-reference/interfaces/ImageSegmentationType.md @@ -1,6 +1,6 @@ # Interface: ImageSegmentationType -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L49) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:55](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L55) Return type for the `useImageSegmentation` hook. Manages the state and operations for Computer Vision image segmentation (e.g., DeepLab). @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision image segmentation (e.g., D > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L68) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:74](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L74) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L53) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:59](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L59) Contains the error object if the model failed to load, download, or encountered a runtime error during segmentation. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `classesOfInterest?`, `resize?`) => `Promise`\<`Partial`\<`Record`\<[`DeeplabLabel`](../enumerations/DeeplabLabel.md), `number`[]\>\>\> -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L78) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:84](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L84) Executes the model's forward pass to perform semantic segmentation on the provided image. @@ -71,7 +71,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:63](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L63) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:69](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L69) Indicates whether the model is currently processing an image. @@ -81,6 +81,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/imageSegmentation.ts#L58) +Defined in: [packages/react-native-executorch/src/types/imageSegmentation.ts:64](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/imageSegmentation.ts#L64) Indicates whether the segmentation model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/KokoroConfig.md b/docs/docs/06-api-reference/interfaces/KokoroConfig.md index 6556efa96..14ec2db64 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroConfig.md +++ b/docs/docs/06-api-reference/interfaces/KokoroConfig.md @@ -1,6 +1,6 @@ # Interface: KokoroConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:43](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L43) +Defined in: [packages/react-native-executorch/src/types/tts.ts:50](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L50) Kokoro model configuration. Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. @@ -11,7 +11,7 @@ Only the core Kokoro model sources, as phonemizer sources are included in voice > **durationPredictorSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L45) +Defined in: [packages/react-native-executorch/src/types/tts.ts:52](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L52) source to Kokoro's duration predictor model binary @@ -21,7 +21,7 @@ source to Kokoro's duration predictor model binary > **synthesizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tts.ts:53](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L53) source to Kokoro's synthesizer model binary @@ -31,6 +31,6 @@ source to Kokoro's synthesizer model binary > **type**: `"kokoro"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L44) +Defined in: [packages/react-native-executorch/src/types/tts.ts:51](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L51) model type identifier diff --git a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md index 32f30b41c..4fda2615e 100644 --- a/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md +++ b/docs/docs/06-api-reference/interfaces/KokoroVoiceExtras.md @@ -1,6 +1,6 @@ # Interface: KokoroVoiceExtras -Defined in: [packages/react-native-executorch/src/types/tts.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L30) +Defined in: [packages/react-native-executorch/src/types/tts.ts:36](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L36) Kokoro-specific voice extra props @@ -10,7 +10,7 @@ Kokoro-specific voice extra props > **lexiconSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L32) +Defined in: [packages/react-native-executorch/src/types/tts.ts:38](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L38) source to Kokoro's lexicon binary @@ -20,6 +20,6 @@ source to Kokoro's lexicon binary > **taggerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:31](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L31) +Defined in: [packages/react-native-executorch/src/types/tts.ts:37](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L37) source to Kokoro's tagger model binary diff --git a/docs/docs/06-api-reference/interfaces/LLMConfig.md b/docs/docs/06-api-reference/interfaces/LLMConfig.md index 563d43d60..04ed26e4e 100644 --- a/docs/docs/06-api-reference/interfaces/LLMConfig.md +++ b/docs/docs/06-api-reference/interfaces/LLMConfig.md @@ -1,6 +1,6 @@ # Interface: LLMConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L93) +Defined in: [packages/react-native-executorch/src/types/llm.ts:97](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L97) Configuration object for initializing and customizing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ Configuration object for initializing and customizing a Large Language Model (LL > `optional` **chatConfig**: `Partial`\<[`ChatConfig`](ChatConfig.md)\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:103](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L103) +Defined in: [packages/react-native-executorch/src/types/llm.ts:107](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L107) Object configuring chat management, contains following properties: @@ -26,7 +26,7 @@ Object configuring chat management, contains following properties: > `optional` **generationConfig**: [`GenerationConfig`](GenerationConfig.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:127](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L127) +Defined in: [packages/react-native-executorch/src/types/llm.ts:131](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L131) Object configuring generation settings. @@ -44,7 +44,7 @@ Object configuring generation settings. > `optional` **toolsConfig**: [`ToolsConfig`](ToolsConfig.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:114](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L114) +Defined in: [packages/react-native-executorch/src/types/llm.ts:118](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L118) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. Contains following properties: diff --git a/docs/docs/06-api-reference/interfaces/LLMType.md b/docs/docs/06-api-reference/interfaces/LLMType.md index c31aa9207..6139b1b45 100644 --- a/docs/docs/06-api-reference/interfaces/LLMType.md +++ b/docs/docs/06-api-reference/interfaces/LLMType.md @@ -1,6 +1,6 @@ # Interface: LLMType -Defined in: [packages/react-native-executorch/src/types/llm.ts:6](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L6) +Defined in: [packages/react-native-executorch/src/types/llm.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L8) React hook for managing a Large Language Model (LLM) instance. @@ -10,7 +10,7 @@ React hook for managing a Large Language Model (LLM) instance. > **configure**: (`configuration`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L48) +Defined in: [packages/react-native-executorch/src/types/llm.ts:50](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L50) Configures chat and tool calling. See [Configuring the model](../../03-hooks/01-natural-language-processing/useLLM.md#configuring-the-model) for details. @@ -33,7 +33,7 @@ Configuration object containing `chatConfig`, `toolsConfig`, and `generationConf > **deleteMessage**: (`index`) => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:82](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L82) +Defined in: [packages/react-native-executorch/src/types/llm.ts:84](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L84) Deletes all messages starting with message on `index` position. After deletion `messageHistory` will be updated. @@ -55,7 +55,7 @@ The index of the message to delete from history. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:35](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L35) +Defined in: [packages/react-native-executorch/src/types/llm.ts:37](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L37) Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval. @@ -65,7 +65,7 @@ Represents the download progress as a value between 0 and 1, indicating the exte > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/llm.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L40) +Defined in: [packages/react-native-executorch/src/types/llm.ts:42](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L42) Contains the error message if the model failed to load. @@ -75,7 +75,7 @@ Contains the error message if the model failed to load. > **generate**: (`messages`, `tools?`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:67](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L67) +Defined in: [packages/react-native-executorch/src/types/llm.ts:69](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L69) Runs model to complete chat passed in `messages` argument. It doesn't manage conversation context. @@ -103,7 +103,7 @@ Optional array of tools that can be used during generation. > **getGeneratedTokenCount**: () => `number` -Defined in: [packages/react-native-executorch/src/types/llm.ts:59](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L59) +Defined in: [packages/react-native-executorch/src/types/llm.ts:61](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L61) Returns the number of tokens generated so far in the current generation. @@ -119,7 +119,7 @@ The count of generated tokens. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/llm.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L87) +Defined in: [packages/react-native-executorch/src/types/llm.ts:89](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L89) Function to interrupt the current inference. @@ -133,7 +133,7 @@ Function to interrupt the current inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L30) +Defined in: [packages/react-native-executorch/src/types/llm.ts:32](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L32) Indicates whether the model is currently generating a response. @@ -143,7 +143,7 @@ Indicates whether the model is currently generating a response. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L25) +Defined in: [packages/react-native-executorch/src/types/llm.ts:27](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L27) Indicates whether the model is ready. @@ -153,7 +153,7 @@ Indicates whether the model is ready. > **messageHistory**: [`Message`](Message.md)[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L10) +Defined in: [packages/react-native-executorch/src/types/llm.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L12) History containing all messages in conversation. This field is updated after model responds to sendMessage. @@ -163,7 +163,7 @@ History containing all messages in conversation. This field is updated after mod > **response**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L15) +Defined in: [packages/react-native-executorch/src/types/llm.ts:17](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L17) State of the generated response. This field is updated with each token generated by the model. @@ -173,7 +173,7 @@ State of the generated response. This field is updated with each token generated > **sendMessage**: (`message`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:75](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L75) +Defined in: [packages/react-native-executorch/src/types/llm.ts:77](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L77) Function to add user message to conversation. After model responds, `messageHistory` will be updated with both user message and model response. @@ -196,6 +196,6 @@ The message string to send. > **token**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L20) +Defined in: [packages/react-native-executorch/src/types/llm.ts:22](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L22) The most recently generated token. diff --git a/docs/docs/06-api-reference/interfaces/Message.md b/docs/docs/06-api-reference/interfaces/Message.md index 8f754f88b..9d899bdf4 100644 --- a/docs/docs/06-api-reference/interfaces/Message.md +++ b/docs/docs/06-api-reference/interfaces/Message.md @@ -1,6 +1,6 @@ # Interface: Message -Defined in: [packages/react-native-executorch/src/types/llm.ts:141](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L141) +Defined in: [packages/react-native-executorch/src/types/llm.ts:148](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L148) Represents a message in the conversation. @@ -10,7 +10,7 @@ Represents a message in the conversation. > **content**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:143](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L143) +Defined in: [packages/react-native-executorch/src/types/llm.ts:150](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L150) Content of the message. @@ -20,6 +20,6 @@ Content of the message. > **role**: [`MessageRole`](../type-aliases/MessageRole.md) -Defined in: [packages/react-native-executorch/src/types/llm.ts:142](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L142) +Defined in: [packages/react-native-executorch/src/types/llm.ts:149](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L149) Role of the message sender of type `MessageRole`. diff --git a/docs/docs/06-api-reference/interfaces/OCRDetection.md b/docs/docs/06-api-reference/interfaces/OCRDetection.md index 9b813e3b0..2a00abdc8 100644 --- a/docs/docs/06-api-reference/interfaces/OCRDetection.md +++ b/docs/docs/06-api-reference/interfaces/OCRDetection.md @@ -1,6 +1,6 @@ # Interface: OCRDetection -Defined in: [packages/react-native-executorch/src/types/ocr.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L13) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L14) OCRDetection represents a single detected text instance in an image, including its bounding box, recognized text, and confidence score. @@ -11,7 +11,7 @@ including its bounding box, recognized text, and confidence score. > **bbox**: [`Point`](Point.md)[] -Defined in: [packages/react-native-executorch/src/types/ocr.ts:14](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L14) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L15) An array of points defining the bounding box around the detected text. @@ -21,7 +21,7 @@ An array of points defining the bounding box around the detected text. > **score**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L16) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:17](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L17) The confidence score of the OCR detection, ranging from 0 to 1. @@ -31,6 +31,6 @@ The confidence score of the OCR detection, ranging from 0 to 1. > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L15) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:16](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L16) The recognized text within the bounding box. diff --git a/docs/docs/06-api-reference/interfaces/OCRProps.md b/docs/docs/06-api-reference/interfaces/OCRProps.md index b62c62874..4f26145f8 100644 --- a/docs/docs/06-api-reference/interfaces/OCRProps.md +++ b/docs/docs/06-api-reference/interfaces/OCRProps.md @@ -1,6 +1,6 @@ # Interface: OCRProps -Defined in: [packages/react-native-executorch/src/types/ocr.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L33) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L37) Configuration properties for the `useOCR` hook. @@ -14,7 +14,7 @@ Configuration properties for the `useOCR` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L37) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L41) Object containing the necessary model sources and configuration for the OCR pipeline. @@ -42,7 +42,7 @@ The language configuration enum for the OCR model (e.g., English, Polish, etc.). > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L58) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:62](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L62) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/OCRType.md b/docs/docs/06-api-reference/interfaces/OCRType.md index e05a0ccdc..f33cc93a5 100644 --- a/docs/docs/06-api-reference/interfaces/OCRType.md +++ b/docs/docs/06-api-reference/interfaces/OCRType.md @@ -1,6 +1,6 @@ # Interface: OCRType -Defined in: [packages/react-native-executorch/src/types/ocr.ts:76](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L76) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:84](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L84) Return type for the `useOCR` hook. Manages the state and operations for Optical Character Recognition (OCR). @@ -11,7 +11,7 @@ Manages the state and operations for Optical Character Recognition (OCR). > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:95](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L95) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L103) Represents the total download progress of the model binaries as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the total download progress of the model binaries as a value between > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L80) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:88](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L88) Contains the error object if the models failed to load, download, or encountered a runtime error during recognition. @@ -31,7 +31,7 @@ Contains the error object if the models failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<[`OCRDetection`](OCRDetection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/ocr.ts:103](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L103) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:111](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L111) Executes the OCR pipeline (detection and recognition) on the provided image. @@ -59,7 +59,7 @@ If the models are not loaded or are currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:90](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L90) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:98](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L98) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:85](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L85) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:93](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L93) Indicates whether both detector and recognizer models are loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md index ddc7d16f7..60868eff2 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionProps.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionProps -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:135](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L135) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:140](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L140) Props for the `useObjectDetection` hook. @@ -10,7 +10,7 @@ Props for the `useObjectDetection` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:136](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L136) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:141](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L141) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:137](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L137) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:142](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L142) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md index d7298642c..c9ba4db56 100644 --- a/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md +++ b/docs/docs/06-api-reference/interfaces/ObjectDetectionType.md @@ -1,6 +1,6 @@ # Interface: ObjectDetectionType -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:144](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L144) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:151](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L151) Return type for the `useObjectDetection` hook. Manages the state and operations for Computer Vision object detection tasks. @@ -11,7 +11,7 @@ Manages the state and operations for Computer Vision object detection tasks. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:163](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L163) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:170](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L170) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:148](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L148) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:155](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L155) Contains the error object if the model failed to load, download, or encountered a runtime error during detection. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`, `detectionThreshold?`) => `Promise`\<[`Detection`](Detection.md)[]\> -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:172](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L172) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:179](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L179) Executes the model's forward pass to detect objects within the provided image. @@ -65,7 +65,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:158](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L158) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:165](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L165) Indicates whether the model is currently processing an image. @@ -75,6 +75,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:153](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/objectDetection.ts#L153) +Defined in: [packages/react-native-executorch/src/types/objectDetection.ts:160](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/objectDetection.ts#L160) Indicates whether the object detection model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/Point.md b/docs/docs/06-api-reference/interfaces/Point.md index 76ec0087d..3b4eb598d 100644 --- a/docs/docs/06-api-reference/interfaces/Point.md +++ b/docs/docs/06-api-reference/interfaces/Point.md @@ -1,6 +1,6 @@ # Interface: Point -Defined in: [packages/react-native-executorch/src/types/ocr.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L25) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L27) Point represents a coordinate in 2D space. @@ -10,7 +10,7 @@ Point represents a coordinate in 2D space. > **x**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L26) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:28](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L28) The x-coordinate of the point. @@ -20,6 +20,6 @@ The x-coordinate of the point. > **y**: `number` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:27](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L27) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:29](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L29) The y-coordinate of the point. diff --git a/docs/docs/06-api-reference/interfaces/Segment.md b/docs/docs/06-api-reference/interfaces/Segment.md index e01cac4b0..0f057bd5d 100644 --- a/docs/docs/06-api-reference/interfaces/Segment.md +++ b/docs/docs/06-api-reference/interfaces/Segment.md @@ -1,6 +1,6 @@ # Interface: Segment -Defined in: [packages/react-native-executorch/src/types/vad.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L22) +Defined in: [packages/react-native-executorch/src/types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L24) Represents a detected audio segment with start and end timestamps. @@ -10,7 +10,7 @@ Represents a detected audio segment with start and end timestamps. > **end**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L24) +Defined in: [packages/react-native-executorch/src/types/vad.ts:26](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L26) End time of the segment in seconds. @@ -20,6 +20,6 @@ End time of the segment in seconds. > **start**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L23) +Defined in: [packages/react-native-executorch/src/types/vad.ts:25](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L25) Start time of the segment in seconds. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md index f1a3c834c..0204727fe 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextModelConfig.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextModelConfig -Defined in: [packages/react-native-executorch/src/types/stt.ts:176](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L176) +Defined in: [packages/react-native-executorch/src/types/stt.ts:185](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L185) Configuration for Speech to Text model. @@ -10,7 +10,7 @@ Configuration for Speech to Text model. > **decoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:190](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L190) +Defined in: [packages/react-native-executorch/src/types/stt.ts:199](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L199) A string that specifies the location of a `.pte` file for the decoder. @@ -20,7 +20,7 @@ A string that specifies the location of a `.pte` file for the decoder. > **encoderSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:185](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L185) +Defined in: [packages/react-native-executorch/src/types/stt.ts:194](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L194) A string that specifies the location of a `.pte` file for the encoder. @@ -30,7 +30,7 @@ A string that specifies the location of a `.pte` file for the encoder. > **isMultilingual**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:180](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L180) +Defined in: [packages/react-native-executorch/src/types/stt.ts:189](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L189) A boolean flag indicating whether the model supports multiple languages. @@ -40,6 +40,6 @@ A boolean flag indicating whether the model supports multiple languages. > **tokenizerSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/stt.ts:195](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L195) +Defined in: [packages/react-native-executorch/src/types/stt.ts:204](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L204) A string that specifies the location to the tokenizer for the model. diff --git a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md index 416389bc5..565aa1ca8 100644 --- a/docs/docs/06-api-reference/interfaces/SpeechToTextType.md +++ b/docs/docs/06-api-reference/interfaces/SpeechToTextType.md @@ -1,6 +1,6 @@ # Interface: SpeechToTextType -Defined in: [packages/react-native-executorch/src/types/stt.ts:7](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L7) +Defined in: [packages/react-native-executorch/src/types/stt.ts:9](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L9) React hook for managing Speech to Text (STT) instance. @@ -10,7 +10,7 @@ React hook for managing Speech to Text (STT) instance. > **committedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:32](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L32) +Defined in: [packages/react-native-executorch/src/types/stt.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L34) Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. @@ -21,7 +21,7 @@ Useful for displaying stable results during streaming. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/stt.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L26) +Defined in: [packages/react-native-executorch/src/types/stt.ts:28](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L28) Tracks the progress of the model download process. @@ -31,7 +31,7 @@ Tracks the progress of the model download process. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/stt.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L11) +Defined in: [packages/react-native-executorch/src/types/stt.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L13) Contains the error message if the model failed to load. @@ -41,7 +41,7 @@ Contains the error message if the model failed to load. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L21) +Defined in: [packages/react-native-executorch/src/types/stt.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L23) Indicates whether the model is currently processing an inference. @@ -51,7 +51,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/stt.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L16) +Defined in: [packages/react-native-executorch/src/types/stt.ts:18](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L18) Indicates whether the model has successfully loaded and is ready for inference. @@ -61,7 +61,7 @@ Indicates whether the model has successfully loaded and is ready for inference. > **nonCommittedTranscription**: `string` -Defined in: [packages/react-native-executorch/src/types/stt.ts:38](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L38) +Defined in: [packages/react-native-executorch/src/types/stt.ts:40](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L40) Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. @@ -72,7 +72,7 @@ Useful for displaying live, partial results during streaming. > **decode**(`tokens`, `encoderOutput`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L53) +Defined in: [packages/react-native-executorch/src/types/stt.ts:55](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L55) Runs the decoder of the model. Passing `number[]` is deprecated. @@ -102,7 +102,7 @@ A promise resolving to the decoded text. > **encode**(`waveform`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L45) +Defined in: [packages/react-native-executorch/src/types/stt.ts:47](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L47) Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. @@ -126,7 +126,7 @@ A promise resolving to the encoded data. > **stream**(`options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:71](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L71) +Defined in: [packages/react-native-executorch/src/types/stt.ts:73](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L73) Starts a streaming transcription process. Use in combination with streamInsert to feed audio chunks and streamStop to end the stream. @@ -152,7 +152,7 @@ The final transcription string. > **streamInsert**(`waveform`): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L78) +Defined in: [packages/react-native-executorch/src/types/stt.ts:80](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L80) Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Passing `number[]` is deprecated. @@ -175,7 +175,7 @@ The audio chunk to insert. > **streamStop**(): `void` -Defined in: [packages/react-native-executorch/src/types/stt.ts:83](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L83) +Defined in: [packages/react-native-executorch/src/types/stt.ts:85](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L85) Stops the ongoing streaming transcription process. @@ -189,7 +189,7 @@ Stops the ongoing streaming transcription process. > **transcribe**(`waveform`, `options?`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/stt.ts:62](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L62) +Defined in: [packages/react-native-executorch/src/types/stt.ts:64](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L64) Starts a transcription process for a given input array, which should be a waveform at 16kHz. Passing `number[]` is deprecated. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md index b36a8b9c9..ddb1a23c2 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferProps.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferProps.md @@ -1,6 +1,6 @@ # Interface: StyleTransferProps -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L11) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/styleTransfer.ts#L12) Configuration properties for the `useStyleTransfer` hook. @@ -10,7 +10,7 @@ Configuration properties for the `useStyleTransfer` hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L12) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/styleTransfer.ts#L13) Object containing the `modelSource` for the style transfer model. @@ -24,6 +24,6 @@ Object containing the `modelSource` for the style transfer model. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L13) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/styleTransfer.ts#L14) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/StyleTransferType.md b/docs/docs/06-api-reference/interfaces/StyleTransferType.md index 8c2105fe7..b70ddb808 100644 --- a/docs/docs/06-api-reference/interfaces/StyleTransferType.md +++ b/docs/docs/06-api-reference/interfaces/StyleTransferType.md @@ -1,6 +1,6 @@ # Interface: StyleTransferType -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L20) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/styleTransfer.ts#L23) Return type for the `useStyleTransfer` hook. Manages the state and operations for applying artistic style transfer to images. @@ -11,7 +11,7 @@ Manages the state and operations for applying artistic style transfer to images. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L39) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:42](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/styleTransfer.ts#L42) Represents the download progress of the model binary as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model binary as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:24](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L24) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:27](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/styleTransfer.ts#L27) Contains the error object if the model failed to load, download, or encountered a runtime error during style transfer. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load, download, or encountered > **forward**: (`imageSource`) => `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L47) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:50](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/styleTransfer.ts#L50) Executes the model's forward pass to apply the specific artistic style to the provided image. @@ -59,7 +59,7 @@ If the model is not loaded or is currently processing another image. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L34) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:37](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/styleTransfer.ts#L37) Indicates whether the model is currently processing an image. @@ -69,6 +69,6 @@ Indicates whether the model is currently processing an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/styleTransfer.ts#L29) +Defined in: [packages/react-native-executorch/src/types/styleTransfer.ts:32](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/styleTransfer.ts#L32) Indicates whether the style transfer model is loaded and ready to process images. diff --git a/docs/docs/06-api-reference/interfaces/TensorPtr.md b/docs/docs/06-api-reference/interfaces/TensorPtr.md index 317f4e53a..e8df36b3a 100644 --- a/docs/docs/06-api-reference/interfaces/TensorPtr.md +++ b/docs/docs/06-api-reference/interfaces/TensorPtr.md @@ -1,6 +1,6 @@ # Interface: TensorPtr -Defined in: [packages/react-native-executorch/src/types/common.ts:127](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L127) +Defined in: [packages/react-native-executorch/src/types/common.ts:134](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L134) Represents a pointer to a tensor, including its data buffer, size dimensions, and scalar type. @@ -10,7 +10,7 @@ Represents a pointer to a tensor, including its data buffer, size dimensions, an > **dataPtr**: [`TensorBuffer`](../type-aliases/TensorBuffer.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L128) +Defined in: [packages/react-native-executorch/src/types/common.ts:135](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L135) The data buffer of the tensor. @@ -20,7 +20,7 @@ The data buffer of the tensor. > **scalarType**: [`ScalarType`](../enumerations/ScalarType.md) -Defined in: [packages/react-native-executorch/src/types/common.ts:130](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L130) +Defined in: [packages/react-native-executorch/src/types/common.ts:137](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L137) The scalar type of the tensor, as defined in the `ScalarType` enum. @@ -30,6 +30,6 @@ The scalar type of the tensor, as defined in the `ScalarType` enum. > **sizes**: `number`[] -Defined in: [packages/react-native-executorch/src/types/common.ts:129](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L129) +Defined in: [packages/react-native-executorch/src/types/common.ts:136](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L136) An array representing the size of each dimension of the tensor. diff --git a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md index 94e88722a..aa2ffd297 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsProps.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsProps -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:45](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L45) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:48](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/textEmbeddings.ts#L48) Props for the useTextEmbeddings hook. @@ -10,7 +10,7 @@ Props for the useTextEmbeddings hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L46) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:49](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/textEmbeddings.ts#L49) An object containing the model and tokenizer sources. @@ -28,6 +28,6 @@ An object containing the model and tokenizer sources. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:50](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L50) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:53](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/textEmbeddings.ts#L53) 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 8db7b95da..f43a03f07 100644 --- a/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md +++ b/docs/docs/06-api-reference/interfaces/TextEmbeddingsType.md @@ -1,6 +1,6 @@ # Interface: TextEmbeddingsType -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:7](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L7) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:9](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/textEmbeddings.ts#L9) React hook state and methods for managing a Text Embeddings model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Text Embeddings model instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L26) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:28](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/textEmbeddings.ts#L28) Tracks the progress of the model download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the model download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L11) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/textEmbeddings.ts#L13) Contains the error message if the model failed to load or during inference. @@ -30,7 +30,7 @@ Contains the error message if the model failed to load or during inference. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L21) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/textEmbeddings.ts#L23) Indicates whether the model is currently generating embeddings. @@ -40,7 +40,7 @@ Indicates whether the model is currently generating embeddings. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L16) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:18](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/textEmbeddings.ts#L18) Indicates whether the embeddings model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the embeddings model has successfully loaded and is ready for > **forward**(`input`): `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/textEmbeddings.ts#L34) +Defined in: [packages/react-native-executorch/src/types/textEmbeddings.ts:36](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/textEmbeddings.ts#L36) Runs the text embeddings model on the provided input string. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageParams.md b/docs/docs/06-api-reference/interfaces/TextToImageParams.md index ba35bcc97..c81c0857b 100644 --- a/docs/docs/06-api-reference/interfaces/TextToImageParams.md +++ b/docs/docs/06-api-reference/interfaces/TextToImageParams.md @@ -1,6 +1,6 @@ # Interface: TextToImageParams -Defined in: [packages/react-native-executorch/src/types/tti.ts:7](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L7) +Defined in: [packages/react-native-executorch/src/types/tti.ts:9](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L9) Configuration properties for the `useTextToImage` hook. @@ -10,7 +10,7 @@ Configuration properties for the `useTextToImage` hook. > `optional` **inferenceCallback**: (`stepIdx`) => `void` -Defined in: [packages/react-native-executorch/src/types/tti.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L29) +Defined in: [packages/react-native-executorch/src/types/tti.ts:31](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L31) Optional callback function that is triggered after each diffusion inference step. Useful for updating a progress bar during image generation. @@ -33,7 +33,7 @@ The index of the current inference step. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/tti.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L11) +Defined in: [packages/react-native-executorch/src/types/tti.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L13) Object containing the required model sources for the diffusion pipeline. @@ -73,7 +73,7 @@ Source for the UNet (noise predictor) model binary. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:35](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L35) +Defined in: [packages/react-native-executorch/src/types/tti.ts:37](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L37) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/TextToImageType.md b/docs/docs/06-api-reference/interfaces/TextToImageType.md index 436a21c7d..e304b8a4e 100644 --- a/docs/docs/06-api-reference/interfaces/TextToImageType.md +++ b/docs/docs/06-api-reference/interfaces/TextToImageType.md @@ -1,6 +1,6 @@ # Interface: TextToImageType -Defined in: [packages/react-native-executorch/src/types/tti.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L42) +Defined in: [packages/react-native-executorch/src/types/tti.ts:46](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L46) Return type for the `useTextToImage` hook. Manages the state and operations for generating images from text prompts using a diffusion model pipeline. @@ -11,7 +11,7 @@ Manages the state and operations for generating images from text prompts using a > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tti.ts:61](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L61) +Defined in: [packages/react-native-executorch/src/types/tti.ts:65](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L65) Represents the total download progress of all the model binaries combined, as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the total download progress of all the model binaries combined, as a > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tti.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tti.ts:50](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L50) Contains the error object if any of the pipeline models failed to load, download, or encountered a runtime error. @@ -31,7 +31,7 @@ Contains the error object if any of the pipeline models failed to load, download > **generate**: (`input`, `imageSize?`, `numSteps?`, `seed?`) => `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tti.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L72) +Defined in: [packages/react-native-executorch/src/types/tti.ts:76](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L76) Runs the diffusion pipeline to generate an image from the provided text prompt. @@ -77,7 +77,7 @@ If the model is not loaded or is currently generating another image. > **interrupt**: () => `void` -Defined in: [packages/react-native-executorch/src/types/tti.ts:82](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L82) +Defined in: [packages/react-native-executorch/src/types/tti.ts:86](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L86) Interrupts the currently active image generation process at the next available inference step. @@ -91,7 +91,7 @@ Interrupts the currently active image generation process at the next available i > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L56) +Defined in: [packages/react-native-executorch/src/types/tti.ts:60](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L60) Indicates whether the model is currently generating an image. @@ -101,6 +101,6 @@ Indicates whether the model is currently generating an image. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tti.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tti.ts#L51) +Defined in: [packages/react-native-executorch/src/types/tti.ts:55](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tti.ts#L55) Indicates whether the entire diffusion pipeline is loaded into memory and ready for generation. diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md index 284d8e2ca..6cfbdf9da 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechConfig.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L56) +Defined in: [packages/react-native-executorch/src/types/tts.ts:64](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L64) General Text to Speech module configuration @@ -14,7 +14,7 @@ General Text to Speech module configuration > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L57) +Defined in: [packages/react-native-executorch/src/types/tts.ts:65](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L65) a selected T2S model @@ -24,6 +24,6 @@ a selected T2S model > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L58) +Defined in: [packages/react-native-executorch/src/types/tts.ts:66](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L66) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md index e1637ff47..46377e8ea 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L78) +Defined in: [packages/react-native-executorch/src/types/tts.ts:88](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L88) Text to Speech module input definition @@ -14,7 +14,7 @@ Text to Speech module input definition > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L80) +Defined in: [packages/react-native-executorch/src/types/tts.ts:90](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L90) optional speed argument - the higher it is, the faster the speech becomes @@ -24,6 +24,6 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L79) +Defined in: [packages/react-native-executorch/src/types/tts.ts:89](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L89) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md index 59d59ebc7..769751e24 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechProps.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechProps -Defined in: [packages/react-native-executorch/src/types/tts.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L68) +Defined in: [packages/react-native-executorch/src/types/tts.ts:77](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L77) Props for the useTextToSpeech hook. @@ -14,7 +14,7 @@ Props for the useTextToSpeech hook. > **model**: [`KokoroConfig`](KokoroConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L57) +Defined in: [packages/react-native-executorch/src/types/tts.ts:65](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L65) a selected T2S model @@ -28,7 +28,7 @@ a selected T2S model > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L69) +Defined in: [packages/react-native-executorch/src/types/tts.ts:78](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L78) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. @@ -38,7 +38,7 @@ Boolean that can prevent automatic model loading (and downloading the data if yo > **voice**: [`VoiceConfig`](VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L58) +Defined in: [packages/react-native-executorch/src/types/tts.ts:66](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L66) a selected speaker's voice diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md index e2df7c691..d68eea683 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechStreamingInput.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechStreamingInput -Defined in: [packages/react-native-executorch/src/types/tts.ts:142](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L142) +Defined in: [packages/react-native-executorch/src/types/tts.ts:156](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L156) Text to Speech streaming input definition @@ -19,7 +19,7 @@ Callbacks can be both synchronous or asynchronous. > `optional` **onBegin**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:143](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L143) +Defined in: [packages/react-native-executorch/src/types/tts.ts:157](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L157) Called when streaming begins @@ -33,7 +33,7 @@ Called when streaming begins > `optional` **onEnd**: () => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:145](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L145) +Defined in: [packages/react-native-executorch/src/types/tts.ts:159](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L159) Called when streaming ends @@ -47,7 +47,7 @@ Called when streaming ends > `optional` **onNext**: (`audio`) => `void` \| `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:144](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L144) +Defined in: [packages/react-native-executorch/src/types/tts.ts:158](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L158) Called after each audio chunk gets calculated. @@ -67,7 +67,7 @@ Called after each audio chunk gets calculated. > `optional` **speed**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L80) +Defined in: [packages/react-native-executorch/src/types/tts.ts:90](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L90) optional speed argument - the higher it is, the faster the speech becomes @@ -81,7 +81,7 @@ optional speed argument - the higher it is, the faster the speech becomes > **text**: `string` -Defined in: [packages/react-native-executorch/src/types/tts.ts:79](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L79) +Defined in: [packages/react-native-executorch/src/types/tts.ts:89](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L89) a text to be spoken diff --git a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md index 22ffa9db4..8f594baf6 100644 --- a/docs/docs/06-api-reference/interfaces/TextToSpeechType.md +++ b/docs/docs/06-api-reference/interfaces/TextToSpeechType.md @@ -1,6 +1,6 @@ # Interface: TextToSpeechType -Defined in: [packages/react-native-executorch/src/types/tts.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L87) +Defined in: [packages/react-native-executorch/src/types/tts.ts:99](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L99) Return type for the `useTextToSpeech` hook. Manages the state and operations for Text-to-Speech generation. @@ -11,7 +11,7 @@ Manages the state and operations for Text-to-Speech generation. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tts.ts:106](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L106) +Defined in: [packages/react-native-executorch/src/types/tts.ts:118](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L118) Represents the download progress of the model and voice assets as a value between 0 and 1. @@ -21,7 +21,7 @@ Represents the download progress of the model and voice assets as a value betwee > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tts.ts:91](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L91) +Defined in: [packages/react-native-executorch/src/types/tts.ts:103](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L103) Contains the error object if the model failed to load or encountered an error during inference. @@ -31,7 +31,7 @@ Contains the error object if the model failed to load or encountered an error du > **forward**: (`input`) => `Promise`\<`Float32Array`\<`ArrayBufferLike`\>\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:114](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L114) +Defined in: [packages/react-native-executorch/src/types/tts.ts:126](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L126) Runs the model to convert the provided text into speech audio in a single pass. * @@ -60,7 +60,7 @@ If the model is not loaded or is currently generating. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:101](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L101) +Defined in: [packages/react-native-executorch/src/types/tts.ts:113](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L113) Indicates whether the model is currently generating audio. @@ -70,7 +70,7 @@ Indicates whether the model is currently generating audio. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tts.ts:96](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L96) +Defined in: [packages/react-native-executorch/src/types/tts.ts:108](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L108) Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. @@ -80,7 +80,7 @@ Indicates whether the Text-to-Speech model is loaded and ready to accept inputs. > **stream**: (`input`) => `Promise`\<`void`\> -Defined in: [packages/react-native-executorch/src/types/tts.ts:123](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L123) +Defined in: [packages/react-native-executorch/src/types/tts.ts:135](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L135) Streams the generated audio data incrementally. This is optimal for real-time playback, allowing audio to start playing before the full text is synthesized. @@ -110,7 +110,7 @@ If the model is not loaded or is currently generating. > **streamStop**: () => `void` -Defined in: [packages/react-native-executorch/src/types/tts.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L128) +Defined in: [packages/react-native-executorch/src/types/tts.ts:140](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L140) Interrupts and stops the currently active audio generation stream. diff --git a/docs/docs/06-api-reference/interfaces/TokenizerType.md b/docs/docs/06-api-reference/interfaces/TokenizerType.md index 5b40632ce..a3b53eac7 100644 --- a/docs/docs/06-api-reference/interfaces/TokenizerType.md +++ b/docs/docs/06-api-reference/interfaces/TokenizerType.md @@ -1,6 +1,6 @@ # Interface: TokenizerType -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:6](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L6) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tokenizer.ts#L8) React hook state and methods for managing a Tokenizer instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Tokenizer instance. > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:25](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L25) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:27](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tokenizer.ts#L27) Tracks the progress of the tokenizer download process (value between 0 and 1). @@ -20,7 +20,7 @@ Tracks the progress of the tokenizer download process (value between 0 and 1). > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L10) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tokenizer.ts#L12) Contains the error message if the tokenizer failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the tokenizer failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:22](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tokenizer.ts#L22) Indicates whether the tokenizer is currently processing data. @@ -40,7 +40,7 @@ Indicates whether the tokenizer is currently processing data. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:15](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L15) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:17](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tokenizer.ts#L17) Indicates whether the tokenizer has successfully loaded and is ready for use. @@ -50,7 +50,7 @@ Indicates whether the tokenizer has successfully loaded and is ready for use. > **decode**(`tokens`, `skipSpecialTokens`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:33](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L33) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:35](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tokenizer.ts#L35) Converts an array of token IDs into a string. @@ -80,7 +80,7 @@ A promise resolving to the decoded text string. > **encode**(`text`): `Promise`\<`number`[]\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L40) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:42](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tokenizer.ts#L42) Converts a string into an array of token IDs. @@ -104,7 +104,7 @@ A promise resolving to an array `number[]` containing the encoded token IDs. > **getVocabSize**(): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L46) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:48](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tokenizer.ts#L48) Returns the size of the tokenizer's vocabulary. @@ -120,7 +120,7 @@ A promise resolving to the vocabulary size. > **idToToken**(`id`): `Promise`\<`string`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L53) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:55](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tokenizer.ts#L55) Returns the token associated to the ID. @@ -144,7 +144,7 @@ A promise resolving to the token string representation. > **tokenToId**(`token`): `Promise`\<`number`\> -Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tokenizer.ts#L60) +Defined in: [packages/react-native-executorch/src/types/tokenizer.ts:62](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tokenizer.ts#L62) Returns the ID associated to the token. diff --git a/docs/docs/06-api-reference/interfaces/ToolCall.md b/docs/docs/06-api-reference/interfaces/ToolCall.md index 4ae31dd09..72a5d2dc8 100644 --- a/docs/docs/06-api-reference/interfaces/ToolCall.md +++ b/docs/docs/06-api-reference/interfaces/ToolCall.md @@ -1,6 +1,6 @@ # Interface: ToolCall -Defined in: [packages/react-native-executorch/src/types/llm.ts:152](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L152) +Defined in: [packages/react-native-executorch/src/types/llm.ts:160](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L160) Represents a tool call made by the model. @@ -10,7 +10,7 @@ Represents a tool call made by the model. > **arguments**: `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:154](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L154) +Defined in: [packages/react-native-executorch/src/types/llm.ts:162](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L162) The arguments passed to the tool. @@ -20,6 +20,6 @@ The arguments passed to the tool. > **toolName**: `string` -Defined in: [packages/react-native-executorch/src/types/llm.ts:153](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L153) +Defined in: [packages/react-native-executorch/src/types/llm.ts:161](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L161) The name of the tool being called. diff --git a/docs/docs/06-api-reference/interfaces/ToolsConfig.md b/docs/docs/06-api-reference/interfaces/ToolsConfig.md index ecc23fc3f..ccf0b5a5f 100644 --- a/docs/docs/06-api-reference/interfaces/ToolsConfig.md +++ b/docs/docs/06-api-reference/interfaces/ToolsConfig.md @@ -1,6 +1,6 @@ # Interface: ToolsConfig -Defined in: [packages/react-native-executorch/src/types/llm.ts:184](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L184) +Defined in: [packages/react-native-executorch/src/types/llm.ts:196](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L196) Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. @@ -10,7 +10,7 @@ Object configuring options for enabling and managing tool use. **It will only ha > `optional` **displayToolCalls**: `boolean` -Defined in: [packages/react-native-executorch/src/types/llm.ts:187](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L187) +Defined in: [packages/react-native-executorch/src/types/llm.ts:199](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L199) If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. @@ -20,7 +20,7 @@ If set to true, JSON tool calls will be displayed in chat. If false, only answer > **executeToolCallback**: (`call`) => `Promise`\<`string` \| `null`\> -Defined in: [packages/react-native-executorch/src/types/llm.ts:186](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L186) +Defined in: [packages/react-native-executorch/src/types/llm.ts:198](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L198) Function that accepts `ToolCall`, executes tool and returns the string to model. @@ -40,6 +40,6 @@ Function that accepts `ToolCall`, executes tool and returns the string to model. > **tools**: `Object`[] -Defined in: [packages/react-native-executorch/src/types/llm.ts:185](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L185) +Defined in: [packages/react-native-executorch/src/types/llm.ts:197](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L197) List of objects defining tools. diff --git a/docs/docs/06-api-reference/interfaces/VADProps.md b/docs/docs/06-api-reference/interfaces/VADProps.md index 42a4768eb..4339cf37f 100644 --- a/docs/docs/06-api-reference/interfaces/VADProps.md +++ b/docs/docs/06-api-reference/interfaces/VADProps.md @@ -1,6 +1,6 @@ # Interface: VADProps -Defined in: [packages/react-native-executorch/src/types/vad.ts:11](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L11) +Defined in: [packages/react-native-executorch/src/types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L12) Props for the useVAD hook. @@ -10,7 +10,7 @@ Props for the useVAD hook. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/vad.ts:12](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L12) +Defined in: [packages/react-native-executorch/src/types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L13) An object containing the model source. @@ -24,6 +24,6 @@ An object containing the model source. > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L13) +Defined in: [packages/react-native-executorch/src/types/vad.ts:14](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L14) Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. diff --git a/docs/docs/06-api-reference/interfaces/VADType.md b/docs/docs/06-api-reference/interfaces/VADType.md index bcd434177..64a94a2d1 100644 --- a/docs/docs/06-api-reference/interfaces/VADType.md +++ b/docs/docs/06-api-reference/interfaces/VADType.md @@ -1,6 +1,6 @@ # Interface: VADType -Defined in: [packages/react-native-executorch/src/types/vad.ts:30](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L30) +Defined in: [packages/react-native-executorch/src/types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L34) React hook state and methods for managing a Voice Activity Detection (VAD) model instance. @@ -10,7 +10,7 @@ React hook state and methods for managing a Voice Activity Detection (VAD) model > **downloadProgress**: `number` -Defined in: [packages/react-native-executorch/src/types/vad.ts:49](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L49) +Defined in: [packages/react-native-executorch/src/types/vad.ts:53](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L53) Represents the download progress as a value between 0 and 1. @@ -20,7 +20,7 @@ Represents the download progress as a value between 0 and 1. > **error**: [`RnExecutorchError`](../classes/RnExecutorchError.md) \| `null` -Defined in: [packages/react-native-executorch/src/types/vad.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L34) +Defined in: [packages/react-native-executorch/src/types/vad.ts:38](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L38) Contains the error message if the VAD model failed to load or during processing. @@ -30,7 +30,7 @@ Contains the error message if the VAD model failed to load or during processing. > **isGenerating**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:44](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L44) +Defined in: [packages/react-native-executorch/src/types/vad.ts:48](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L48) Indicates whether the model is currently processing an inference. @@ -40,7 +40,7 @@ Indicates whether the model is currently processing an inference. > **isReady**: `boolean` -Defined in: [packages/react-native-executorch/src/types/vad.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L39) +Defined in: [packages/react-native-executorch/src/types/vad.ts:43](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L43) Indicates whether the VAD model has successfully loaded and is ready for inference. @@ -50,7 +50,7 @@ Indicates whether the VAD model has successfully loaded and is ready for inferen > **forward**(`waveform`): `Promise`\<[`Segment`](Segment.md)[]\> -Defined in: [packages/react-native-executorch/src/types/vad.ts:57](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/vad.ts#L57) +Defined in: [packages/react-native-executorch/src/types/vad.ts:61](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/vad.ts#L61) Runs the Voice Activity Detection model on the provided audio waveform. diff --git a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md index 64b5af713..d284ef736 100644 --- a/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md +++ b/docs/docs/06-api-reference/interfaces/VerticalOCRProps.md @@ -1,6 +1,6 @@ # Interface: VerticalOCRProps -Defined in: [packages/react-native-executorch/src/types/ocr.ts:64](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L64) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:70](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L70) Configuration properties for the `useVerticalOCR` hook. @@ -14,7 +14,7 @@ Configuration properties for the `useVerticalOCR` hook. > `optional` **independentCharacters**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:69](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L69) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:75](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L75) Boolean indicating whether to treat each character independently during recognition. Defaults to `false`. @@ -25,7 +25,7 @@ Defaults to `false`. > **model**: `object` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:37](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L37) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L41) Object containing the necessary model sources and configuration for the OCR pipeline. @@ -57,7 +57,7 @@ The language configuration enum for the OCR model (e.g., English, Polish, etc.). > `optional` **preventLoad**: `boolean` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:58](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L58) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:62](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L62) Boolean that can prevent automatic model loading (and downloading the data if loaded for the first time) after running the hook. Defaults to `false`. diff --git a/docs/docs/06-api-reference/interfaces/VoiceConfig.md b/docs/docs/06-api-reference/interfaces/VoiceConfig.md index 177b3c950..3460a134a 100644 --- a/docs/docs/06-api-reference/interfaces/VoiceConfig.md +++ b/docs/docs/06-api-reference/interfaces/VoiceConfig.md @@ -1,6 +1,6 @@ # Interface: VoiceConfig -Defined in: [packages/react-native-executorch/src/types/tts.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L18) +Defined in: [packages/react-native-executorch/src/types/tts.ts:23](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L23) Voice configuration @@ -12,7 +12,7 @@ So far in Kokoro, each voice is directly associated with a language. > `optional` **extra**: [`KokoroVoiceExtras`](KokoroVoiceExtras.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L21) +Defined in: [packages/react-native-executorch/src/types/tts.ts:26](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L26) an optional extra sources or properties related to specific voice @@ -22,7 +22,7 @@ an optional extra sources or properties related to specific voice > **lang**: [`TextToSpeechLanguage`](../type-aliases/TextToSpeechLanguage.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:19](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L19) +Defined in: [packages/react-native-executorch/src/types/tts.ts:24](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L24) speaker's language @@ -32,6 +32,6 @@ speaker's language > **voiceSource**: [`ResourceSource`](../type-aliases/ResourceSource.md) -Defined in: [packages/react-native-executorch/src/types/tts.ts:20](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L20) +Defined in: [packages/react-native-executorch/src/types/tts.ts:25](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L25) a source to a binary file with voice embedding diff --git a/docs/docs/06-api-reference/type-aliases/LLMTool.md b/docs/docs/06-api-reference/type-aliases/LLMTool.md index f6e4468d6..083d4eee6 100644 --- a/docs/docs/06-api-reference/type-aliases/LLMTool.md +++ b/docs/docs/06-api-reference/type-aliases/LLMTool.md @@ -2,7 +2,7 @@ > **LLMTool** = `Object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:162](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L162) +Defined in: [packages/react-native-executorch/src/types/llm.ts:172](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L172) Represents a tool that can be used by the model. Usually tool is represented with dictionary (Object), but fields depend on the model. diff --git a/docs/docs/06-api-reference/type-aliases/MessageRole.md b/docs/docs/06-api-reference/type-aliases/MessageRole.md index f32bacf1e..26135f372 100644 --- a/docs/docs/06-api-reference/type-aliases/MessageRole.md +++ b/docs/docs/06-api-reference/type-aliases/MessageRole.md @@ -2,6 +2,6 @@ > **MessageRole** = `"user"` \| `"assistant"` \| `"system"` -Defined in: [packages/react-native-executorch/src/types/llm.ts:133](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L133) +Defined in: [packages/react-native-executorch/src/types/llm.ts:139](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L139) Roles that a message sender can have. diff --git a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md index d96ec4c7f..227cf2a84 100644 --- a/docs/docs/06-api-reference/type-aliases/OCRLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/OCRLanguage.md @@ -2,6 +2,6 @@ > **OCRLanguage** = keyof *typeof* `symbols` -Defined in: [packages/react-native-executorch/src/types/ocr.ts:109](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/ocr.ts#L109) +Defined in: [packages/react-native-executorch/src/types/ocr.ts:119](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/ocr.ts#L119) Enumeration of supported OCR languages based on available symbol sets. diff --git a/docs/docs/06-api-reference/type-aliases/ResourceSource.md b/docs/docs/06-api-reference/type-aliases/ResourceSource.md index 15b5ba230..005b6b889 100644 --- a/docs/docs/06-api-reference/type-aliases/ResourceSource.md +++ b/docs/docs/06-api-reference/type-aliases/ResourceSource.md @@ -2,6 +2,6 @@ > **ResourceSource** = `string` \| `number` \| `object` -Defined in: [packages/react-native-executorch/src/types/common.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L8) +Defined in: [packages/react-native-executorch/src/types/common.ts:10](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L10) Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). diff --git a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md index cfa34aeee..3b982463f 100644 --- a/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/SpeechToTextLanguage.md @@ -2,4 +2,6 @@ > **SpeechToTextLanguage** = `"af"` \| `"sq"` \| `"ar"` \| `"hy"` \| `"az"` \| `"eu"` \| `"be"` \| `"bn"` \| `"bs"` \| `"bg"` \| `"my"` \| `"ca"` \| `"zh"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"et"` \| `"en"` \| `"fi"` \| `"fr"` \| `"gl"` \| `"ka"` \| `"de"` \| `"el"` \| `"gu"` \| `"ht"` \| `"he"` \| `"hi"` \| `"hu"` \| `"is"` \| `"id"` \| `"it"` \| `"ja"` \| `"kn"` \| `"kk"` \| `"km"` \| `"ko"` \| `"lo"` \| `"lv"` \| `"lt"` \| `"mk"` \| `"mg"` \| `"ms"` \| `"ml"` \| `"mt"` \| `"mr"` \| `"ne"` \| `"no"` \| `"fa"` \| `"pl"` \| `"pt"` \| `"pa"` \| `"ro"` \| `"ru"` \| `"sr"` \| `"si"` \| `"sk"` \| `"sl"` \| `"es"` \| `"su"` \| `"sw"` \| `"sv"` \| `"tl"` \| `"tg"` \| `"ta"` \| `"te"` \| `"th"` \| `"tr"` \| `"uk"` \| `"ur"` \| `"uz"` \| `"vi"` \| `"cy"` \| `"yi"` -Defined in: [packages/react-native-executorch/src/types/stt.ts:87](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/stt.ts#L87) +Defined in: [packages/react-native-executorch/src/types/stt.ts:93](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/stt.ts#L93) + +Languages supported by whisper (not whisper.en) diff --git a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md index a8f23981b..5f8d7ea25 100644 --- a/docs/docs/06-api-reference/type-aliases/TensorBuffer.md +++ b/docs/docs/06-api-reference/type-aliases/TensorBuffer.md @@ -2,6 +2,6 @@ > **TensorBuffer** = `ArrayBuffer` \| `Float32Array` \| `Float64Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `Uint8Array` \| `Uint16Array` \| `Uint32Array` \| `BigInt64Array` \| `BigUint64Array` -Defined in: [packages/react-native-executorch/src/types/common.ts:107](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/common.ts#L107) +Defined in: [packages/react-native-executorch/src/types/common.ts:113](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/common.ts#L113) Represents the data buffer of a tensor, which can be one of several typed array formats. diff --git a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md index d96ebd220..723b7dbbc 100644 --- a/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md +++ b/docs/docs/06-api-reference/type-aliases/TextToSpeechLanguage.md @@ -2,4 +2,6 @@ > **TextToSpeechLanguage** = `"en-us"` \| `"en-gb"` -Defined in: [packages/react-native-executorch/src/types/tts.ts:5](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/tts.ts#L5) +Defined in: [packages/react-native-executorch/src/types/tts.ts:9](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/tts.ts#L9) + +List all the languages available in TTS models (as lang shorthands) diff --git a/docs/docs/06-api-reference/typedoc-sidebar.cjs b/docs/docs/06-api-reference/typedoc-sidebar.cjs index 16f0f6d2b..720ee5300 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:"Enumerations",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/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"}]},{type:"category",label:"Classes",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"},{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:"Interfaces",items:[{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleProps",label:"ExecutorchModuleProps"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleType",label:"ExecutorchModuleType"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsProps",label:"ImageEmbeddingsProps"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsType",label:"ImageEmbeddingsType"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationProps",label:"ImageSegmentationProps"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationType",label:"ImageSegmentationType"},{type:"doc",id:"06-api-reference/interfaces/KokoroConfig",label:"KokoroConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroVoiceExtras",label:"KokoroVoiceExtras"},{type:"doc",id:"06-api-reference/interfaces/LLMConfig",label:"LLMConfig"},{type:"doc",id:"06-api-reference/interfaces/LLMType",label:"LLMType"},{type:"doc",id:"06-api-reference/interfaces/Message",label:"Message"},{type:"doc",id:"06-api-reference/interfaces/ObjectDetectionProps",label:"ObjectDetectionProps"},{type:"doc",id:"06-api-reference/interfaces/ObjectDetectionType",label:"ObjectDetectionType"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/OCRProps",label:"OCRProps"},{type:"doc",id:"06-api-reference/interfaces/OCRType",label:"OCRType"},{type:"doc",id:"06-api-reference/interfaces/Point",label:"Point"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/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/TextToImageParams",label:"TextToImageParams"},{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/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/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:"category",label:"Type Aliases",items:[{type:"doc",id:"06-api-reference/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"}]},{type:"category",label:"Variables",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/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:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"},{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/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CHAT_CONFIG",label:"DEFAULT_CHAT_CONFIG"},{type:"doc",id:"06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"},{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"},{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/KOKORO_MEDIUM",label:"KOKORO_MEDIUM"},{type:"doc",id:"06-api-reference/variables/KOKORO_SMALL",label:"KOKORO_SMALL"},{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:"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/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:"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:"doc",id:"06-api-reference/variables/parseToolCall",label:"parseToolCall"},{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:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"},{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"},{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:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ABAZA",label:"VERTICAL_OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ADYGHE",label:"VERTICAL_OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AFRIKAANS",label:"VERTICAL_OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ALBANIAN",label:"VERTICAL_OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AVAR",label:"VERTICAL_OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI",label:"VERTICAL_OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BELARUSIAN",label:"VERTICAL_OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BOSNIAN",label:"VERTICAL_OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_BULGARIAN",label:"VERTICAL_OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CHECHEN",label:"VERTICAL_OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CROATIAN",label:"VERTICAL_OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_CZECH",label:"VERTICAL_OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DANISH",label:"VERTICAL_OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DARGWA",label:"VERTICAL_OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_DUTCH",label:"VERTICAL_OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ENGLISH",label:"VERTICAL_OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ESTONIAN",label:"VERTICAL_OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_FRENCH",label:"VERTICAL_OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_GERMAN",label:"VERTICAL_OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_HUNGARIAN",label:"VERTICAL_OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ICELANDIC",label:"VERTICAL_OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INDONESIAN",label:"VERTICAL_OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_INGUSH",label:"VERTICAL_OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_IRISH",label:"VERTICAL_OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ITALIAN",label:"VERTICAL_OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_JAPANESE",label:"VERTICAL_OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KANNADA",label:"VERTICAL_OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KARBADIAN",label:"VERTICAL_OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KOREAN",label:"VERTICAL_OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_KURDISH",label:"VERTICAL_OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LAK",label:"VERTICAL_OCR_LAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATIN",label:"VERTICAL_OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LATVIAN",label:"VERTICAL_OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LEZGHIAN",label:"VERTICAL_OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_LITHUANIAN",label:"VERTICAL_OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALAY",label:"VERTICAL_OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MALTESE",label:"VERTICAL_OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MAORI",label:"VERTICAL_OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_MONGOLIAN",label:"VERTICAL_OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_NORWEGIAN",label:"VERTICAL_OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_OCCITAN",label:"VERTICAL_OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PALI",label:"VERTICAL_OCR_PALI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_POLISH",label:"VERTICAL_OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_PORTUGUESE",label:"VERTICAL_OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_ROMANIAN",label:"VERTICAL_OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_RUSSIAN",label:"VERTICAL_OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC",label:"VERTICAL_OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN",label:"VERTICAL_OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE",label:"VERTICAL_OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVAK",label:"VERTICAL_OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SLOVENIAN",label:"VERTICAL_OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SPANISH",label:"VERTICAL_OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWAHILI",label:"VERTICAL_OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_SWEDISH",label:"VERTICAL_OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TABASSARAN",label:"VERTICAL_OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAGALOG",label:"VERTICAL_OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TAJIK",label:"VERTICAL_OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TELUGU",label:"VERTICAL_OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_TURKISH",label:"VERTICAL_OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UKRAINIAN",label:"VERTICAL_OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_UZBEK",label:"VERTICAL_OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_VIETNAMESE",label:"VERTICAL_OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/VERTICAL_OCR_WELSH",label:"VERTICAL_OCR_WELSH"},{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:"Functions",items:[{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:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]}]}; +const typedocSidebar = {items:[{type:"category",label:"Hooks",items:[{type:"doc",id:"06-api-reference/functions/useClassification",label:"useClassification"},{type:"doc",id:"06-api-reference/functions/useExecutorchModule",label:"useExecutorchModule"},{type:"doc",id:"06-api-reference/functions/useImageEmbeddings",label:"useImageEmbeddings"},{type:"doc",id:"06-api-reference/functions/useImageSegmentation",label:"useImageSegmentation"},{type:"doc",id:"06-api-reference/functions/useLLM",label:"useLLM"},{type:"doc",id:"06-api-reference/functions/useObjectDetection",label:"useObjectDetection"},{type:"doc",id:"06-api-reference/functions/useOCR",label:"useOCR"},{type:"doc",id:"06-api-reference/functions/useSpeechToText",label:"useSpeechToText"},{type:"doc",id:"06-api-reference/functions/useStyleTransfer",label:"useStyleTransfer"},{type:"doc",id:"06-api-reference/functions/useTextEmbeddings",label:"useTextEmbeddings"},{type:"doc",id:"06-api-reference/functions/useTextToImage",label:"useTextToImage"},{type:"doc",id:"06-api-reference/functions/useTextToSpeech",label:"useTextToSpeech"},{type:"doc",id:"06-api-reference/functions/useTokenizer",label:"useTokenizer"},{type:"doc",id:"06-api-reference/functions/useVAD",label:"useVAD"},{type:"doc",id:"06-api-reference/functions/useVerticalOCR",label:"useVerticalOCR"}]},{type:"category",label:"Models - Classification",items:[{type:"doc",id:"06-api-reference/variables/EFFICIENTNET_V2_S",label:"EFFICIENTNET_V2_S"}]},{type:"category",label:"Models - Image Embeddings",items:[{type:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE",label:"CLIP_VIT_BASE_PATCH32_IMAGE"}]},{type:"category",label:"Models - Image Generation",items:[{type:"doc",id:"06-api-reference/variables/BK_SDM_TINY_VPRED_256",label:"BK_SDM_TINY_VPRED_256"},{type:"doc",id:"06-api-reference/variables/BK_SDM_TINY_VPRED_512",label:"BK_SDM_TINY_VPRED_512"}]},{type:"category",label:"Models - Image Segmentation",items:[{type:"doc",id:"06-api-reference/variables/DEEPLAB_V3_RESNET50",label:"DEEPLAB_V3_RESNET50"}]},{type:"category",label:"Models - LMM",items:[{type:"doc",id:"06-api-reference/variables/HAMMER2_1_0_5B",label:"HAMMER2_1_0_5B"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED",label:"HAMMER2_1_0_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_1_5B",label:"HAMMER2_1_1_5B"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED",label:"HAMMER2_1_1_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_3B",label:"HAMMER2_1_3B"},{type:"doc",id:"06-api-reference/variables/HAMMER2_1_3B_QUANTIZED",label:"HAMMER2_1_3B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_1B",label:"LLAMA3_2_1B"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_1B_QLORA",label:"LLAMA3_2_1B_QLORA"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_1B_SPINQUANT",label:"LLAMA3_2_1B_SPINQUANT"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_3B",label:"LLAMA3_2_3B"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_3B_QLORA",label:"LLAMA3_2_3B_QLORA"},{type:"doc",id:"06-api-reference/variables/LLAMA3_2_3B_SPINQUANT",label:"LLAMA3_2_3B_SPINQUANT"},{type:"doc",id:"06-api-reference/variables/PHI_4_MINI_4B",label:"PHI_4_MINI_4B"},{type:"doc",id:"06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED",label:"PHI_4_MINI_4B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_0_5B",label:"QWEN2_5_0_5B"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED",label:"QWEN2_5_0_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_1_5B",label:"QWEN2_5_1_5B"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED",label:"QWEN2_5_1_5B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_3B",label:"QWEN2_5_3B"},{type:"doc",id:"06-api-reference/variables/QWEN2_5_3B_QUANTIZED",label:"QWEN2_5_3B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN3_0_6B",label:"QWEN3_0_6B"},{type:"doc",id:"06-api-reference/variables/QWEN3_0_6B_QUANTIZED",label:"QWEN3_0_6B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN3_1_7B",label:"QWEN3_1_7B"},{type:"doc",id:"06-api-reference/variables/QWEN3_1_7B_QUANTIZED",label:"QWEN3_1_7B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/QWEN3_4B",label:"QWEN3_4B"},{type:"doc",id:"06-api-reference/variables/QWEN3_4B_QUANTIZED",label:"QWEN3_4B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_1_7B",label:"SMOLLM2_1_1_7B"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED",label:"SMOLLM2_1_1_7B_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_135M",label:"SMOLLM2_1_135M"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED",label:"SMOLLM2_1_135M_QUANTIZED"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_360M",label:"SMOLLM2_1_360M"},{type:"doc",id:"06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED",label:"SMOLLM2_1_360M_QUANTIZED"}]},{type:"category",label:"Models - Object Detection",items:[{type:"doc",id:"06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE",label:"SSDLITE_320_MOBILENET_V3_LARGE"}]},{type:"category",label:"Models - Speech To Text",items:[{type:"doc",id:"06-api-reference/variables/WHISPER_BASE",label:"WHISPER_BASE"},{type:"doc",id:"06-api-reference/variables/WHISPER_BASE_EN",label:"WHISPER_BASE_EN"},{type:"doc",id:"06-api-reference/variables/WHISPER_SMALL",label:"WHISPER_SMALL"},{type:"doc",id:"06-api-reference/variables/WHISPER_SMALL_EN",label:"WHISPER_SMALL_EN"},{type:"doc",id:"06-api-reference/variables/WHISPER_TINY",label:"WHISPER_TINY"},{type:"doc",id:"06-api-reference/variables/WHISPER_TINY_EN",label:"WHISPER_TINY_EN"},{type:"doc",id:"06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED",label:"WHISPER_TINY_EN_QUANTIZED"}]},{type:"category",label:"Models - Style Transfer",items:[{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_CANDY",label:"STYLE_TRANSFER_CANDY"},{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_MOSAIC",label:"STYLE_TRANSFER_MOSAIC"},{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS",label:"STYLE_TRANSFER_RAIN_PRINCESS"},{type:"doc",id:"06-api-reference/variables/STYLE_TRANSFER_UDNIE",label:"STYLE_TRANSFER_UDNIE"}]},{type:"category",label:"Models - Text Embeddings",items:[{type:"doc",id:"06-api-reference/variables/ALL_MINILM_L6_V2",label:"ALL_MINILM_L6_V2"},{type:"doc",id:"06-api-reference/variables/ALL_MPNET_BASE_V2",label:"ALL_MPNET_BASE_V2"},{type:"doc",id:"06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT",label:"CLIP_VIT_BASE_PATCH32_TEXT"},{type:"doc",id:"06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1",label:"MULTI_QA_MINILM_L6_COS_V1"},{type:"doc",id:"06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1",label:"MULTI_QA_MPNET_BASE_DOT_V1"}]},{type:"category",label:"Models - Text to Speech",items:[{type:"doc",id:"06-api-reference/variables/KOKORO_MEDIUM",label:"KOKORO_MEDIUM"},{type:"doc",id:"06-api-reference/variables/KOKORO_SMALL",label:"KOKORO_SMALL"}]},{type:"category",label:"Models - Voice Activity Detection",items:[{type:"doc",id:"06-api-reference/variables/FSMN_VAD",label:"FSMN_VAD"}]},{type:"category",label:"OCR Supported Alphabets",items:[{type:"doc",id:"06-api-reference/variables/OCR_ABAZA",label:"OCR_ABAZA"},{type:"doc",id:"06-api-reference/variables/OCR_ADYGHE",label:"OCR_ADYGHE"},{type:"doc",id:"06-api-reference/variables/OCR_AFRIKAANS",label:"OCR_AFRIKAANS"},{type:"doc",id:"06-api-reference/variables/OCR_ALBANIAN",label:"OCR_ALBANIAN"},{type:"doc",id:"06-api-reference/variables/OCR_AVAR",label:"OCR_AVAR"},{type:"doc",id:"06-api-reference/variables/OCR_AZERBAIJANI",label:"OCR_AZERBAIJANI"},{type:"doc",id:"06-api-reference/variables/OCR_BELARUSIAN",label:"OCR_BELARUSIAN"},{type:"doc",id:"06-api-reference/variables/OCR_BOSNIAN",label:"OCR_BOSNIAN"},{type:"doc",id:"06-api-reference/variables/OCR_BULGARIAN",label:"OCR_BULGARIAN"},{type:"doc",id:"06-api-reference/variables/OCR_CHECHEN",label:"OCR_CHECHEN"},{type:"doc",id:"06-api-reference/variables/OCR_CROATIAN",label:"OCR_CROATIAN"},{type:"doc",id:"06-api-reference/variables/OCR_CZECH",label:"OCR_CZECH"},{type:"doc",id:"06-api-reference/variables/OCR_DANISH",label:"OCR_DANISH"},{type:"doc",id:"06-api-reference/variables/OCR_DARGWA",label:"OCR_DARGWA"},{type:"doc",id:"06-api-reference/variables/OCR_DUTCH",label:"OCR_DUTCH"},{type:"doc",id:"06-api-reference/variables/OCR_ENGLISH",label:"OCR_ENGLISH"},{type:"doc",id:"06-api-reference/variables/OCR_ESTONIAN",label:"OCR_ESTONIAN"},{type:"doc",id:"06-api-reference/variables/OCR_FRENCH",label:"OCR_FRENCH"},{type:"doc",id:"06-api-reference/variables/OCR_GERMAN",label:"OCR_GERMAN"},{type:"doc",id:"06-api-reference/variables/OCR_HUNGARIAN",label:"OCR_HUNGARIAN"},{type:"doc",id:"06-api-reference/variables/OCR_ICELANDIC",label:"OCR_ICELANDIC"},{type:"doc",id:"06-api-reference/variables/OCR_INDONESIAN",label:"OCR_INDONESIAN"},{type:"doc",id:"06-api-reference/variables/OCR_INGUSH",label:"OCR_INGUSH"},{type:"doc",id:"06-api-reference/variables/OCR_IRISH",label:"OCR_IRISH"},{type:"doc",id:"06-api-reference/variables/OCR_ITALIAN",label:"OCR_ITALIAN"},{type:"doc",id:"06-api-reference/variables/OCR_JAPANESE",label:"OCR_JAPANESE"},{type:"doc",id:"06-api-reference/variables/OCR_KANNADA",label:"OCR_KANNADA"},{type:"doc",id:"06-api-reference/variables/OCR_KARBADIAN",label:"OCR_KARBADIAN"},{type:"doc",id:"06-api-reference/variables/OCR_KOREAN",label:"OCR_KOREAN"},{type:"doc",id:"06-api-reference/variables/OCR_KURDISH",label:"OCR_KURDISH"},{type:"doc",id:"06-api-reference/variables/OCR_LAK",label:"OCR_LAK"},{type:"doc",id:"06-api-reference/variables/OCR_LATIN",label:"OCR_LATIN"},{type:"doc",id:"06-api-reference/variables/OCR_LATVIAN",label:"OCR_LATVIAN"},{type:"doc",id:"06-api-reference/variables/OCR_LEZGHIAN",label:"OCR_LEZGHIAN"},{type:"doc",id:"06-api-reference/variables/OCR_LITHUANIAN",label:"OCR_LITHUANIAN"},{type:"doc",id:"06-api-reference/variables/OCR_MALAY",label:"OCR_MALAY"},{type:"doc",id:"06-api-reference/variables/OCR_MALTESE",label:"OCR_MALTESE"},{type:"doc",id:"06-api-reference/variables/OCR_MAORI",label:"OCR_MAORI"},{type:"doc",id:"06-api-reference/variables/OCR_MONGOLIAN",label:"OCR_MONGOLIAN"},{type:"doc",id:"06-api-reference/variables/OCR_NORWEGIAN",label:"OCR_NORWEGIAN"},{type:"doc",id:"06-api-reference/variables/OCR_OCCITAN",label:"OCR_OCCITAN"},{type:"doc",id:"06-api-reference/variables/OCR_PALI",label:"OCR_PALI"},{type:"doc",id:"06-api-reference/variables/OCR_POLISH",label:"OCR_POLISH"},{type:"doc",id:"06-api-reference/variables/OCR_PORTUGUESE",label:"OCR_PORTUGUESE"},{type:"doc",id:"06-api-reference/variables/OCR_ROMANIAN",label:"OCR_ROMANIAN"},{type:"doc",id:"06-api-reference/variables/OCR_RUSSIAN",label:"OCR_RUSSIAN"},{type:"doc",id:"06-api-reference/variables/OCR_SERBIAN_CYRILLIC",label:"OCR_SERBIAN_CYRILLIC"},{type:"doc",id:"06-api-reference/variables/OCR_SERBIAN_LATIN",label:"OCR_SERBIAN_LATIN"},{type:"doc",id:"06-api-reference/variables/OCR_SIMPLIFIED_CHINESE",label:"OCR_SIMPLIFIED_CHINESE"},{type:"doc",id:"06-api-reference/variables/OCR_SLOVAK",label:"OCR_SLOVAK"},{type:"doc",id:"06-api-reference/variables/OCR_SLOVENIAN",label:"OCR_SLOVENIAN"},{type:"doc",id:"06-api-reference/variables/OCR_SPANISH",label:"OCR_SPANISH"},{type:"doc",id:"06-api-reference/variables/OCR_SWAHILI",label:"OCR_SWAHILI"},{type:"doc",id:"06-api-reference/variables/OCR_SWEDISH",label:"OCR_SWEDISH"},{type:"doc",id:"06-api-reference/variables/OCR_TABASSARAN",label:"OCR_TABASSARAN"},{type:"doc",id:"06-api-reference/variables/OCR_TAGALOG",label:"OCR_TAGALOG"},{type:"doc",id:"06-api-reference/variables/OCR_TAJIK",label:"OCR_TAJIK"},{type:"doc",id:"06-api-reference/variables/OCR_TELUGU",label:"OCR_TELUGU"},{type:"doc",id:"06-api-reference/variables/OCR_TURKISH",label:"OCR_TURKISH"},{type:"doc",id:"06-api-reference/variables/OCR_UKRAINIAN",label:"OCR_UKRAINIAN"},{type:"doc",id:"06-api-reference/variables/OCR_UZBEK",label:"OCR_UZBEK"},{type:"doc",id:"06-api-reference/variables/OCR_VIETNAMESE",label:"OCR_VIETNAMESE"},{type:"doc",id:"06-api-reference/variables/OCR_WELSH",label:"OCR_WELSH"}]},{type:"category",label:"Other",items:[{type:"doc",id:"06-api-reference/enumerations/RnExecutorchErrorCode",label:"RnExecutorchErrorCode"},{type:"doc",id:"06-api-reference/classes/RnExecutorchError",label:"RnExecutorchError"}]},{type:"category",label:"TTS Supported Voices",items:[{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AF_HEART",label:"KOKORO_VOICE_AF_HEART"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AF_RIVER",label:"KOKORO_VOICE_AF_RIVER"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AF_SARAH",label:"KOKORO_VOICE_AF_SARAH"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AM_ADAM",label:"KOKORO_VOICE_AM_ADAM"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL",label:"KOKORO_VOICE_AM_MICHAEL"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_AM_SANTA",label:"KOKORO_VOICE_AM_SANTA"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_BF_EMMA",label:"KOKORO_VOICE_BF_EMMA"},{type:"doc",id:"06-api-reference/variables/KOKORO_VOICE_BM_DANIEL",label:"KOKORO_VOICE_BM_DANIEL"}]},{type:"category",label:"Types",items:[{type:"doc",id:"06-api-reference/enumerations/CocoLabel",label:"CocoLabel"},{type:"doc",id:"06-api-reference/enumerations/DeeplabLabel",label:"DeeplabLabel"},{type:"doc",id:"06-api-reference/enumerations/ScalarType",label:"ScalarType"},{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/DecodingOptions",label:"DecodingOptions"},{type:"doc",id:"06-api-reference/interfaces/Detection",label:"Detection"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleProps",label:"ExecutorchModuleProps"},{type:"doc",id:"06-api-reference/interfaces/ExecutorchModuleType",label:"ExecutorchModuleType"},{type:"doc",id:"06-api-reference/interfaces/GenerationConfig",label:"GenerationConfig"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsProps",label:"ImageEmbeddingsProps"},{type:"doc",id:"06-api-reference/interfaces/ImageEmbeddingsType",label:"ImageEmbeddingsType"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationProps",label:"ImageSegmentationProps"},{type:"doc",id:"06-api-reference/interfaces/ImageSegmentationType",label:"ImageSegmentationType"},{type:"doc",id:"06-api-reference/interfaces/KokoroConfig",label:"KokoroConfig"},{type:"doc",id:"06-api-reference/interfaces/KokoroVoiceExtras",label:"KokoroVoiceExtras"},{type:"doc",id:"06-api-reference/interfaces/LLMConfig",label:"LLMConfig"},{type:"doc",id:"06-api-reference/interfaces/LLMType",label:"LLMType"},{type:"doc",id:"06-api-reference/interfaces/Message",label:"Message"},{type:"doc",id:"06-api-reference/interfaces/ObjectDetectionProps",label:"ObjectDetectionProps"},{type:"doc",id:"06-api-reference/interfaces/ObjectDetectionType",label:"ObjectDetectionType"},{type:"doc",id:"06-api-reference/interfaces/OCRDetection",label:"OCRDetection"},{type:"doc",id:"06-api-reference/interfaces/OCRProps",label:"OCRProps"},{type:"doc",id:"06-api-reference/interfaces/OCRType",label:"OCRType"},{type:"doc",id:"06-api-reference/interfaces/Point",label:"Point"},{type:"doc",id:"06-api-reference/interfaces/Segment",label:"Segment"},{type:"doc",id:"06-api-reference/interfaces/SpeechToTextModelConfig",label:"SpeechToTextModelConfig"},{type:"doc",id:"06-api-reference/interfaces/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/TextToImageParams",label:"TextToImageParams"},{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/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/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/type-aliases/LLMTool",label:"LLMTool"},{type:"doc",id:"06-api-reference/type-aliases/MessageRole",label:"MessageRole"},{type:"doc",id:"06-api-reference/type-aliases/OCRLanguage",label:"OCRLanguage"},{type:"doc",id:"06-api-reference/type-aliases/ResourceSource",label:"ResourceSource"},{type:"doc",id:"06-api-reference/type-aliases/SpeechToTextLanguage",label:"SpeechToTextLanguage"},{type:"doc",id:"06-api-reference/type-aliases/TensorBuffer",label:"TensorBuffer"},{type:"doc",id:"06-api-reference/type-aliases/TextToSpeechLanguage",label:"TextToSpeechLanguage"},{type:"doc",id:"06-api-reference/variables/SPECIAL_TOKENS",label:"SPECIAL_TOKENS"}]},{type:"category",label:"Typescript API",items:[{type:"doc",id:"06-api-reference/classes/ClassificationModule",label:"ClassificationModule"},{type:"doc",id:"06-api-reference/classes/ExecutorchModule",label:"ExecutorchModule"},{type:"doc",id:"06-api-reference/classes/ImageEmbeddingsModule",label:"ImageEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/ImageSegmentationModule",label:"ImageSegmentationModule"},{type:"doc",id:"06-api-reference/classes/LLMModule",label:"LLMModule"},{type:"doc",id:"06-api-reference/classes/ObjectDetectionModule",label:"ObjectDetectionModule"},{type:"doc",id:"06-api-reference/classes/OCRModule",label:"OCRModule"},{type:"doc",id:"06-api-reference/classes/SpeechToTextModule",label:"SpeechToTextModule"},{type:"doc",id:"06-api-reference/classes/StyleTransferModule",label:"StyleTransferModule"},{type:"doc",id:"06-api-reference/classes/TextEmbeddingsModule",label:"TextEmbeddingsModule"},{type:"doc",id:"06-api-reference/classes/TextToImageModule",label:"TextToImageModule"},{type:"doc",id:"06-api-reference/classes/TextToSpeechModule",label:"TextToSpeechModule"},{type:"doc",id:"06-api-reference/classes/TokenizerModule",label:"TokenizerModule"},{type:"doc",id:"06-api-reference/classes/VADModule",label:"VADModule"},{type:"doc",id:"06-api-reference/classes/VerticalOCRModule",label:"VerticalOCRModule"}]},{type:"category",label:"Utilities - General",items:[{type:"doc",id:"06-api-reference/classes/ResourceFetcher",label:"ResourceFetcher"}]},{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_WINDOW_LENGTH",label:"DEFAULT_CONTEXT_WINDOW_LENGTH"},{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"}]}]}; 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 fd4d948ff..85ce14edf 100644 --- a/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MINILM_L6_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MINILM\_L6\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L408) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:552](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L552) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md index a38fd98ee..21bc79c07 100644 --- a/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md +++ b/docs/docs/06-api-reference/variables/ALL_MPNET_BASE_V2.md @@ -2,7 +2,7 @@ > `const` **ALL\_MPNET\_BASE\_V2**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:413](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L413) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:560](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L560) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md index a540f837a..4cf6d3afd 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_256.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_256**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:442](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L442) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:605](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L605) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md index 3fbe99b47..5ee071adf 100644 --- a/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md +++ b/docs/docs/06-api-reference/variables/BK_SDM_TINY_VPRED_512.md @@ -2,7 +2,7 @@ > `const` **BK\_SDM\_TINY\_VPRED\_512**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:434](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L434) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:594](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L594) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md index e5395268f..f627f132c 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_IMAGE.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_IMAGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:392](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:533](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L533) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md index 4ccd8ba8d..3b46fb93d 100644 --- a/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md +++ b/docs/docs/06-api-reference/variables/CLIP_VIT_BASE_PATCH32_TEXT.md @@ -2,7 +2,7 @@ > `const` **CLIP\_VIT\_BASE\_PATCH32\_TEXT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:428](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L428) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:584](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L584) ## 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 95203dff7..f01fb5330 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: [packages/react-native-executorch/src/constants/modelUrls.ts:385](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L385) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:523](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L523) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md index ac003b529..e71049eda 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CHAT_CONFIG.md @@ -2,6 +2,6 @@ > `const` **DEFAULT\_CHAT\_CONFIG**: [`ChatConfig`](../interfaces/ChatConfig.md) -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:39](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/llmDefaults.ts#L39) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:48](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/llmDefaults.ts#L48) Default chat configuration for Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md index 55e38ab11..3080a3038 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_CONTEXT_WINDOW_LENGTH.md @@ -2,6 +2,6 @@ > `const` **DEFAULT\_CONTEXT\_WINDOW\_LENGTH**: `5` = `5` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/llmDefaults.ts#L34) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:41](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/llmDefaults.ts#L41) Default context window length for Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md index 5f446a4dc..7ae8b707b 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_MESSAGE_HISTORY.md @@ -2,6 +2,6 @@ > `const` **DEFAULT\_MESSAGE\_HISTORY**: [`Message`](../interfaces/Message.md)[] = `[]` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:29](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/llmDefaults.ts#L29) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:34](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/llmDefaults.ts#L34) Default message history for Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md index c5b7146cc..edbae658c 100644 --- a/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md +++ b/docs/docs/06-api-reference/variables/DEFAULT_SYSTEM_PROMPT.md @@ -2,6 +2,6 @@ > `const` **DEFAULT\_SYSTEM\_PROMPT**: `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` = `"You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."` -Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:6](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/llmDefaults.ts#L6) +Defined in: [packages/react-native-executorch/src/constants/llmDefaults.ts:8](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/llmDefaults.ts#L8) Default system prompt used to guide the behavior of Large Language Models (LLMs). diff --git a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md index fb28e25a8..6e8d51010 100644 --- a/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md +++ b/docs/docs/06-api-reference/variables/EFFICIENTNET_V2_S.md @@ -2,7 +2,7 @@ > `const` **EFFICIENTNET\_V2\_S**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:260](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:359](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L359) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/FSMN_VAD.md b/docs/docs/06-api-reference/variables/FSMN_VAD.md index 976ddbc92..507fedb81 100644 --- a/docs/docs/06-api-reference/variables/FSMN_VAD.md +++ b/docs/docs/06-api-reference/variables/FSMN_VAD.md @@ -2,7 +2,7 @@ > `const` **FSMN\_VAD**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:453](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L453) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:619](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L619) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md index 7fa4e1e99..c28604f04 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:108](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L108) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:147](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L147) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md index 5856bcae8..03bf664d0 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:114](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L114) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:156](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L156) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md index 341da2021..f04c373fa 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:120](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L120) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:165](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L165) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md index 75e8d9d86..8b8430bf0 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:126](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L126) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:174](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L174) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md index afebcc246..0b235f727 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:132](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L132) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:183](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L183) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md index 1c236d14d..aa4f582e1 100644 --- a/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/HAMMER2_1_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **HAMMER2\_1\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:138](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L138) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:192](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L192) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md index ba7bca64d..fe843b5e6 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_MEDIUM.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_MEDIUM**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/models.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:26](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/tts/models.ts#L26) A standard Kokoro instance which processes the text in batches of maximum 128 tokens. diff --git a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md index f0d86b795..9faf91a0e 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_SMALL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_SMALL.md @@ -2,7 +2,7 @@ > `const` **KOKORO\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:13](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/models.ts#L13) +Defined in: [packages/react-native-executorch/src/constants/tts/models.ts:15](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/tts/models.ts#L15) A Kokoro model instance which processes the text in batches of maximum 64 tokens. Uses significant less memory than the medium model, but could produce diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md index c08419a1a..b8e36a25a 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_HEART.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_HEART**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:21](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L21) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:24](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/tts/voices.ts#L24) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md index 1049c5b99..1cc221277 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_RIVER.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_RIVER**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:26](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L26) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:32](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/tts/voices.ts#L32) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md index 637e91f63..7ed697938 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AF_SARAH.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AF\_SARAH**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:31](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L31) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:40](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/tts/voices.ts#L40) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md index 05dd07676..9feefd30a 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_ADAM.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_ADAM**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:36](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L36) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:48](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/tts/voices.ts#L48) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md index 4f41025ef..54aaebbcd 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_MICHAEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_MICHAEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/tts/voices.ts#L56) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md index 2a36ef9da..de300d465 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_AM_SANTA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_AM\_SANTA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:64](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/tts/voices.ts#L64) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md index 3b07350b7..eaae01cb7 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BF_EMMA.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BF\_EMMA**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:51](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L51) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:72](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/tts/voices.ts#L72) diff --git a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md index d9b46f884..2909af172 100644 --- a/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md +++ b/docs/docs/06-api-reference/variables/KOKORO_VOICE_BM_DANIEL.md @@ -2,4 +2,4 @@ > `const` **KOKORO\_VOICE\_BM\_DANIEL**: [`VoiceConfig`](../interfaces/VoiceConfig.md) -Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:56](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/tts/voices.ts#L56) +Defined in: [packages/react-native-executorch/src/constants/tts/voices.ts:80](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/tts/voices.ts#L80) diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md index 0c05386ab..68902e24f 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L34) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L46) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md index d773c37c8..1f9554914 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L40) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:55](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L55) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md index afc0f99ef..b30fc331d 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_1B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_1B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:46](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L46) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:64](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L64) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md index 46a2ee7e4..322ffbdd8 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L16) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:19](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L19) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md index ffa7ccf2d..678aba5b0 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_QLORA.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_QLORA**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:22](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L22) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L28) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md index 1100cf692..87cfcb1af 100644 --- a/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md +++ b/docs/docs/06-api-reference/variables/LLAMA3_2_3B_SPINQUANT.md @@ -2,7 +2,7 @@ > `const` **LLAMA3\_2\_3B\_SPINQUANT**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:28](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L28) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:37](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L37) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md index a38328a4d..f976b3537 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MINILM_L6_COS_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MINILM\_L6\_COS\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:418](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L418) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:568](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L568) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md index eea1b0a05..a6350e0b0 100644 --- a/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md +++ b/docs/docs/06-api-reference/variables/MULTI_QA_MPNET_BASE_DOT_V1.md @@ -2,7 +2,7 @@ > `const` **MULTI\_QA\_MPNET\_BASE\_DOT\_V1**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:423](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L423) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:576](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L576) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ABAZA.md b/docs/docs/06-api-reference/variables/OCR_ABAZA.md index 3fa222c27..3920b527b 100644 --- a/docs/docs/06-api-reference/variables/OCR_ABAZA.md +++ b/docs/docs/06-api-reference/variables/OCR_ABAZA.md @@ -2,7 +2,7 @@ > `const` **OCR\_ABAZA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L41) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:33](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L33) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md index 3917f772f..d4f2d526e 100644 --- a/docs/docs/06-api-reference/variables/OCR_ADYGHE.md +++ b/docs/docs/06-api-reference/variables/OCR_ADYGHE.md @@ -2,7 +2,7 @@ > `const` **OCR\_ADYGHE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:47](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L47) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:38](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L38) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md index d4ecd585e..3a352990e 100644 --- a/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md +++ b/docs/docs/06-api-reference/variables/OCR_AFRIKAANS.md @@ -2,7 +2,7 @@ > `const` **OCR\_AFRIKAANS**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L53) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:43](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L43) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md index f427287cb..08a61b6f8 100644 --- a/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ALBANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ALBANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:362](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L362) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AVAR.md b/docs/docs/06-api-reference/variables/OCR_AVAR.md index cb107db78..fc01c7320 100644 --- a/docs/docs/06-api-reference/variables/OCR_AVAR.md +++ b/docs/docs/06-api-reference/variables/OCR_AVAR.md @@ -2,7 +2,7 @@ > `const` **OCR\_AVAR**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:59](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L59) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L48) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md index 1b8ba2454..41cb74954 100644 --- a/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md +++ b/docs/docs/06-api-reference/variables/OCR_AZERBAIJANI.md @@ -2,7 +2,7 @@ > `const` **OCR\_AZERBAIJANI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:65](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L65) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:53](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L53) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md index 6d98938f4..3c7e7cc8e 100644 --- a/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BELARUSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BELARUSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:71](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L71) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:58](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L58) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md index 1fcec9b2b..126a7081f 100644 --- a/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BOSNIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BOSNIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:83](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L83) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:68](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L68) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md index 05a81f84b..870862585 100644 --- a/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_BULGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_BULGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:77](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L77) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:63](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L63) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md index 3f9805175..c1ceb2a26 100644 --- a/docs/docs/06-api-reference/variables/OCR_CHECHEN.md +++ b/docs/docs/06-api-reference/variables/OCR_CHECHEN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CHECHEN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:98](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L98) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:81](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L81) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md index e5aa2f626..161af3a89 100644 --- a/docs/docs/06-api-reference/variables/OCR_CROATIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_CROATIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_CROATIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:164](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L164) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:136](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L136) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_CZECH.md b/docs/docs/06-api-reference/variables/OCR_CZECH.md index 54508ffeb..b0b26eed6 100644 --- a/docs/docs/06-api-reference/variables/OCR_CZECH.md +++ b/docs/docs/06-api-reference/variables/OCR_CZECH.md @@ -2,7 +2,7 @@ > `const` **OCR\_CZECH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:104](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L104) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:86](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L86) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DANISH.md b/docs/docs/06-api-reference/variables/OCR_DANISH.md index f43f7f4fa..6a017b53c 100644 --- a/docs/docs/06-api-reference/variables/OCR_DANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_DANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L116) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:96](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L96) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DARGWA.md b/docs/docs/06-api-reference/variables/OCR_DARGWA.md index b582f6806..c52a3dc97 100644 --- a/docs/docs/06-api-reference/variables/OCR_DARGWA.md +++ b/docs/docs/06-api-reference/variables/OCR_DARGWA.md @@ -2,7 +2,7 @@ > `const` **OCR\_DARGWA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:122](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L122) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:101](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L101) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_DUTCH.md b/docs/docs/06-api-reference/variables/OCR_DUTCH.md index 5b6bdea46..8e704f15e 100644 --- a/docs/docs/06-api-reference/variables/OCR_DUTCH.md +++ b/docs/docs/06-api-reference/variables/OCR_DUTCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_DUTCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L284) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L236) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md index 9349837fa..ab0872da6 100644 --- a/docs/docs/06-api-reference/variables/OCR_ENGLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_ENGLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_ENGLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:134](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L134) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L111) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md index 00d73109b..dc6c62e01 100644 --- a/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ESTONIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ESTONIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L146) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:121](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L121) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_FRENCH.md b/docs/docs/06-api-reference/variables/OCR_FRENCH.md index 6be6d33cd..ebaecce35 100644 --- a/docs/docs/06-api-reference/variables/OCR_FRENCH.md +++ b/docs/docs/06-api-reference/variables/OCR_FRENCH.md @@ -2,7 +2,7 @@ > `const` **OCR\_FRENCH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:152](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L152) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:126](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L126) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_GERMAN.md b/docs/docs/06-api-reference/variables/OCR_GERMAN.md index 6a66fe18e..c77b5c781 100644 --- a/docs/docs/06-api-reference/variables/OCR_GERMAN.md +++ b/docs/docs/06-api-reference/variables/OCR_GERMAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_GERMAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:128](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L128) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:106](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L106) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md index 865dcc4bc..711466db8 100644 --- a/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_HUNGARIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_HUNGARIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:170](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L170) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L141) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md index f0ab55d80..e4f936846 100644 --- a/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md +++ b/docs/docs/06-api-reference/variables/OCR_ICELANDIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_ICELANDIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:188](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L188) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:156](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L156) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md index c9b8363ca..f0c45e7b6 100644 --- a/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_INDONESIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_INDONESIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L176) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:146](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L146) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_INGUSH.md b/docs/docs/06-api-reference/variables/OCR_INGUSH.md index a7e602db8..d5e2e36a2 100644 --- a/docs/docs/06-api-reference/variables/OCR_INGUSH.md +++ b/docs/docs/06-api-reference/variables/OCR_INGUSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_INGUSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:182](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L182) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:151](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L151) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_IRISH.md b/docs/docs/06-api-reference/variables/OCR_IRISH.md index c75328247..5825035c0 100644 --- a/docs/docs/06-api-reference/variables/OCR_IRISH.md +++ b/docs/docs/06-api-reference/variables/OCR_IRISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_IRISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:158](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L158) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:131](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L131) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md index e2548b127..137f73f2d 100644 --- a/docs/docs/06-api-reference/variables/OCR_ITALIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ITALIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ITALIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:194](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L194) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:161](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L161) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md index 6e53d9b5b..b77fa7990 100644 --- a/docs/docs/06-api-reference/variables/OCR_JAPANESE.md +++ b/docs/docs/06-api-reference/variables/OCR_JAPANESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_JAPANESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:200](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:166](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L166) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KANNADA.md b/docs/docs/06-api-reference/variables/OCR_KANNADA.md index 498f40e7f..adb081a64 100644 --- a/docs/docs/06-api-reference/variables/OCR_KANNADA.md +++ b/docs/docs/06-api-reference/variables/OCR_KANNADA.md @@ -2,7 +2,7 @@ > `const` **OCR\_KANNADA**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:212](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:176](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L176) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md index 798387db1..68209b001 100644 --- a/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KARBADIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KARBADIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L171) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KOREAN.md b/docs/docs/06-api-reference/variables/OCR_KOREAN.md index 63ee199e8..90f5c5787 100644 --- a/docs/docs/06-api-reference/variables/OCR_KOREAN.md +++ b/docs/docs/06-api-reference/variables/OCR_KOREAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_KOREAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:218](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:181](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L181) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_KURDISH.md b/docs/docs/06-api-reference/variables/OCR_KURDISH.md index 4fa0a63b1..489e1391c 100644 --- a/docs/docs/06-api-reference/variables/OCR_KURDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_KURDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_KURDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:224](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:186](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L186) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LAK.md b/docs/docs/06-api-reference/variables/OCR_LAK.md index 98dab6e3f..aaabfc554 100644 --- a/docs/docs/06-api-reference/variables/OCR_LAK.md +++ b/docs/docs/06-api-reference/variables/OCR_LAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_LAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:236](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L236) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:196](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L196) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATIN.md b/docs/docs/06-api-reference/variables/OCR_LATIN.md index 2e118ef0e..37b28df89 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:230](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:191](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L191) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md index 7867b633f..266fedfd2 100644 --- a/docs/docs/06-api-reference/variables/OCR_LATVIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LATVIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LATVIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:254](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L254) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:211](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L211) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md index 5db1a8807..52f198ea7 100644 --- a/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LEZGHIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LEZGHIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:242](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L201) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md index 0cf16635f..9f8a50e8f 100644 --- a/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_LITHUANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_LITHUANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:248](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:206](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L206) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALAY.md b/docs/docs/06-api-reference/variables/OCR_MALAY.md index 904f38f0a..333e97aca 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALAY.md +++ b/docs/docs/06-api-reference/variables/OCR_MALAY.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALAY**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:272](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L272) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:226](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L226) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MALTESE.md b/docs/docs/06-api-reference/variables/OCR_MALTESE.md index 8c5e0f83f..8ef32c06e 100644 --- a/docs/docs/06-api-reference/variables/OCR_MALTESE.md +++ b/docs/docs/06-api-reference/variables/OCR_MALTESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_MALTESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:278](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L278) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L231) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MAORI.md b/docs/docs/06-api-reference/variables/OCR_MAORI.md index 5d86d6d77..bca451487 100644 --- a/docs/docs/06-api-reference/variables/OCR_MAORI.md +++ b/docs/docs/06-api-reference/variables/OCR_MAORI.md @@ -2,7 +2,7 @@ > `const` **OCR\_MAORI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:260](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L260) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:216](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L216) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md index b1117e0d8..340cad002 100644 --- a/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_MONGOLIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_MONGOLIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L266) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:221](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L221) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md index 3c1d47f12..ac3155821 100644 --- a/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_NORWEGIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_NORWEGIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:290](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L290) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:241](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L241) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md index e951048fa..2e7b7c4bc 100644 --- a/docs/docs/06-api-reference/variables/OCR_OCCITAN.md +++ b/docs/docs/06-api-reference/variables/OCR_OCCITAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_OCCITAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:296](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L296) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:246](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L246) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PALI.md b/docs/docs/06-api-reference/variables/OCR_PALI.md index c68e62311..c2b18f5d0 100644 --- a/docs/docs/06-api-reference/variables/OCR_PALI.md +++ b/docs/docs/06-api-reference/variables/OCR_PALI.md @@ -2,7 +2,7 @@ > `const` **OCR\_PALI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:302](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L302) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:251](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L251) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_POLISH.md b/docs/docs/06-api-reference/variables/OCR_POLISH.md index c79e59eee..6e4fa47d0 100644 --- a/docs/docs/06-api-reference/variables/OCR_POLISH.md +++ b/docs/docs/06-api-reference/variables/OCR_POLISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_POLISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:308](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L308) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:256](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L256) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md index c4994fa35..71440218c 100644 --- a/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md +++ b/docs/docs/06-api-reference/variables/OCR_PORTUGUESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_PORTUGUESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:314](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L314) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L261) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md index 1e973e9b1..4c3a8e515 100644 --- a/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_ROMANIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_ROMANIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:320](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L320) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:266](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L266) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md index 58ef3c335..f5a3805ae 100644 --- a/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_RUSSIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_RUSSIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:326](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L326) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:271](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L271) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md index fa0d99a88..3a319679a 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_CYRILLIC.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_CYRILLIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L332) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:276](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L276) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md index 75fc2d552..ab9f0adf4 100644 --- a/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md +++ b/docs/docs/06-api-reference/variables/OCR_SERBIAN_LATIN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SERBIAN\_LATIN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:341](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L341) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:284](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md index 996d11b08..d4eadbfb1 100644 --- a/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md +++ b/docs/docs/06-api-reference/variables/OCR_SIMPLIFIED_CHINESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_SIMPLIFIED\_CHINESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:89](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L89) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:73](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L73) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md index 308af7fe3..a0abb585e 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVAK.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVAK.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVAK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:350](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L350) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:292](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L292) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md index c9f9b5cbb..d30c09bb2 100644 --- a/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_SLOVENIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_SLOVENIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:356](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L356) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L297) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SPANISH.md b/docs/docs/06-api-reference/variables/OCR_SPANISH.md index 49f059185..ae9904c16 100644 --- a/docs/docs/06-api-reference/variables/OCR_SPANISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SPANISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SPANISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:140](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L140) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:116](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L116) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md index cef9353fb..2f0c328ea 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWAHILI.md +++ b/docs/docs/06-api-reference/variables/OCR_SWAHILI.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWAHILI**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:374](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L374) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:312](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L312) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md index a6e2740bd..4dcfcd3be 100644 --- a/docs/docs/06-api-reference/variables/OCR_SWEDISH.md +++ b/docs/docs/06-api-reference/variables/OCR_SWEDISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_SWEDISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:368](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:307](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L307) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md index 1e652f408..be4d58d9b 100644 --- a/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md +++ b/docs/docs/06-api-reference/variables/OCR_TABASSARAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_TABASSARAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:380](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L380) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:317](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L317) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md index bf47c6c9d..4b68230a8 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAGALOG.md +++ b/docs/docs/06-api-reference/variables/OCR_TAGALOG.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAGALOG**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:398](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L398) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:332](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L332) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TAJIK.md b/docs/docs/06-api-reference/variables/OCR_TAJIK.md index 1d51dce04..eaf199a36 100644 --- a/docs/docs/06-api-reference/variables/OCR_TAJIK.md +++ b/docs/docs/06-api-reference/variables/OCR_TAJIK.md @@ -2,7 +2,7 @@ > `const` **OCR\_TAJIK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:392](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L392) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L327) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TELUGU.md b/docs/docs/06-api-reference/variables/OCR_TELUGU.md index 0beffca9c..0abc89032 100644 --- a/docs/docs/06-api-reference/variables/OCR_TELUGU.md +++ b/docs/docs/06-api-reference/variables/OCR_TELUGU.md @@ -2,7 +2,7 @@ > `const` **OCR\_TELUGU**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:386](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L386) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:322](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L322) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_TURKISH.md b/docs/docs/06-api-reference/variables/OCR_TURKISH.md index 0aff0adeb..76532ab43 100644 --- a/docs/docs/06-api-reference/variables/OCR_TURKISH.md +++ b/docs/docs/06-api-reference/variables/OCR_TURKISH.md @@ -2,7 +2,7 @@ > `const` **OCR\_TURKISH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:404](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L404) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:337](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L337) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md index 878bf4fab..d4ad3458f 100644 --- a/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md +++ b/docs/docs/06-api-reference/variables/OCR_UKRAINIAN.md @@ -2,7 +2,7 @@ > `const` **OCR\_UKRAINIAN**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:410](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L410) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:342](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L342) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_UZBEK.md b/docs/docs/06-api-reference/variables/OCR_UZBEK.md index b809c5471..26d5ba3d6 100644 --- a/docs/docs/06-api-reference/variables/OCR_UZBEK.md +++ b/docs/docs/06-api-reference/variables/OCR_UZBEK.md @@ -2,7 +2,7 @@ > `const` **OCR\_UZBEK**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:416](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L416) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:347](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L347) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md index 4871ae830..dfc4facdf 100644 --- a/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md +++ b/docs/docs/06-api-reference/variables/OCR_VIETNAMESE.md @@ -2,7 +2,7 @@ > `const` **OCR\_VIETNAMESE**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:422](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L422) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:352](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L352) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/OCR_WELSH.md b/docs/docs/06-api-reference/variables/OCR_WELSH.md index 1f4fd9c4c..cdd06205c 100644 --- a/docs/docs/06-api-reference/variables/OCR_WELSH.md +++ b/docs/docs/06-api-reference/variables/OCR_WELSH.md @@ -2,7 +2,7 @@ > `const` **OCR\_WELSH**: `object` -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:110](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L110) +Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:91](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/ocr/models.ts#L91) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md index f6e2c47a1..9c50555c9 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:242](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L242) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:335](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L335) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md index 603b8c4c2..0e1e32c35 100644 --- a/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/PHI_4_MINI_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **PHI\_4\_MINI\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:248](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L248) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:344](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L344) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md index 868dd9ce1..759a546e1 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:200](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L200) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:275](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L275) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md index 24aaa8cf4..418375a66 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_0_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_0\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:206](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L206) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:284](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L284) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md index 94474ab2a..9cfac1d53 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:212](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L212) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L293) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md index cc468b6f6..7864600d1 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_1_5B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_1\_5B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:218](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L218) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:302](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L302) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md index 53702b1a6..31c4b5185 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:224](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L224) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:311](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L311) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md index 4a7146912..7f7fbbd72 100644 --- a/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN2_5_3B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN2\_5\_3B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:230](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L230) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:320](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L320) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md index dbe417ced..022414ea8 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:62](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L62) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:83](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L83) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md index 6d6247340..779a315fb 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_0_6B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_0\_6B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:68](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L68) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L92) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md index 3c8540f41..0c1da2447 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:74](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L74) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:101](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L101) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md index 96f4d77bd..4d4109344 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:80](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L80) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:110](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L110) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B.md b/docs/docs/06-api-reference/variables/QWEN3_4B.md index 78658b9dd..e7bbbabfa 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:86](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L86) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:119](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L119) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md index 4ff16e34c..fe01cb239 100644 --- a/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/QWEN3_4B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **QWEN3\_4B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:92](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L92) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:128](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L128) ## 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 5edad9990..01fe69c24 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:154](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L154) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:211](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L211) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md index 704c03b61..a02728085 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_135M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_135M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:160](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L160) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:220](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L220) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md index d2900cd1d..428d9315f 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:178](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L178) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:247](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L247) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md index a3d5c3d9a..4e37b41a6 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_1_7B_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_1\_7B\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:184](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L184) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:256](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L256) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md index 12485aba7..6d04af1c3 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:166](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L166) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:229](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L229) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md index b2d545d13..1e9d5950c 100644 --- a/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/SMOLLM2_1_360M_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **SMOLLM2\_1\_360M\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:172](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L172) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:238](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L238) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md index 4635b1cac..ea5129ddf 100644 --- a/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md +++ b/docs/docs/06-api-reference/variables/SPECIAL_TOKENS.md @@ -2,7 +2,9 @@ > `const` **SPECIAL\_TOKENS**: `object` -Defined in: [packages/react-native-executorch/src/types/llm.ts:205](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/types/llm.ts#L205) +Defined in: [packages/react-native-executorch/src/types/llm.ts:223](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/types/llm.ts#L223) + +Special tokens used in Large Language Models (LLMs). ## Type Declaration 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 49b32b6ee..0f84d9ae7 100644 --- a/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md +++ b/docs/docs/06-api-reference/variables/SSDLITE_320_MOBILENET_V3_LARGE.md @@ -2,7 +2,7 @@ > `const` **SSDLITE\_320\_MOBILENET\_V3\_LARGE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:267](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L267) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:369](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L369) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md index 9f431fcfd..05991dc23 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_CANDY.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_CANDY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:289](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L289) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:394](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L394) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md index 855997348..f10b04950 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_MOSAIC.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_MOSAIC**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:293](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L293) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:401](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L401) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md index 53792959b..b8449b311 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_RAIN_PRINCESS.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_RAIN\_PRINCESS**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:297](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L297) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:408](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L408) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md index 5be727258..ae3d3cee3 100644 --- a/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md +++ b/docs/docs/06-api-reference/variables/STYLE_TRANSFER_UDNIE.md @@ -2,7 +2,7 @@ > `const` **STYLE\_TRANSFER\_UDNIE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:301](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L301) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:415](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L415) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md deleted file mode 100644 index 59b040ac0..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ABAZA.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_ABAZA - -> `const` **VERTICAL\_OCR\_ABAZA**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:42](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L42) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md deleted file mode 100644 index 2dd637a63..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ADYGHE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_ADYGHE - -> `const` **VERTICAL\_OCR\_ADYGHE**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:48](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L48) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md deleted file mode 100644 index 7b0627a7f..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AFRIKAANS.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_AFRIKAANS - -> `const` **VERTICAL\_OCR\_AFRIKAANS**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:54](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L54) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md deleted file mode 100644 index 1c0a1ec46..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ALBANIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_ALBANIAN - -> `const` **VERTICAL\_OCR\_ALBANIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:363](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L363) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md deleted file mode 100644 index c7b36a7de..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AVAR.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_AVAR - -> `const` **VERTICAL\_OCR\_AVAR**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:60](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L60) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md deleted file mode 100644 index 8a932fa0b..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_AZERBAIJANI.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_AZERBAIJANI - -> `const` **VERTICAL\_OCR\_AZERBAIJANI**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:66](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L66) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md deleted file mode 100644 index 4658b6f46..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BELARUSIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_BELARUSIAN - -> `const` **VERTICAL\_OCR\_BELARUSIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:72](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L72) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md deleted file mode 100644 index eba795a8a..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BOSNIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_BOSNIAN - -> `const` **VERTICAL\_OCR\_BOSNIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:84](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L84) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md deleted file mode 100644 index b16107a25..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_BULGARIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_BULGARIAN - -> `const` **VERTICAL\_OCR\_BULGARIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:78](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L78) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md deleted file mode 100644 index 1dba4a134..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CHECHEN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_CHECHEN - -> `const` **VERTICAL\_OCR\_CHECHEN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:99](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L99) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md deleted file mode 100644 index 61a26bf7b..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CROATIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_CROATIAN - -> `const` **VERTICAL\_OCR\_CROATIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:165](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L165) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md deleted file mode 100644 index b577ea666..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_CZECH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_CZECH - -> `const` **VERTICAL\_OCR\_CZECH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:105](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L105) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md deleted file mode 100644 index 249b24a6d..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DANISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_DANISH - -> `const` **VERTICAL\_OCR\_DANISH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:117](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L117) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md deleted file mode 100644 index a8f271179..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DARGWA.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_DARGWA - -> `const` **VERTICAL\_OCR\_DARGWA**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:123](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L123) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md deleted file mode 100644 index cd4c8d921..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_DUTCH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_DUTCH - -> `const` **VERTICAL\_OCR\_DUTCH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:285](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L285) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md deleted file mode 100644 index b98287d08..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ENGLISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_ENGLISH - -> `const` **VERTICAL\_OCR\_ENGLISH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:135](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L135) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md deleted file mode 100644 index be008b59b..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ESTONIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_ESTONIAN - -> `const` **VERTICAL\_OCR\_ESTONIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:147](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L147) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md deleted file mode 100644 index f87a20193..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_FRENCH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_FRENCH - -> `const` **VERTICAL\_OCR\_FRENCH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:153](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L153) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md deleted file mode 100644 index c3697458d..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_GERMAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_GERMAN - -> `const` **VERTICAL\_OCR\_GERMAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:129](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L129) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md deleted file mode 100644 index a142a2932..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_HUNGARIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_HUNGARIAN - -> `const` **VERTICAL\_OCR\_HUNGARIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:171](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L171) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md deleted file mode 100644 index cd747da33..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ICELANDIC.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_ICELANDIC - -> `const` **VERTICAL\_OCR\_ICELANDIC**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:189](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L189) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md deleted file mode 100644 index 448f9df04..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INDONESIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_INDONESIAN - -> `const` **VERTICAL\_OCR\_INDONESIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:177](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L177) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md deleted file mode 100644 index 6adf0f724..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_INGUSH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_INGUSH - -> `const` **VERTICAL\_OCR\_INGUSH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:183](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L183) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md deleted file mode 100644 index 3c7b9f863..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_IRISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_IRISH - -> `const` **VERTICAL\_OCR\_IRISH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:159](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L159) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md deleted file mode 100644 index 87cd99a22..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ITALIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_ITALIAN - -> `const` **VERTICAL\_OCR\_ITALIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:195](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L195) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md deleted file mode 100644 index de58c5588..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_JAPANESE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_JAPANESE - -> `const` **VERTICAL\_OCR\_JAPANESE**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:201](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L201) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md deleted file mode 100644 index af7bb2ca7..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KANNADA.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_KANNADA - -> `const` **VERTICAL\_OCR\_KANNADA**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:213](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L213) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md deleted file mode 100644 index dc580d62e..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KARBADIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_KARBADIAN - -> `const` **VERTICAL\_OCR\_KARBADIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:207](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L207) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md deleted file mode 100644 index 01c731cce..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KOREAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_KOREAN - -> `const` **VERTICAL\_OCR\_KOREAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:219](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L219) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md deleted file mode 100644 index 4ba4dc669..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_KURDISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_KURDISH - -> `const` **VERTICAL\_OCR\_KURDISH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:225](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L225) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md deleted file mode 100644 index 59749c45b..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LAK.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_LAK - -> `const` **VERTICAL\_OCR\_LAK**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:237](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L237) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md deleted file mode 100644 index c09ec141d..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATIN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_LATIN - -> `const` **VERTICAL\_OCR\_LATIN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:231](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L231) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md deleted file mode 100644 index 8ed6339c7..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LATVIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_LATVIAN - -> `const` **VERTICAL\_OCR\_LATVIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:255](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L255) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md deleted file mode 100644 index 027cc06aa..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LEZGHIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_LEZGHIAN - -> `const` **VERTICAL\_OCR\_LEZGHIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:243](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L243) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md deleted file mode 100644 index aa916c56d..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_LITHUANIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_LITHUANIAN - -> `const` **VERTICAL\_OCR\_LITHUANIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:249](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L249) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md deleted file mode 100644 index 52b0b0119..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALAY.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_MALAY - -> `const` **VERTICAL\_OCR\_MALAY**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:273](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L273) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md deleted file mode 100644 index ad9578731..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MALTESE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_MALTESE - -> `const` **VERTICAL\_OCR\_MALTESE**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:279](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L279) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md deleted file mode 100644 index 1079a7529..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MAORI.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_MAORI - -> `const` **VERTICAL\_OCR\_MAORI**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:261](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L261) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md deleted file mode 100644 index 2465a328b..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_MONGOLIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_MONGOLIAN - -> `const` **VERTICAL\_OCR\_MONGOLIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:267](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L267) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md deleted file mode 100644 index 09d8a49bd..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_NORWEGIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_NORWEGIAN - -> `const` **VERTICAL\_OCR\_NORWEGIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:291](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L291) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md deleted file mode 100644 index 287b7823d..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_OCCITAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_OCCITAN - -> `const` **VERTICAL\_OCR\_OCCITAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:297](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L297) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md deleted file mode 100644 index 5767b25d4..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PALI.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_PALI - -> `const` **VERTICAL\_OCR\_PALI**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:303](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L303) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md deleted file mode 100644 index 2835d5d47..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_POLISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_POLISH - -> `const` **VERTICAL\_OCR\_POLISH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:309](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L309) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md deleted file mode 100644 index 6b7f0fcbf..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_PORTUGUESE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_PORTUGUESE - -> `const` **VERTICAL\_OCR\_PORTUGUESE**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:315](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L315) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md deleted file mode 100644 index 75b72f7f8..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_ROMANIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_ROMANIAN - -> `const` **VERTICAL\_OCR\_ROMANIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:321](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L321) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md deleted file mode 100644 index ebb0febfc..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_RUSSIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_RUSSIAN - -> `const` **VERTICAL\_OCR\_RUSSIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:327](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L327) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md deleted file mode 100644 index 92f104c26..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_CYRILLIC.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_SERBIAN\_CYRILLIC - -> `const` **VERTICAL\_OCR\_SERBIAN\_CYRILLIC**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:336](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L336) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md deleted file mode 100644 index 50482bdf8..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SERBIAN_LATIN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_SERBIAN\_LATIN - -> `const` **VERTICAL\_OCR\_SERBIAN\_LATIN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:345](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L345) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md deleted file mode 100644 index f1599ebe6..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SIMPLIFIED_CHINESE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_SIMPLIFIED\_CHINESE - -> `const` **VERTICAL\_OCR\_SIMPLIFIED\_CHINESE**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:93](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L93) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md deleted file mode 100644 index 428fe61a4..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVAK.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_SLOVAK - -> `const` **VERTICAL\_OCR\_SLOVAK**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:351](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L351) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md deleted file mode 100644 index 020ff3437..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SLOVENIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_SLOVENIAN - -> `const` **VERTICAL\_OCR\_SLOVENIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:357](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L357) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md deleted file mode 100644 index a94ba6434..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SPANISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_SPANISH - -> `const` **VERTICAL\_OCR\_SPANISH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:141](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L141) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md deleted file mode 100644 index 8e7b14dcf..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWAHILI.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_SWAHILI - -> `const` **VERTICAL\_OCR\_SWAHILI**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:375](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L375) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md deleted file mode 100644 index 3c977a235..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_SWEDISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_SWEDISH - -> `const` **VERTICAL\_OCR\_SWEDISH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:369](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L369) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md deleted file mode 100644 index b410bc688..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TABASSARAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_TABASSARAN - -> `const` **VERTICAL\_OCR\_TABASSARAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:381](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L381) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md deleted file mode 100644 index 542a41e69..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAGALOG.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_TAGALOG - -> `const` **VERTICAL\_OCR\_TAGALOG**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:399](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L399) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md deleted file mode 100644 index ba87affbb..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TAJIK.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_TAJIK - -> `const` **VERTICAL\_OCR\_TAJIK**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:393](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L393) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md deleted file mode 100644 index 7d917f93d..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TELUGU.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_TELUGU - -> `const` **VERTICAL\_OCR\_TELUGU**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:387](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L387) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md deleted file mode 100644 index fc8d0d3ae..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_TURKISH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_TURKISH - -> `const` **VERTICAL\_OCR\_TURKISH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:405](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L405) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md deleted file mode 100644 index 8c6e183a0..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UKRAINIAN.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_UKRAINIAN - -> `const` **VERTICAL\_OCR\_UKRAINIAN**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:411](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L411) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md deleted file mode 100644 index 88e360fcc..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_UZBEK.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_UZBEK - -> `const` **VERTICAL\_OCR\_UZBEK**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:417](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L417) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md deleted file mode 100644 index 47f7b95c3..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_VIETNAMESE.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_VIETNAMESE - -> `const` **VERTICAL\_OCR\_VIETNAMESE**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:423](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L423) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md b/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md deleted file mode 100644 index 327700266..000000000 --- a/docs/docs/06-api-reference/variables/VERTICAL_OCR_WELSH.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: VERTICAL\_OCR\_WELSH - -> `const` **VERTICAL\_OCR\_WELSH**: `object` - -Defined in: [packages/react-native-executorch/src/constants/ocr/models.ts:111](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/ocr/models.ts#L111) - -## Type Declaration - -### detectorSource - -> **detectorSource**: `string` = `DETECTOR_CRAFT_MODEL` - -### language - -> **language**: `"abq"` \| `"ady"` \| `"af"` \| `"ava"` \| `"az"` \| `"be"` \| `"bg"` \| `"bs"` \| `"chSim"` \| `"che"` \| `"cs"` \| `"cy"` \| `"da"` \| `"dar"` \| `"de"` \| `"en"` \| `"es"` \| `"et"` \| `"fr"` \| `"ga"` \| `"hr"` \| `"hu"` \| `"id"` \| `"inh"` \| `"ic"` \| `"it"` \| `"ja"` \| `"kbd"` \| `"kn"` \| `"ko"` \| `"ku"` \| `"la"` \| `"lbe"` \| `"lez"` \| `"lt"` \| `"lv"` \| `"mi"` \| `"mn"` \| `"ms"` \| `"mt"` \| `"nl"` \| `"no"` \| `"oc"` \| `"pi"` \| `"pl"` \| `"pt"` \| `"ro"` \| `"ru"` \| `"rsCyrillic"` \| `"rsLatin"` \| `"sk"` \| `"sl"` \| `"sq"` \| `"sv"` \| `"sw"` \| `"tab"` \| `"te"` \| `"tjk"` \| `"tl"` \| `"tr"` \| `"uk"` \| `"uz"` \| `"vi"` - -### recognizerSource - -> **recognizerSource**: `string` diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE.md b/docs/docs/06-api-reference/variables/WHISPER_BASE.md index aaa1e030c..b7751b7f3 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:368](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L368) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:500](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L500) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md index 4c30911d8..fdec9a9bd 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_BASE_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_BASE\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:347](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L347) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:470](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L470) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md index afa3ed256..1213d2ca9 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:375](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L375) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:510](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L510) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md index adca5de74..4c6996d9a 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_SMALL_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_SMALL\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:354](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L354) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:480](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L480) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY.md b/docs/docs/06-api-reference/variables/WHISPER_TINY.md index 45a57bd04..ecba823b1 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:361](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L361) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:490](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L490) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md index 4c0e00ecf..ed43620a9 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:333](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L333) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:450](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L450) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md index 0770d0d67..33a4db9c1 100644 --- a/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md +++ b/docs/docs/06-api-reference/variables/WHISPER_TINY_EN_QUANTIZED.md @@ -2,7 +2,7 @@ > `const` **WHISPER\_TINY\_EN\_QUANTIZED**: `object` -Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:340](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/constants/modelUrls.ts#L340) +Defined in: [packages/react-native-executorch/src/constants/modelUrls.ts:460](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/constants/modelUrls.ts#L460) ## Type Declaration diff --git a/docs/docs/06-api-reference/variables/parseToolCall.md b/docs/docs/06-api-reference/variables/parseToolCall.md index d5fddcfad..ceb3ac179 100644 --- a/docs/docs/06-api-reference/variables/parseToolCall.md +++ b/docs/docs/06-api-reference/variables/parseToolCall.md @@ -2,7 +2,9 @@ > `const` **parseToolCall**: (`message`) => [`ToolCall`](../interfaces/ToolCall.md)[] -Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/utils/llm.ts#L9) +Defined in: [packages/react-native-executorch/src/utils/llm.ts:16](https://github.com/software-mansion/react-native-executorch/blob/41ebfb44b8f7a0e75b79ecbd41a0ff716cb5fb5c/packages/react-native-executorch/src/utils/llm.ts#L16) + +Parses tool calls from a given message string. ## Parameters @@ -10,6 +12,10 @@ Defined in: [packages/react-native-executorch/src/utils/llm.ts:9](https://github `string` +The message string containing tool calls in JSON format. + ## Returns [`ToolCall`](../interfaces/ToolCall.md)[] + +An array of `ToolCall` objects extracted from the message. diff --git a/packages/react-native-executorch/src/constants/llmDefaults.ts b/packages/react-native-executorch/src/constants/llmDefaults.ts index 2d0555991..815ba2942 100644 --- a/packages/react-native-executorch/src/constants/llmDefaults.ts +++ b/packages/react-native-executorch/src/constants/llmDefaults.ts @@ -2,6 +2,8 @@ import { ChatConfig, Message } from '../types/llm'; /** * Default system prompt used to guide the behavior of Large Language Models (LLMs). + * + * @category Utilities - LLM */ export const DEFAULT_SYSTEM_PROMPT = "You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text."; @@ -9,6 +11,7 @@ export const DEFAULT_SYSTEM_PROMPT = /** * Generates a default structured output prompt based on the provided JSON schema. * + * @category Utilities - LLM * @param structuredOutputSchema - A string representing the JSON schema for the desired output format. * @returns A prompt string instructing the model to format its output according to the given schema. */ @@ -25,16 +28,22 @@ ${structuredOutputSchema} /** * Default message history for Large Language Models (LLMs). + * + * @category Utilities - LLM */ export const DEFAULT_MESSAGE_HISTORY: Message[] = []; /** * Default context window length for Large Language Models (LLMs). + * + * @category Utilities - LLM */ export const DEFAULT_CONTEXT_WINDOW_LENGTH = 5; /** * Default chat configuration for Large Language Models (LLMs). + * + * @category Utilities - LLM */ export const DEFAULT_CHAT_CONFIG: ChatConfig = { systemPrompt: DEFAULT_SYSTEM_PROMPT, diff --git a/packages/react-native-executorch/src/constants/modelUrls.ts b/packages/react-native-executorch/src/constants/modelUrls.ts index 7096e6344..b9202a854 100644 --- a/packages/react-native-executorch/src/constants/modelUrls.ts +++ b/packages/react-native-executorch/src/constants/modelUrls.ts @@ -13,36 +13,54 @@ const LLAMA3_2_1B_SPINQUANT_MODEL = `${URL_PREFIX}-llama-3.2/${VERSION_TAG}/llam const LLAMA3_2_TOKENIZER = `${URL_PREFIX}-llama-3.2/${VERSION_TAG}/tokenizer.json`; const LLAMA3_2_TOKENIZER_CONFIG = `${URL_PREFIX}-llama-3.2/${VERSION_TAG}/tokenizer_config.json`; +/** + * @category Models - LMM + */ export const LLAMA3_2_3B = { modelSource: LLAMA3_2_3B_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const LLAMA3_2_3B_QLORA = { modelSource: LLAMA3_2_3B_QLORA_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const LLAMA3_2_3B_SPINQUANT = { modelSource: LLAMA3_2_3B_SPINQUANT_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const LLAMA3_2_1B = { modelSource: LLAMA3_2_1B_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const LLAMA3_2_1B_QLORA = { modelSource: LLAMA3_2_1B_QLORA_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const LLAMA3_2_1B_SPINQUANT = { modelSource: LLAMA3_2_1B_SPINQUANT_MODEL, tokenizerSource: LLAMA3_2_TOKENIZER, @@ -59,36 +77,54 @@ const QWEN3_4B_QUANTIZED_MODEL = `${URL_PREFIX}-qwen-3/${VERSION_TAG}/qwen-3-4B/ const QWEN3_TOKENIZER = `${URL_PREFIX}-qwen-3/${VERSION_TAG}/tokenizer.json`; const QWEN3_TOKENIZER_CONFIG = `${URL_PREFIX}-qwen-3/${VERSION_TAG}/tokenizer_config.json`; +/** + * @category Models - LMM + */ export const QWEN3_0_6B = { modelSource: QWEN3_0_6B_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const QWEN3_0_6B_QUANTIZED = { modelSource: QWEN3_0_6B_QUANTIZED_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const QWEN3_1_7B = { modelSource: QWEN3_1_7B_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const QWEN3_1_7B_QUANTIZED = { modelSource: QWEN3_1_7B_QUANTIZED_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const QWEN3_4B = { modelSource: QWEN3_4B_MODEL, tokenizerSource: QWEN3_TOKENIZER, tokenizerConfigSource: QWEN3_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const QWEN3_4B_QUANTIZED = { modelSource: QWEN3_4B_QUANTIZED_MODEL, tokenizerSource: QWEN3_TOKENIZER, @@ -105,36 +141,54 @@ const HAMMER2_1_3B_QUANTIZED_MODEL = `${URL_PREFIX}-hammer-2.1/${VERSION_TAG}/ha const HAMMER2_1_TOKENIZER = `${URL_PREFIX}-hammer-2.1/${VERSION_TAG}/tokenizer.json`; const HAMMER2_1_TOKENIZER_CONFIG = `${URL_PREFIX}-hammer-2.1/${VERSION_TAG}/tokenizer_config.json`; +/** + * @category Models - LMM + */ export const HAMMER2_1_0_5B = { modelSource: HAMMER2_1_0_5B_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const HAMMER2_1_0_5B_QUANTIZED = { modelSource: HAMMER2_1_0_5B_QUANTIZED_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const HAMMER2_1_1_5B = { modelSource: HAMMER2_1_1_5B_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const HAMMER2_1_1_5B_QUANTIZED = { modelSource: HAMMER2_1_1_5B_QUANTIZED_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const HAMMER2_1_3B = { modelSource: HAMMER2_1_3B_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, tokenizerConfigSource: HAMMER2_1_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const HAMMER2_1_3B_QUANTIZED = { modelSource: HAMMER2_1_3B_QUANTIZED_MODEL, tokenizerSource: HAMMER2_1_TOKENIZER, @@ -151,36 +205,54 @@ const SMOLLM2_1_1_7B_QUANTIZED_MODEL = `${URL_PREFIX}-smolLm-2/${VERSION_TAG}/sm const SMOLLM2_1_TOKENIZER = `${URL_PREFIX}-smolLm-2/${VERSION_TAG}/tokenizer.json`; const SMOLLM2_1_TOKENIZER_CONFIG = `${URL_PREFIX}-smolLm-2/${VERSION_TAG}/tokenizer_config.json`; +/** + * @category Models - LMM + */ export const SMOLLM2_1_135M = { modelSource: SMOLLM2_1_135M_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const SMOLLM2_1_135M_QUANTIZED = { modelSource: SMOLLM2_1_135M_QUANTIZED_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const SMOLLM2_1_360M = { modelSource: SMOLLM2_1_360M_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const SMOLLM2_1_360M_QUANTIZED = { modelSource: SMOLLM2_1_360M_QUANTIZED_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const SMOLLM2_1_1_7B = { modelSource: SMOLLM2_1_1_7B_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, tokenizerConfigSource: SMOLLM2_1_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const SMOLLM2_1_1_7B_QUANTIZED = { modelSource: SMOLLM2_1_1_7B_QUANTIZED_MODEL, tokenizerSource: SMOLLM2_1_TOKENIZER, @@ -197,36 +269,54 @@ const QWEN2_5_3B_QUANTIZED_MODEL = `${URL_PREFIX}-qwen-2.5/${VERSION_TAG}/qwen-2 const QWEN2_5_TOKENIZER = `${URL_PREFIX}-qwen-2.5/${VERSION_TAG}/tokenizer.json`; const QWEN2_5_TOKENIZER_CONFIG = `${URL_PREFIX}-qwen-2.5/${VERSION_TAG}/tokenizer_config.json`; +/** + * @category Models - LMM + */ export const QWEN2_5_0_5B = { modelSource: QWEN2_5_0_5B_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const QWEN2_5_0_5B_QUANTIZED = { modelSource: QWEN2_5_0_5B_QUANTIZED_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const QWEN2_5_1_5B = { modelSource: QWEN2_5_1_5B_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const QWEN2_5_1_5B_QUANTIZED = { modelSource: QWEN2_5_1_5B_QUANTIZED_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const QWEN2_5_3B = { modelSource: QWEN2_5_3B_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, tokenizerConfigSource: QWEN2_5_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const QWEN2_5_3B_QUANTIZED = { modelSource: QWEN2_5_3B_QUANTIZED_MODEL, tokenizerSource: QWEN2_5_TOKENIZER, @@ -239,12 +329,18 @@ const PHI_4_MINI_4B_QUANTIZED_MODEL = `${URL_PREFIX}-phi-4-mini/${VERSION_TAG}/q const PHI_4_MINI_TOKENIZER = `${URL_PREFIX}-phi-4-mini/${VERSION_TAG}/tokenizer.json`; const PHI_4_MINI_TOKENIZER_CONFIG = `${URL_PREFIX}-phi-4-mini/${VERSION_TAG}/tokenizer_config.json`; +/** + * @category Models - LMM + */ export const PHI_4_MINI_4B = { modelSource: PHI_4_MINI_4B_MODEL, tokenizerSource: PHI_4_MINI_TOKENIZER, tokenizerConfigSource: PHI_4_MINI_TOKENIZER_CONFIG, }; +/** + * @category Models - LMM + */ export const PHI_4_MINI_4B_QUANTIZED = { modelSource: PHI_4_MINI_4B_QUANTIZED_MODEL, tokenizerSource: PHI_4_MINI_TOKENIZER, @@ -257,6 +353,9 @@ const EFFICIENTNET_V2_S_MODEL = ? `${URL_PREFIX}-efficientnet-v2-s/${VERSION_TAG}/coreml/efficientnet_v2_s_coreml_all.pte` : `${URL_PREFIX}-efficientnet-v2-s/${VERSION_TAG}/xnnpack/efficientnet_v2_s_xnnpack.pte`; +/** + * @category Models - Classification + */ export const EFFICIENTNET_V2_S = { modelSource: EFFICIENTNET_V2_S_MODEL, }; @@ -264,6 +363,9 @@ export const EFFICIENTNET_V2_S = { // Object detection const SSDLITE_320_MOBILENET_V3_LARGE_MODEL = `${URL_PREFIX}-ssdlite320-mobilenet-v3-large/${VERSION_TAG}/ssdlite320-mobilenetv3-large.pte`; +/** + * @category Models - Object Detection + */ export const SSDLITE_320_MOBILENET_V3_LARGE = { modelSource: SSDLITE_320_MOBILENET_V3_LARGE_MODEL, }; @@ -286,18 +388,30 @@ const STYLE_TRANSFER_UDNIE_MODEL = ? `${URL_PREFIX}-style-transfer-udnie/${VERSION_TAG}/coreml/style_transfer_udnie_coreml.pte` : `${URL_PREFIX}-style-transfer-udnie/${VERSION_TAG}/xnnpack/style_transfer_udnie_xnnpack.pte`; +/** + * @category Models - Style Transfer + */ export const STYLE_TRANSFER_CANDY = { modelSource: STYLE_TRANSFER_CANDY_MODEL, }; +/** + * @category Models - Style Transfer + */ export const STYLE_TRANSFER_MOSAIC = { modelSource: STYLE_TRANSFER_MOSAIC_MODEL, }; +/** + * @category Models - Style Transfer + */ export const STYLE_TRANSFER_RAIN_PRINCESS = { modelSource: STYLE_TRANSFER_RAIN_PRINCESS_MODEL, }; +/** + * @category Models - Style Transfer + */ export const STYLE_TRANSFER_UDNIE = { modelSource: STYLE_TRANSFER_UDNIE_MODEL, }; @@ -330,6 +444,9 @@ const WHISPER_SMALL_TOKENIZER = `${URL_PREFIX}-whisper-small/${VERSION_TAG}/toke const WHISPER_SMALL_ENCODER_MODEL = `${URL_PREFIX}-whisper-small/${VERSION_TAG}/xnnpack/whisper_small_encoder_xnnpack.pte`; const WHISPER_SMALL_DECODER_MODEL = `${URL_PREFIX}-whisper-small/${VERSION_TAG}/xnnpack/whisper_small_decoder_xnnpack.pte`; +/** + * @category Models - Speech To Text + */ export const WHISPER_TINY_EN = { isMultilingual: false, encoderSource: WHISPER_TINY_EN_ENCODER, @@ -337,6 +454,9 @@ export const WHISPER_TINY_EN = { tokenizerSource: WHISPER_TINY_EN_TOKENIZER, }; +/** + * @category Models - Speech To Text + */ export const WHISPER_TINY_EN_QUANTIZED = { isMultilingual: false, encoderSource: WHISPER_TINY_EN_ENCODER_QUANTIZED, @@ -344,6 +464,9 @@ export const WHISPER_TINY_EN_QUANTIZED = { tokenizerSource: WHISPER_TINY_EN_TOKENIZER, }; +/** + * @category Models - Speech To Text + */ export const WHISPER_BASE_EN = { isMultilingual: false, encoderSource: WHISPER_BASE_EN_ENCODER, @@ -351,6 +474,9 @@ export const WHISPER_BASE_EN = { tokenizerSource: WHISPER_BASE_EN_TOKENIZER, }; +/** + * @category Models - Speech To Text + */ export const WHISPER_SMALL_EN = { isMultilingual: false, encoderSource: WHISPER_SMALL_EN_ENCODER, @@ -358,6 +484,9 @@ export const WHISPER_SMALL_EN = { tokenizerSource: WHISPER_SMALL_EN_TOKENIZER, }; +/** + * @category Models - Speech To Text + */ export const WHISPER_TINY = { isMultilingual: true, encoderSource: WHISPER_TINY_ENCODER_MODEL, @@ -365,6 +494,9 @@ export const WHISPER_TINY = { tokenizerSource: WHISPER_TINY_TOKENIZER, }; +/** + * @category Models - Speech To Text + */ export const WHISPER_BASE = { isMultilingual: true, encoderSource: WHISPER_BASE_ENCODER_MODEL, @@ -372,6 +504,9 @@ export const WHISPER_BASE = { tokenizerSource: WHISPER_BASE_TOKENIZER, }; +/** + * @category Models - Speech To Text + */ export const WHISPER_SMALL = { isMultilingual: true, encoderSource: WHISPER_SMALL_ENCODER_MODEL, @@ -382,6 +517,9 @@ export const WHISPER_SMALL = { // Image segmentation const DEEPLAB_V3_RESNET50_MODEL = `${URL_PREFIX}-deeplab-v3/${VERSION_TAG}/xnnpack/deeplabV3_xnnpack_fp32.pte`; +/** + * @category Models - Image Segmentation + */ export const DEEPLAB_V3_RESNET50 = { modelSource: DEEPLAB_V3_RESNET50_MODEL, }; @@ -389,6 +527,9 @@ export const DEEPLAB_V3_RESNET50 = { // Image Embeddings const CLIP_VIT_BASE_PATCH32_IMAGE_MODEL = `${URL_PREFIX}-clip-vit-base-patch32/${VERSION_TAG}/clip-vit-base-patch32-vision_xnnpack.pte`; +/** + * @category Models - Image Embeddings + */ export const CLIP_VIT_BASE_PATCH32_IMAGE = { modelSource: CLIP_VIT_BASE_PATCH32_IMAGE_MODEL, }; @@ -405,32 +546,51 @@ const MULTI_QA_MPNET_BASE_DOT_V1_TOKENIZER = `${URL_PREFIX}-multi-qa-mpnet-base- const CLIP_VIT_BASE_PATCH32_TEXT_MODEL = `${URL_PREFIX}-clip-vit-base-patch32/${VERSION_TAG}/clip-vit-base-patch32-text_xnnpack.pte`; const CLIP_VIT_BASE_PATCH32_TEXT_TOKENIZER = `${URL_PREFIX}-clip-vit-base-patch32/${VERSION_TAG}/tokenizer.json`; +/** + * @category Models - Text Embeddings + */ export const ALL_MINILM_L6_V2 = { modelSource: ALL_MINILM_L6_V2_MODEL, tokenizerSource: ALL_MINILM_L6_V2_TOKENIZER, }; +/** + * @category Models - Text Embeddings + */ export const ALL_MPNET_BASE_V2 = { modelSource: ALL_MPNET_BASE_V2_MODEL, tokenizerSource: ALL_MPNET_BASE_V2_TOKENIZER, }; +/** + * @category Models - Text Embeddings + */ export const MULTI_QA_MINILM_L6_COS_V1 = { modelSource: MULTI_QA_MINILM_L6_COS_V1_MODEL, tokenizerSource: MULTI_QA_MINILM_L6_COS_V1_TOKENIZER, }; +/** + * @category Models - Text Embeddings + */ export const MULTI_QA_MPNET_BASE_DOT_V1 = { modelSource: MULTI_QA_MPNET_BASE_DOT_V1_MODEL, tokenizerSource: MULTI_QA_MPNET_BASE_DOT_V1_TOKENIZER, }; +/** + * @category Models - Text Embeddings + */ export const CLIP_VIT_BASE_PATCH32_TEXT = { modelSource: CLIP_VIT_BASE_PATCH32_TEXT_MODEL, tokenizerSource: CLIP_VIT_BASE_PATCH32_TEXT_TOKENIZER, }; // Image generation + +/** + * @category Models - Image Generation + */ export const 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`, @@ -439,6 +599,9 @@ export const BK_SDM_TINY_VPRED_512 = { decoderSource: `${URL_PREFIX}-bk-sdm-tiny/${VERSION_TAG}/vae/model.pte`, }; +/** + * @category Models - Image Generation + */ export const 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`, @@ -450,6 +613,9 @@ export const BK_SDM_TINY_VPRED_256 = { // Voice Activity Detection const FSMN_VAD_MODEL = `${URL_PREFIX}-fsmn-vad/${VERSION_TAG}/xnnpack/fsmn-vad_xnnpack.pte`; +/** + * @category Models - Voice Activity Detection + */ export const FSMN_VAD = { modelSource: FSMN_VAD_MODEL, -}; +}; \ No newline at end of file diff --git a/packages/react-native-executorch/src/constants/ocr/models.ts b/packages/react-native-executorch/src/constants/ocr/models.ts index 9f462b738..45a411aef 100644 --- a/packages/react-native-executorch/src/constants/ocr/models.ts +++ b/packages/react-native-executorch/src/constants/ocr/models.ts @@ -27,400 +27,326 @@ const createOCRObject = ( }; }; -const createVerticalOCRObject = ( - recognizerSource: string, - language: keyof typeof symbols -) => { - return { - detectorSource: DETECTOR_CRAFT_MODEL, - recognizerSource, - language, - }; -}; - +/** + * @category OCR Supported Alphabets + */ export const OCR_ABAZA = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'abq'); -export const VERTICAL_OCR_ABAZA = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'abq' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_ADYGHE = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'ady'); -export const VERTICAL_OCR_ADYGHE = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'ady' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_AFRIKAANS = createOCRObject(RECOGNIZER_LATIN_CRNN, 'af'); -export const VERTICAL_OCR_AFRIKAANS = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'af' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_AVAR = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'ava'); -export const VERTICAL_OCR_AVAR = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'ava' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_AZERBAIJANI = createOCRObject(RECOGNIZER_LATIN_CRNN, 'az'); -export const VERTICAL_OCR_AZERBAIJANI = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'az' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_BELARUSIAN = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'be'); -export const VERTICAL_OCR_BELARUSIAN = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'be' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_BULGARIAN = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'bg'); -export const VERTICAL_OCR_BULGARIAN = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'bg' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_BOSNIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'bs'); -export const VERTICAL_OCR_BOSNIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'bs' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_SIMPLIFIED_CHINESE = createOCRObject( RECOGNIZER_ZH_SIM_CRNN, 'chSim' ); -export const VERTICAL_OCR_SIMPLIFIED_CHINESE = createVerticalOCRObject( - RECOGNIZER_ZH_SIM_CRNN, - 'chSim' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_CHECHEN = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'che'); -export const VERTICAL_OCR_CHECHEN = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'che' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_CZECH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'cs'); -export const VERTICAL_OCR_CZECH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'cs' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_WELSH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'cy'); -export const VERTICAL_OCR_WELSH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'cy' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_DANISH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'da'); -export const VERTICAL_OCR_DANISH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'da' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_DARGWA = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'dar'); -export const VERTICAL_OCR_DARGWA = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'dar' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_GERMAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'de'); -export const VERTICAL_OCR_GERMAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'de' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_ENGLISH = createOCRObject(RECOGNIZER_ENGLISH_CRNN, 'en'); -export const VERTICAL_OCR_ENGLISH = createVerticalOCRObject( - RECOGNIZER_ENGLISH_CRNN, - 'en' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_SPANISH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'es'); -export const VERTICAL_OCR_SPANISH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'es' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_ESTONIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'et'); -export const VERTICAL_OCR_ESTONIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'et' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_FRENCH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'fr'); -export const VERTICAL_OCR_FRENCH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'fr' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_IRISH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'ga'); -export const VERTICAL_OCR_IRISH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'ga' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_CROATIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'hr'); -export const VERTICAL_OCR_CROATIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'hr' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_HUNGARIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'hu'); -export const VERTICAL_OCR_HUNGARIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'hu' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_INDONESIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'id'); -export const VERTICAL_OCR_INDONESIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'id' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_INGUSH = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'inh'); -export const VERTICAL_OCR_INGUSH = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'inh' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_ICELANDIC = createOCRObject(RECOGNIZER_LATIN_CRNN, 'ic'); -export const VERTICAL_OCR_ICELANDIC = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'ic' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_ITALIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'it'); -export const VERTICAL_OCR_ITALIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'it' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_JAPANESE = createOCRObject(RECOGNIZER_JAPANESE_CRNN, 'ja'); -export const VERTICAL_OCR_JAPANESE = createVerticalOCRObject( - RECOGNIZER_JAPANESE_CRNN, - 'ja' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_KARBADIAN = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'kbd'); -export const VERTICAL_OCR_KARBADIAN = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'kbd' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_KANNADA = createOCRObject(RECOGNIZER_KANNADA_CRNN, 'kn'); -export const VERTICAL_OCR_KANNADA = createVerticalOCRObject( - RECOGNIZER_KANNADA_CRNN, - 'kn' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_KOREAN = createOCRObject(RECOGNIZER_KOREAN_CRNN, 'ko'); -export const VERTICAL_OCR_KOREAN = createVerticalOCRObject( - RECOGNIZER_KOREAN_CRNN, - 'ko' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_KURDISH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'ku'); -export const VERTICAL_OCR_KURDISH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'ku' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_LATIN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'la'); -export const VERTICAL_OCR_LATIN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'la' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_LAK = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'lbe'); -export const VERTICAL_OCR_LAK = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'lbe' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_LEZGHIAN = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'lez'); -export const VERTICAL_OCR_LEZGHIAN = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'lez' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_LITHUANIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'lt'); -export const VERTICAL_OCR_LITHUANIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'lt' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_LATVIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'lv'); -export const VERTICAL_OCR_LATVIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'lv' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_MAORI = createOCRObject(RECOGNIZER_LATIN_CRNN, 'mi'); -export const VERTICAL_OCR_MAORI = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'mi' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_MONGOLIAN = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'mn'); -export const VERTICAL_OCR_MONGOLIAN = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'mn' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_MALAY = createOCRObject(RECOGNIZER_LATIN_CRNN, 'ms'); -export const VERTICAL_OCR_MALAY = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'ms' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_MALTESE = createOCRObject(RECOGNIZER_LATIN_CRNN, 'mt'); -export const VERTICAL_OCR_MALTESE = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'mt' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_DUTCH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'nl'); -export const VERTICAL_OCR_DUTCH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'nl' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_NORWEGIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'no'); -export const VERTICAL_OCR_NORWEGIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'no' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_OCCITAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'oc'); -export const VERTICAL_OCR_OCCITAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'oc' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_PALI = createOCRObject(RECOGNIZER_LATIN_CRNN, 'pi'); -export const VERTICAL_OCR_PALI = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'pi' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_POLISH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'pl'); -export const VERTICAL_OCR_POLISH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'pl' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_PORTUGUESE = createOCRObject(RECOGNIZER_LATIN_CRNN, 'pt'); -export const VERTICAL_OCR_PORTUGUESE = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'pt' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_ROMANIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'ro'); -export const VERTICAL_OCR_ROMANIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'ro' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_RUSSIAN = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'ru'); -export const VERTICAL_OCR_RUSSIAN = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'ru' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_SERBIAN_CYRILLIC = createOCRObject( RECOGNIZER_CYRILLIC_CRNN, 'rsCyrillic' ); -export const VERTICAL_OCR_SERBIAN_CYRILLIC = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'rsCyrillic' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_SERBIAN_LATIN = createOCRObject( RECOGNIZER_LATIN_CRNN, 'rsLatin' ); -export const VERTICAL_OCR_SERBIAN_LATIN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'rsLatin' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_SLOVAK = createOCRObject(RECOGNIZER_LATIN_CRNN, 'sk'); -export const VERTICAL_OCR_SLOVAK = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'sk' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_SLOVENIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'sl'); -export const VERTICAL_OCR_SLOVENIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'sl' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_ALBANIAN = createOCRObject(RECOGNIZER_LATIN_CRNN, 'sq'); -export const VERTICAL_OCR_ALBANIAN = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'sq' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_SWEDISH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'sv'); -export const VERTICAL_OCR_SWEDISH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'sv' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_SWAHILI = createOCRObject(RECOGNIZER_LATIN_CRNN, 'sw'); -export const VERTICAL_OCR_SWAHILI = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'sw' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_TABASSARAN = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'tab'); -export const VERTICAL_OCR_TABASSARAN = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'tab' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_TELUGU = createOCRObject(RECOGNIZER_TELUGU_CRNN, 'te'); -export const VERTICAL_OCR_TELUGU = createVerticalOCRObject( - RECOGNIZER_TELUGU_CRNN, - 'te' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_TAJIK = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'tjk'); -export const VERTICAL_OCR_TAJIK = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'tjk' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_TAGALOG = createOCRObject(RECOGNIZER_LATIN_CRNN, 'tl'); -export const VERTICAL_OCR_TAGALOG = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'tl' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_TURKISH = createOCRObject(RECOGNIZER_LATIN_CRNN, 'tr'); -export const VERTICAL_OCR_TURKISH = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'tr' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_UKRAINIAN = createOCRObject(RECOGNIZER_CYRILLIC_CRNN, 'uk'); -export const VERTICAL_OCR_UKRAINIAN = createVerticalOCRObject( - RECOGNIZER_CYRILLIC_CRNN, - 'uk' -); +/** + * @category OCR Supported Alphabets + */ export const OCR_UZBEK = createOCRObject(RECOGNIZER_LATIN_CRNN, 'uz'); -export const VERTICAL_OCR_UZBEK = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'uz' -); -export const OCR_VIETNAMESE = createOCRObject(RECOGNIZER_LATIN_CRNN, 'vi'); -export const VERTICAL_OCR_VIETNAMESE = createVerticalOCRObject( - RECOGNIZER_LATIN_CRNN, - 'vi' -); +/** + * @category OCR Supported Alphabets + */ +export const OCR_VIETNAMESE = createOCRObject(RECOGNIZER_LATIN_CRNN, 'vi'); \ No newline at end of file diff --git a/packages/react-native-executorch/src/constants/tts/models.ts b/packages/react-native-executorch/src/constants/tts/models.ts index f9677478e..40624848a 100644 --- a/packages/react-native-executorch/src/constants/tts/models.ts +++ b/packages/react-native-executorch/src/constants/tts/models.ts @@ -9,6 +9,8 @@ const KOKORO_EN_MEDIUM_MODELS_ROOT = `${KOKORO_EN_MODELS_ROOT}/medium`; * A Kokoro model instance which processes the text in batches of maximum 64 tokens. * Uses significant less memory than the medium model, but could produce * a lower quality speech due to forced, aggressive text splitting. + * + * @category Models - Text to Speech */ export const KOKORO_SMALL = { type: 'kokoro' as const, @@ -18,6 +20,8 @@ export const KOKORO_SMALL = { /** * A standard Kokoro instance which processes the text in batches of maximum 128 tokens. + * + * @category Models - Text to Speech */ export const KOKORO_MEDIUM = { type: 'kokoro' as const, diff --git a/packages/react-native-executorch/src/constants/tts/voices.ts b/packages/react-native-executorch/src/constants/tts/voices.ts index 7736c8d79..16a682829 100644 --- a/packages/react-native-executorch/src/constants/tts/voices.ts +++ b/packages/react-native-executorch/src/constants/tts/voices.ts @@ -18,41 +18,65 @@ const EN_GB_RESOURCES = { // Kokoro voices const KOKORO_VOICE_PREFIX = `${URL_PREFIX}-kokoro/${NEXT_VERSION_TAG}/voices`; +/** + * @category TTS Supported Voices + */ export const KOKORO_VOICE_AF_HEART = { lang: 'en-us' as const, voiceSource: `${KOKORO_VOICE_PREFIX}/af_heart.bin`, extra: EN_US_RESOURCES, } as VoiceConfig; +/** + * @category TTS Supported Voices + */ export const KOKORO_VOICE_AF_RIVER = { lang: 'en-us' as const, voiceSource: `${KOKORO_VOICE_PREFIX}/af_river.bin`, extra: EN_US_RESOURCES, } as VoiceConfig; +/** + * @category TTS Supported Voices + */ export const KOKORO_VOICE_AF_SARAH = { lang: 'en-us' as const, voiceSource: `${KOKORO_VOICE_PREFIX}/af_sarah.bin`, extra: EN_US_RESOURCES, } as VoiceConfig; +/** + * @category TTS Supported Voices + */ export const KOKORO_VOICE_AM_ADAM = { lang: 'en-us' as const, voiceSource: `${KOKORO_VOICE_PREFIX}/am_adam.bin`, extra: EN_US_RESOURCES, } as VoiceConfig; +/** + * @category TTS Supported Voices + */ export const KOKORO_VOICE_AM_MICHAEL = { lang: 'en-us' as const, voiceSource: `${KOKORO_VOICE_PREFIX}/am_michael.bin`, extra: EN_US_RESOURCES, } as VoiceConfig; +/** + * @category TTS Supported Voices + */ export const KOKORO_VOICE_AM_SANTA = { lang: 'en-us' as const, voiceSource: `${KOKORO_VOICE_PREFIX}/am_santa.bin`, extra: EN_US_RESOURCES, } as VoiceConfig; +/** + * @category TTS Supported Voices + */ export const KOKORO_VOICE_BF_EMMA = { lang: 'en-gb' as const, voiceSource: `${KOKORO_VOICE_PREFIX}/bf_emma.bin`, extra: EN_GB_RESOURCES, } as VoiceConfig; +/** + * @category TTS Supported Voices + */ export const KOKORO_VOICE_BM_DANIEL = { lang: 'en-gb' as const, voiceSource: `${KOKORO_VOICE_PREFIX}/bm_daniel.bin`, diff --git a/packages/react-native-executorch/src/errors/errorUtils.ts b/packages/react-native-executorch/src/errors/errorUtils.ts index 90a616cdf..794f0e67b 100644 --- a/packages/react-native-executorch/src/errors/errorUtils.ts +++ b/packages/react-native-executorch/src/errors/errorUtils.ts @@ -1,5 +1,8 @@ import { RnExecutorchErrorCode } from './ErrorCodes'; +/** + * Custom error class for React Native ExecuTorch errors. + */ export class RnExecutorchError extends Error { /** * The error code representing the type of error. 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 094a3fd5d..83c9a31e4 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useClassification.ts @@ -4,7 +4,8 @@ import { ClassificationProps, ClassificationType } from '../../types/classificat /** * React hook for managing a Classification model instance. - * + * + * @category Hooks * @param ClassificationConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use Classification model. */ 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 bad2f13cc..7d1d21893 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useImageEmbeddings.ts @@ -5,6 +5,7 @@ import { useModule } from '../useModule'; /** * React hook for managing an Image Embeddings model instance. * + * @category Hooks * @param ImageEmbeddingsConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use Image Embeddings model. */ diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts b/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts index 6c2cd303b..9fdc4771f 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useImageSegmentation.ts @@ -5,6 +5,7 @@ import { ImageSegmentationProps, ImageSegmentationType } from '../../types/image /** * React hook for managing an Image Segmentation model instance. * + * @category Hooks * @param ImageSegmentationConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use Image Segmentation model. */ diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts b/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts index e93716039..3fb49307c 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useOCR.ts @@ -6,6 +6,7 @@ import { RnExecutorchError } from '../../errors/errorUtils'; /** * React hook for managing an OCR instance. * + * @category Hooks * @param OCRConfiguration - Configuration object containing `model` sources and optional `preventLoad` flag. * @returns Ready to use OCR model. */ 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 75b99c05d..19537a80a 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useObjectDetection.ts @@ -5,6 +5,7 @@ import { ObjectDetectionProps, ObjectDetectionType } from '../../types/objectDet /** * React hook for managing an Object Detection model instance. * + * @category Hooks * @param ObjectDetectionConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use Object Detection model. */ 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 fab7803ca..a5ea05009 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useStyleTransfer.ts @@ -5,6 +5,7 @@ import { StyleTransferProps, StyleTransferType } from '../../types/styleTransfer /** * React hook for managing a Style Transfer model instance. * + * @category Hooks * @param StyleTransferConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use Style Transfer model. */ diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts b/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts index 2533f98a9..204452c45 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useTextToImage.ts @@ -7,6 +7,7 @@ import { TextToImageParams, TextToImageType } from '../../types/tti'; /** * React hook for managing a Text to Image instance. * + * @category Hooks * @param TextToImageConfiguration - Configuration object containing `model` source, `inferenceCallback`, and optional `preventLoad` flag. * @returns Ready to use Text to Image model. */ diff --git a/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts b/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts index ca60d8330..fc215720f 100644 --- a/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts +++ b/packages/react-native-executorch/src/hooks/computer_vision/useVerticalOCR.ts @@ -6,6 +6,7 @@ import { RnExecutorchError } from '../../errors/errorUtils'; /** * React hook for managing a Vertical OCR instance. * + * @category Hooks * @param VerticalOCRConfiguration - Configuration object containing `model` sources, optional `independentCharacters` and `preventLoad` flag. * @returns Ready to use Vertical OCR model. */ diff --git a/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts b/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts index 4535c7a8f..3f38bd691 100644 --- a/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts +++ b/packages/react-native-executorch/src/hooks/general/useExecutorchModule.ts @@ -5,6 +5,7 @@ import { useModule } from '../useModule'; /** * React hook for managing an arbitrary Executorch module instance. * + * @category Hooks * @param executorchModuleConfiguration - Configuration object containing `modelSource` and optional `preventLoad` flag. * @returns Ready to use Executorch module. */ diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts index 804fddd89..4b8464c2a 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useLLM.ts @@ -11,7 +11,8 @@ import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; /** * React hook for managing a Large Language Model (LLM) instance. - * + * + * @category Hooks * @param model - Object containing model, tokenizer, and tokenizer config sources. * @returns An object implementing the `LLMType` interface for interacting with the LLM. */ diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts index c15bc7572..aeb32690d 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useSpeechToText.ts @@ -7,6 +7,7 @@ import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; /** * React hook for managing a Speech to Text (STT) instance. * + * @category Hooks * @param speechToTextConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use Speech to Text model. */ 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 338c63192..8543522e6 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 @@ -5,6 +5,7 @@ import { TextEmbeddingsType, TextEmbeddingsProps } from '../../types/textEmbeddi /** * React hook for managing a Text Embeddings model instance. * + * @category Hooks * @param TextEmbeddingsConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use Text Embeddings model. */ diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts index 311ae59d8..d30ffa598 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts @@ -12,6 +12,7 @@ import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; /** * React hook for managing Text to Speech instance. * + * @category Hooks * @param TextToSpeechConfiguration - Configuration object containing `model` source, `voice` and optional `preventLoad`. * @returns Ready to use Text to Speech model. */ diff --git a/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts b/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts index 6899a27ae..e9cf2e794 100644 --- a/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts +++ b/packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts @@ -8,6 +8,7 @@ import { TokenizerType } from '../../types/tokenizer'; /** * React hook for managing a Tokenizer instance. * + * @category Hooks * @param tokenizerConfiguration - Configuration object containing `tokenizer` source and optional `preventLoad` flag. * @returns Ready to use Tokenizer model. */ 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 1350330eb..2fd9c9126 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 @@ -5,6 +5,7 @@ import { VADType, VADProps } from '../../types/vad'; /** * React hook for managing a VAD model instance. * + * @category Hooks * @param VADConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. * @returns Ready to use VAD model. */ 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 d70c9c1c1..5b7c49824 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts @@ -6,6 +6,8 @@ import { RnExecutorchError } from '../../errors/errorUtils'; /** * Module for image classification tasks. + * + * @category Typescript API */ export class ClassificationModule extends BaseModule { /** 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 f61ab693b..07845d058 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts @@ -6,6 +6,8 @@ import { BaseModule } from '../BaseModule'; /** * Module for generating image embeddings from input images. + * + * @category Typescript API */ export class ImageEmbeddingsModule extends BaseModule { /** diff --git a/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts index 73bfa62cf..ace786640 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ImageSegmentationModule.ts @@ -7,6 +7,8 @@ import { BaseModule } from '../BaseModule'; /** * Module for image segmentation tasks. + * + * @category Typescript API */ export class ImageSegmentationModule extends BaseModule { diff --git a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts b/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts index f914a00e6..f2d3cb369 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts @@ -2,6 +2,11 @@ import { OCRController } from '../../controllers/OCRController'; import { ResourceSource } from '../../types/common'; import { OCRLanguage } from '../../types/ocr'; +/** + * Module for Optical Character Recognition (OCR) tasks. + * + * @category Typescript API + */ export class OCRModule { private controller: OCRController; diff --git a/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts b/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts index b3763f3c1..08500589d 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts @@ -7,6 +7,8 @@ import { BaseModule } from '../BaseModule'; /** * Module for object detection tasks. + * + * @category Typescript API */ export class ObjectDetectionModule extends BaseModule { 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 dfdeffa6c..ac85cc51a 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts @@ -6,6 +6,8 @@ import { BaseModule } from '../BaseModule'; /** * Module for style transfer tasks. + * + * @category Typescript API */ export class StyleTransferModule extends BaseModule { /** diff --git a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts b/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts index 7cb75abf4..f8866f747 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts @@ -8,6 +8,8 @@ import { RnExecutorchError } from '../../errors/errorUtils'; /** * Module for text-to-image generation tasks. + * + * @category Typescript API */ export class TextToImageModule extends BaseModule { private inferenceCallback: (stepIdx: number) => void; diff --git a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts b/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts index 192550bd5..9dacf473f 100644 --- a/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts +++ b/packages/react-native-executorch/src/modules/computer_vision/VerticalOCRModule.ts @@ -2,6 +2,11 @@ import { VerticalOCRController } from '../../controllers/VerticalOCRController'; import { ResourceSource } from '../../types/common'; import { OCRLanguage } from '../../types/ocr'; +/** + * Module for Vertical Optical Character Recognition (Vertical OCR) tasks. + * + * @category Typescript API + */ export class VerticalOCRModule { private controller: VerticalOCRController; diff --git a/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts b/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts index ab1041e6f..02076933f 100644 --- a/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts +++ b/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts @@ -5,6 +5,11 @@ import { ResourceFetcher } from '../../utils/ResourceFetcher'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; +/** + * General module for executing custom Executorch models. + * + * @category Typescript API + */ export class ExecutorchModule extends BaseModule { /** * Loads the model, where `modelSource` is a string, number, or object that specifies the location of the model binary. diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts index 4786a1eb3..86dbeb926 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts @@ -8,6 +8,8 @@ import { /** * Module for managing a Large Language Model (LLM) instance. + * + * @category Typescript API */ export class LLMModule { private controller: LLMController; diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts index 0c5e61be3..238f2320b 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts @@ -6,6 +6,8 @@ import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils'; /** * Module for Speech to Text (STT) functionalities. + * + * @category Typescript API */ export class SpeechToTextModule { private nativeModule: any; 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 51e280db0..cbba62154 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 @@ -6,6 +6,8 @@ import { RnExecutorchError } from '../../errors/errorUtils'; /** * Module for generating text embeddings from input text. + * + * @category Typescript API */ export class TextEmbeddingsModule extends BaseModule { diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts index 3caf9376c..66b4e5676 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/TextToSpeechModule.ts @@ -10,6 +10,8 @@ import { /** * Module for Text to Speech (TTS) functionalities. + * + * @category Typescript API */ export class TextToSpeechModule { /** diff --git a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts b/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts index 5772ee121..e49dabef3 100644 --- a/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts +++ b/packages/react-native-executorch/src/modules/natural_language_processing/TokenizerModule.ts @@ -3,6 +3,11 @@ import { ResourceFetcher } from '../../utils/ResourceFetcher'; import { RnExecutorchError } from '../../errors/errorUtils'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; +/** + * Module for Tokenizer functionalities. + * + * @category Typescript API + */ export class TokenizerModule { /** * Native module 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 f239979f9..6152966c5 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 @@ -5,6 +5,11 @@ import { BaseModule } from '../BaseModule'; import { RnExecutorchErrorCode } from '../../errors/ErrorCodes'; import { RnExecutorchError } from '../../errors/errorUtils'; +/** + * Module for Voice Activity Detection (VAD) functionalities. + * + * @category Typescript API + */ export class VADModule extends BaseModule { /** * Loads the model, where `modelSource` is a string that specifies the location of the model binary. diff --git a/packages/react-native-executorch/src/types/classification.ts b/packages/react-native-executorch/src/types/classification.ts index a6df84fed..b03034a6c 100644 --- a/packages/react-native-executorch/src/types/classification.ts +++ b/packages/react-native-executorch/src/types/classification.ts @@ -4,6 +4,7 @@ import { ResourceSource } from "./common"; /** * Props for the `useClassification` hook. * + * @category Types * @property {Object} model - An object containing the model source. * @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. @@ -16,6 +17,8 @@ export interface ClassificationProps { /** * Return type for the `useClassification` hook. * Manages the state and operations for Computer Vision image classification. + * + * @category Types */ export interface ClassificationType { /** diff --git a/packages/react-native-executorch/src/types/common.ts b/packages/react-native-executorch/src/types/common.ts index 342c722c0..1cdc0983c 100644 --- a/packages/react-native-executorch/src/types/common.ts +++ b/packages/react-native-executorch/src/types/common.ts @@ -4,11 +4,15 @@ /** * Represents a source of a resource, which can be a string (e.g., URL or file path), a number (e.g., resource ID), or an object (e.g., binary data). + * + * @category Types */ export type ResourceSource = string | number | object; /** * Enum representing the scalar types of tensors. + * + * @category Types */ export enum ScalarType { /** @@ -103,6 +107,8 @@ export enum ScalarType { /** * Represents the data buffer of a tensor, which can be one of several typed array formats. + * + * @category Types */ export type TensorBuffer = | ArrayBuffer @@ -120,6 +126,7 @@ export type TensorBuffer = /** * Represents a pointer to a tensor, including its data buffer, size dimensions, and scalar type. * + * @category Types * @property {TensorBuffer} dataPtr - The data buffer of the tensor. * @property {number[]} sizes - An array representing the size of each dimension of the tensor. * @property {ScalarType} scalarType - The scalar type of the tensor, as defined in the `ScalarType` enum. diff --git a/packages/react-native-executorch/src/types/executorchModule.ts b/packages/react-native-executorch/src/types/executorchModule.ts index 204a57bdd..579e97de0 100644 --- a/packages/react-native-executorch/src/types/executorchModule.ts +++ b/packages/react-native-executorch/src/types/executorchModule.ts @@ -4,6 +4,7 @@ import { RnExecutorchError } from '../errors/errorUtils'; /** * Props for the `useExecutorchModule` hook. * + * @category Types * @property {ResourceSource} modelSource - The source of the ExecuTorch 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. */ @@ -15,6 +16,8 @@ export interface ExecutorchModuleProps { /** * Return type for the `useExecutorchModule` hook. * Manages the state and core execution methods for a general ExecuTorch model. + * + * @category Types */ export interface ExecutorchModuleType { /** diff --git a/packages/react-native-executorch/src/types/imageEmbeddings.ts b/packages/react-native-executorch/src/types/imageEmbeddings.ts index d0853ba5a..48625b56e 100644 --- a/packages/react-native-executorch/src/types/imageEmbeddings.ts +++ b/packages/react-native-executorch/src/types/imageEmbeddings.ts @@ -4,6 +4,7 @@ import { ResourceSource } from "./common"; /** * Props for the `useImageEmbeddings` hook. * + * @category Types * @property {Object} model - An object containing the model source. * @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. @@ -16,6 +17,8 @@ export interface ImageEmbeddingsProps { /** * Return type for the `useImageEmbeddings` hook. * Manages the state and operations for generating image embeddings (feature vectors) used in Computer Vision tasks. + * + * @category Types */ export interface ImageEmbeddingsType { /** diff --git a/packages/react-native-executorch/src/types/imageSegmentation.ts b/packages/react-native-executorch/src/types/imageSegmentation.ts index 834f50fa1..2eb3ece33 100644 --- a/packages/react-native-executorch/src/types/imageSegmentation.ts +++ b/packages/react-native-executorch/src/types/imageSegmentation.ts @@ -3,6 +3,8 @@ import { ResourceSource } from "./common"; /** * Labels used in the DeepLab image segmentation model. + * + * @category Types */ /* eslint-disable @cspell/spellchecker */ export enum DeeplabLabel { @@ -36,6 +38,8 @@ export enum DeeplabLabel { * @property {Object} model - An object containing the model source. * @property {ResourceSource} model.modelSource - The source of the image segmentation 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. + * + * @category Types */ export interface ImageSegmentationProps { model: { modelSource: ResourceSource }; @@ -45,6 +49,8 @@ export interface ImageSegmentationProps { /** * Return type for the `useImageSegmentation` hook. * Manages the state and operations for Computer Vision image segmentation (e.g., DeepLab). + * + * @category Types */ export interface ImageSegmentationType { /** diff --git a/packages/react-native-executorch/src/types/llm.ts b/packages/react-native-executorch/src/types/llm.ts index 45ada3a45..7b59bb2f2 100644 --- a/packages/react-native-executorch/src/types/llm.ts +++ b/packages/react-native-executorch/src/types/llm.ts @@ -2,6 +2,8 @@ import { RnExecutorchError } from '../errors/errorUtils'; /** * React hook for managing a Large Language Model (LLM) instance. + * + * @category Types */ export interface LLMType { /** @@ -89,6 +91,8 @@ export interface LLMType { /** * Configuration object for initializing and customizing a Large Language Model (LLM) instance. + * + * @category Types */ export interface LLMConfig { /** @@ -129,12 +133,15 @@ export interface LLMConfig { /** * Roles that a message sender can have. + * + * @category Types */ export type MessageRole = 'user' | 'assistant' | 'system'; /** * Represents a message in the conversation. * + * @category Types * @property {MessageRole} role - Role of the message sender of type `MessageRole`. * @property {string} content - Content of the message. */ @@ -146,6 +153,7 @@ export interface Message { /** * Represents a tool call made by the model. * + * @category Types * @property {string} toolName - The name of the tool being called. * @property {Object} arguments - The arguments passed to the tool. */ @@ -158,12 +166,15 @@ export interface ToolCall { * Represents a tool that can be used by the model. * Usually tool is represented with dictionary (Object), but fields depend on the model. * Unfortunately there's no one standard so it's hard to type it better. + * + * @category Types */ export type LLMTool = Object; /** * Object configuring chat management. * + * @category Types * @property {Message[]} initialMessageHistory - An array of `Message` objects that represent the conversation history. This can be used to provide initial context to the model. * @property {number} contextWindowLength - The number of messages from the current conversation that the model will use to generate a response. The higher the number, the more context the model will have. Keep in mind that using larger context windows will result in longer inference time and higher memory usage. * @property {string} systemPrompt - Often used to tell the model what is its purpose, for example - "Be a helpful translator". @@ -177,6 +188,7 @@ export interface ChatConfig { /** * Object configuring options for enabling and managing tool use. **It will only have effect if your model's chat template support it**. * + * @category Types * @property {LLMTool[]} tools - List of objects defining tools. * @property {(call: ToolCall) => Promise} executeToolCallback - Function that accepts `ToolCall`, executes tool and returns the string to model. * @property {boolean} [displayToolCalls] - If set to true, JSON tool calls will be displayed in chat. If false, only answers will be displayed. @@ -190,6 +202,7 @@ export interface ToolsConfig { /** * Object configuring generation settings. * + * @category Types * @property {number} [temperature] - Scales output logits by the inverse of temperature. Controls the randomness / creativity of text generation. * @property {number} [topp] - Only samples from the smallest set of tokens whose cumulative probability exceeds topp. * @property {number} [outputTokenBatchSize] - Soft upper limit on the number of tokens in each token batch (in certain cases there can be more tokens in given batch, i.e. when the batch would end with special emoji join character). @@ -202,6 +215,11 @@ export interface GenerationConfig { batchTimeInterval?: number; } +/** + * Special tokens used in Large Language Models (LLMs). + * + * @category Types + */ export const SPECIAL_TOKENS = { BOS_TOKEN: 'bos_token', EOS_TOKEN: 'eos_token', diff --git a/packages/react-native-executorch/src/types/objectDetection.ts b/packages/react-native-executorch/src/types/objectDetection.ts index 15b0d1a32..88aec5cce 100644 --- a/packages/react-native-executorch/src/types/objectDetection.ts +++ b/packages/react-native-executorch/src/types/objectDetection.ts @@ -4,6 +4,7 @@ import { ResourceSource } from "./common"; /** * Represents a bounding box for a detected object in an image. * + * @category Types * @property {number} x1 - The x-coordinate of the bottom-left corner of the bounding box. * @property {number} y1 - The y-coordinate of the bottom-left corner of the bounding box. * @property {number} x2 - The x-coordinate of the top-right corner of the bounding box. @@ -19,6 +20,7 @@ export interface Bbox { /** * Represents a detected object within an image, including its bounding box, label, and confidence score. * + * @category Types * @property {Bbox} bbox - The bounding box of the detected object, defined by its top-left (x1, y1) and bottom-right (x2, y2) coordinates. * @property {keyof typeof CocoLabel} label - The class label of the detected object, represented as a key from the `CocoLabel` enum. * @property {number} score - The confidence score of the detection, typically ranging from 0 to 1. @@ -31,6 +33,8 @@ export interface Detection { /** * COCO dataset class labels used for object detection. + * + * @category Types */ export enum CocoLabel { PERSON = 1, @@ -128,6 +132,7 @@ export enum CocoLabel { /** * Props for the `useObjectDetection` hook. * + * @category Types * @property {Object} model - An object containing the model source. * @property {ResourceSource} model.modelSource - The source of the object detection 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. @@ -140,6 +145,8 @@ export interface ObjectDetectionProps { /** * Return type for the `useObjectDetection` hook. * Manages the state and operations for Computer Vision object detection tasks. + * + * @category Types */ export interface ObjectDetectionType { /** diff --git a/packages/react-native-executorch/src/types/ocr.ts b/packages/react-native-executorch/src/types/ocr.ts index b6cc490e8..e479a2dff 100644 --- a/packages/react-native-executorch/src/types/ocr.ts +++ b/packages/react-native-executorch/src/types/ocr.ts @@ -6,6 +6,7 @@ import { ResourceSource } from './common'; * OCRDetection represents a single detected text instance in an image, * including its bounding box, recognized text, and confidence score. * + * @category Types * @property {Point[]} bbox - An array of points defining the bounding box around the detected text. * @property {string} text - The recognized text within the bounding box. * @property {number} score - The confidence score of the OCR detection, ranging from 0 to 1. @@ -19,6 +20,7 @@ export interface OCRDetection { /** * Point represents a coordinate in 2D space. * + * @category Types * @property {number} x - The x-coordinate of the point. * @property {number} y - The y-coordinate of the point. */ @@ -29,6 +31,8 @@ export interface Point { /** * Configuration properties for the `useOCR` hook. + * + * @category Types */ export interface OCRProps { /** @@ -60,6 +64,8 @@ export interface OCRProps { /** * Configuration properties for the `useVerticalOCR` hook. + * + * @category Types */ export interface VerticalOCRProps extends OCRProps { /** @@ -72,6 +78,8 @@ export interface VerticalOCRProps extends OCRProps { /** * Return type for the `useOCR` hook. * Manages the state and operations for Optical Character Recognition (OCR). + * + * @category Types */ export interface OCRType { /** @@ -105,5 +113,7 @@ export interface OCRType { /** * Enumeration of supported OCR languages based on available symbol sets. + * + * @category Types */ export type OCRLanguage = keyof typeof symbols; diff --git a/packages/react-native-executorch/src/types/stt.ts b/packages/react-native-executorch/src/types/stt.ts index 233b51ac5..974f779ad 100644 --- a/packages/react-native-executorch/src/types/stt.ts +++ b/packages/react-native-executorch/src/types/stt.ts @@ -3,6 +3,8 @@ import { RnExecutorchError } from '../errors/errorUtils'; /** * React hook for managing Speech to Text (STT) instance. + * + * @category Types */ export interface SpeechToTextType { /** @@ -83,7 +85,11 @@ export interface SpeechToTextType { streamStop(): void; } -// Languages supported by whisper (not whisper.en) +/** + * Languages supported by whisper (not whisper.en) + * + * @category Types + */ export type SpeechToTextLanguage = | 'af' | 'sq' @@ -164,6 +170,7 @@ export type SpeechToTextLanguage = /** * Options for decoding speech to text. * + * @category Types * @property {SpeechToTextLanguage} [language] - Optional language code to guide the transcription. */ export interface DecodingOptions { @@ -172,6 +179,8 @@ export interface DecodingOptions { /** * Configuration for Speech to Text model. + * + * @category Types */ export interface SpeechToTextModelConfig { /** diff --git a/packages/react-native-executorch/src/types/styleTransfer.ts b/packages/react-native-executorch/src/types/styleTransfer.ts index 9eb74a65b..49e11c91a 100644 --- a/packages/react-native-executorch/src/types/styleTransfer.ts +++ b/packages/react-native-executorch/src/types/styleTransfer.ts @@ -4,6 +4,7 @@ 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 {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. @@ -16,6 +17,8 @@ export interface StyleTransferProps { /** * Return type for the `useStyleTransfer` hook. * Manages the state and operations for applying artistic style transfer to images. + * + * @category Types */ export interface StyleTransferType { /** diff --git a/packages/react-native-executorch/src/types/textEmbeddings.ts b/packages/react-native-executorch/src/types/textEmbeddings.ts index 3e8892c51..ff062cabc 100644 --- a/packages/react-native-executorch/src/types/textEmbeddings.ts +++ b/packages/react-native-executorch/src/types/textEmbeddings.ts @@ -3,6 +3,8 @@ import { ResourceSource } from '../types/common'; /** * React hook state and methods for managing a Text Embeddings model instance. + * + * @category Types */ export interface TextEmbeddingsType { /** @@ -37,6 +39,7 @@ export interface TextEmbeddingsType { /** * Props for the useTextEmbeddings hook. * + * @category Types * @property {Object} model - An object containing the model and tokenizer sources. * @property {ResourceSource} model.modelSource - The source of the text embeddings model binary. * @property {ResourceSource} model.tokenizerSource - The source of the tokenizer JSON file. diff --git a/packages/react-native-executorch/src/types/tokenizer.ts b/packages/react-native-executorch/src/types/tokenizer.ts index 5afdbb258..924cd9672 100644 --- a/packages/react-native-executorch/src/types/tokenizer.ts +++ b/packages/react-native-executorch/src/types/tokenizer.ts @@ -2,6 +2,8 @@ import { RnExecutorchError } from '../errors/errorUtils'; /** * React hook state and methods for managing a Tokenizer instance. + * + * @category Types */ export interface TokenizerType { /** diff --git a/packages/react-native-executorch/src/types/tti.ts b/packages/react-native-executorch/src/types/tti.ts index bf434c987..65ef827a1 100644 --- a/packages/react-native-executorch/src/types/tti.ts +++ b/packages/react-native-executorch/src/types/tti.ts @@ -3,6 +3,8 @@ import { ResourceSource } from '../types/common'; /** * Configuration properties for the `useTextToImage` hook. + * + * @category Types */ export interface TextToImageParams { /** @@ -38,6 +40,8 @@ export interface TextToImageParams { /** * Return type for the `useTextToImage` hook. * Manages the state and operations for generating images from text prompts using a diffusion model pipeline. + * + * @category Types */ export interface TextToImageType { /** diff --git a/packages/react-native-executorch/src/types/tts.ts b/packages/react-native-executorch/src/types/tts.ts index 8ab666fe3..e253c469f 100644 --- a/packages/react-native-executorch/src/types/tts.ts +++ b/packages/react-native-executorch/src/types/tts.ts @@ -1,7 +1,11 @@ import { ResourceSource } from './common'; import { RnExecutorchError } from '../errors/errorUtils'; -// List all the languages available in TTS models (as lang shorthands) +/** + * List all the languages available in TTS models (as lang shorthands) + * + * @category Types + */ export type TextToSpeechLanguage = | 'en-us' // American English | 'en-gb'; // British English @@ -11,6 +15,7 @@ export type TextToSpeechLanguage = * * So far in Kokoro, each voice is directly associated with a language. * + * @category Types * @property {TextToSpeechLanguage} lang - speaker's language * @property {ResourceSource} voiceSource - a source to a binary file with voice embedding * @property {KokoroVoiceExtras} [extra] - an optional extra sources or properties related to specific voice @@ -24,6 +29,7 @@ export interface VoiceConfig { /** * Kokoro-specific voice extra props * + * @category Types * @property {ResourceSource} taggerSource - source to Kokoro's tagger model binary * @property {ResourceSource} lexiconSource - source to Kokoro's lexicon binary */ @@ -36,6 +42,7 @@ export interface KokoroVoiceExtras { * Kokoro model configuration. * Only the core Kokoro model sources, as phonemizer sources are included in voice configuration. * + * @category Types * @property {'kokoro'} type - model type identifier * @property {ResourceSource} durationPredictorSource - source to Kokoro's duration predictor model binary * @property {ResourceSource} synthesizerSource - source to Kokoro's synthesizer model binary @@ -49,6 +56,7 @@ export interface KokoroConfig { /** * General Text to Speech module configuration * + * @category Types * @property {KokoroConfig} model - a selected T2S model * @property {VoiceConfig} voice - a selected speaker's voice * @property {KokoroOptions} [options] - a completely optional model-specific configuration @@ -61,6 +69,7 @@ export interface TextToSpeechConfig { /** * Props for the useTextToSpeech hook. * + * @category Types * @extends TextToSpeechConfig * * @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. @@ -72,6 +81,7 @@ export interface TextToSpeechProps extends TextToSpeechConfig { /** * Text to Speech module input definition * + * @category Types * @property {string} text - a text to be spoken * @property {number} [speed] - optional speed argument - the higher it is, the faster the speech becomes */ @@ -83,6 +93,8 @@ export interface TextToSpeechInput { /** * Return type for the `useTextToSpeech` hook. * Manages the state and operations for Text-to-Speech generation. + * + * @category Types */ export interface TextToSpeechType { /** @@ -135,6 +147,8 @@ export interface TextToSpeechType { * executed at given moments of the streaming. * Actions such as playing the audio should happen within the onNext callback. * Callbacks can be both synchronous or asynchronous. + * + * @category Types * @property {() => void | Promise} [onBegin] - Called when streaming begins * @property {(audio: Float32Array) => void | Promise} [onNext] - Called after each audio chunk gets calculated. * @property {() => void | Promise} [onEnd] - Called when streaming ends diff --git a/packages/react-native-executorch/src/types/vad.ts b/packages/react-native-executorch/src/types/vad.ts index 0d0d36fb7..68b1b5526 100644 --- a/packages/react-native-executorch/src/types/vad.ts +++ b/packages/react-native-executorch/src/types/vad.ts @@ -4,6 +4,7 @@ import { RnExecutorchError } from '../errors/errorUtils'; /** * Props for the useVAD hook. * + * @category Types * @property {Object} model - An object containing the model source. * @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. @@ -16,6 +17,7 @@ export interface VADProps { /** * Represents a detected audio segment with start and end timestamps. * + * @category Types * @property {number} start - Start time of the segment in seconds. * @property {number} end - End time of the segment in seconds. */ @@ -26,6 +28,8 @@ export interface Segment { /** * React hook state and methods for managing a Voice Activity Detection (VAD) model instance. + * + * @category Types */ export interface VADType { /** diff --git a/packages/react-native-executorch/src/utils/ResourceFetcher.ts b/packages/react-native-executorch/src/utils/ResourceFetcher.ts index 8e733e1ce..30f4e28e5 100644 --- a/packages/react-native-executorch/src/utils/ResourceFetcher.ts +++ b/packages/react-native-executorch/src/utils/ResourceFetcher.ts @@ -54,9 +54,23 @@ import { import { RnExecutorchErrorCode } from '../errors/ErrorCodes'; import { RnExecutorchError } from '../errors/errorUtils'; +/** + * This module provides functions to download and work with downloaded files stored in the application's document directory inside the `react-native-executorch/` directory. + * These utilities can help you manage your storage and clean up the downloaded files when they are no longer needed. + * + * @category Utilities - General + */ export class ResourceFetcher { static downloads = new Map(); //map of currently downloading (or paused) files, if the download was started by .fetch() method. + /** + * Fetches resources (remote URLs, local files or embedded assets), downloads or stores them locally for use by React Native ExecuTorch. + * + * @param callback - Optional callback to track progress of all downloads, reported between 0 and 1. + * @param sources - Multiple resources that can be strings, asset references, or objects. + * @returns If the fetch was successful, it returns a promise which resolves to an array of local file paths for the downloaded/stored resources (without file:// prefix). + * If the fetch was interrupted by `pauseFetching` or `cancelFetching`, it returns a promise which resolves to `null`. + */ static async fetch( callback: (downloadProgress: number) => void = () => {}, ...sources: ResourceSource[] @@ -238,16 +252,35 @@ export class ResourceFetcher { this.downloads.delete(source); } + /** + * Pauses an ongoing download of files. + * + * @param sources - The resource identifiers used when calling `fetch`. + * @returns A promise that resolves once the download is paused. + */ static async pauseFetching(...sources: ResourceSource[]) { const source = this.findActive(sources); await this.pause(source); } + /** + * Resumes a paused download of files. + * + * @param sources - The resource identifiers used when calling fetch. + * @returns If the fetch was successful, it returns a promise which resolves to an array of local file paths for the downloaded resources (without file:// prefix). + * If the fetch was again interrupted by `pauseFetching` or `cancelFetching`, it returns a promise which resolves to `null`. + */ static async resumeFetching(...sources: ResourceSource[]) { const source = this.findActive(sources); await this.resume(source); } + /** + * Cancels an ongoing/paused download of files. + * + * @param sources - The resource identifiers used when calling `fetch()`. + * @returns A promise that resolves once the download is canceled. + */ static async cancelFetching(...sources: ResourceSource[]) { const source = this.findActive(sources); await this.cancel(source); @@ -265,16 +298,32 @@ export class ResourceFetcher { ); } + /** + * Lists all the downloaded files used by React Native ExecuTorch. + * + * @returns A promise, which resolves to an array of URIs for all the downloaded files. + */ static async listDownloadedFiles() { const files = await readDirectoryAsync(RNEDirectory); return files.map((file) => `${RNEDirectory}${file}`); } + /** + * Lists all the downloaded models used by React Native ExecuTorch. + * + * @returns A promise, which resolves to an array of URIs for all the downloaded models. + */ static async listDownloadedModels() { const files = await this.listDownloadedFiles(); return files.filter((file) => file.endsWith('.pte')); } + /** + * Deletes downloaded resources from the local filesystem. + * + * @param sources - The resource identifiers used when calling `fetch`. + * @returns A promise that resolves once all specified resources have been removed. + */ static async deleteResources(...sources: ResourceSource[]) { for (const source of sources) { const filename = ResourceFetcherUtils.getFilenameFromUri( @@ -287,6 +336,12 @@ export class ResourceFetcher { } } + /** + * Fetches the info about files size. Works only for remote files. + * + * @param sources - The resource identifiers (URLs). + * @returns A promise that resolves to combined size of files in bytes. + */ static async getFilesTotalSize(...sources: ResourceSource[]) { return (await ResourceFetcherUtils.getFilesSizes(sources)).totalLength; } diff --git a/packages/react-native-executorch/src/utils/llm.ts b/packages/react-native-executorch/src/utils/llm.ts index 146c91770..476f0edd1 100644 --- a/packages/react-native-executorch/src/utils/llm.ts +++ b/packages/react-native-executorch/src/utils/llm.ts @@ -6,6 +6,13 @@ import { DEFAULT_STRUCTURED_OUTPUT_PROMPT } from '../constants/llmDefaults'; import * as zCore from 'zod/v4/core'; import { Logger } from '../common/Logger'; +/** + * Parses tool calls from a given message string. + * + * @category Utilities - LLM + * @param message - The message string containing tool calls in JSON format. + * @returns An array of `ToolCall` objects extracted from the message. + */ export const parseToolCall: (message: string) => ToolCall[] = ( message: string ) => { @@ -50,6 +57,7 @@ const filterObjectKeys = (obj: object, keysToRemove: string[]) => { /** * Generates a structured output prompt based on the provided schema. * + * @category Utilities - LLM * @param responseSchema - The schema (Zod or JSON Schema) defining the desired output format. * @returns A prompt string instructing the model to format its output according to the given schema. */ @@ -86,6 +94,7 @@ const extractBetweenBrackets = (text: string): string => { /** * Fixes and validates structured output from LLMs against a provided schema. * + * @category Utilities - LLM * @param output - The raw output string from the LLM. * @param responseSchema - The schema (Zod or JSON Schema) to validate the output against. * @returns The validated and parsed output.