React Native ExecuTorch

https://github.com/software-mansion/react-native-executorch
Admin
React Native ExecuTorch provides a declarative way to run AI models on-device using React Native,...
Tokens:26,237
Snippets:235
Trust Score:9.7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install the adapter and native dependencies

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/bare-resource-fetcher/README.md

Install the bare resource fetcher and its required native libraries. Complete the native setup guides for @dr.pogodin/react-native-fs and @kesha-antonov/react-native-background-downloader before using the adapter.

```bash
yarn add react-native-executorch-bare-resource-fetcher
yarn add @dr.pogodin/react-native-fs @kesha-antonov/react-native-background-downloader

```

--------------------------------

### Install Dependencies

Source: https://github.com/software-mansion/react-native-executorch/blob/main/docs/README.md

Navigate to the docs directory and install the required dependencies.

```bash
cd docs
yarn install
```

--------------------------------

### Install with yarn

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/expo-resource-fetcher/README.md

Install the adapter and its dependencies expo-file-system and expo-asset using yarn.

```bash
yarn add react-native-executorch-expo-resource-fetcher
yarn add expo-file-system expo-asset
```

--------------------------------

### Install iOS pods

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch-webrtc/README.md

Run pod install in the iOS directory after installing the package.

```bash
cd ios && pod install
```

--------------------------------

### Start Development Server

Source: https://github.com/software-mansion/react-native-executorch/blob/main/docs/README.md

Start the development server. This command automatically generates the API reference from the TypeScript source.

```bash
yarn start
```

--------------------------------

### Delete legacy example app directory

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Removes the entire legacy example app directory.

```bash
rm -rf apps/legacy
```

--------------------------------

### Install react-native-executorch-webrtc with yarn

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch-webrtc/README.md

Install the package using yarn. Requires peer dependencies: @fishjam-cloud/react-native-client, @fishjam-cloud/react-native-webrtc, and react-native-executorch.

```bash
yarn add react-native-executorch-webrtc
```

--------------------------------

### Install React Native ExecuTorch dependencies

Source: https://github.com/software-mansion/react-native-executorch/blob/main/README.md

Install the library along with its required peer dependencies using your preferred package manager.

```bash
npm install react-native-executorch react-native-worklets react-native-blob-util
# or
yarn add react-native-executorch react-native-worklets react-native-blob-util
# or
pnpm add react-native-executorch react-native-worklets react-native-blob-util
```

--------------------------------

### Installing OpenCV Dependencies

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/README.md

Commands to install required OpenCV modules on macOS and Debian/Ubuntu systems.

```bash
brew install opencv                                          # macOS
apt-get install libopencv-core-dev libopencv-imgproc-dev     # Debian/Ubuntu
```

--------------------------------

### Post-removal verification commands

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Run yarn install, prepare, typecheck, test, and lint to confirm the clean repository builds and passes all checks.

```bash
# 1. Re-link workspace dependencies
yarn install

# 2. Build bundles
yarn prepare

# 3. Typecheck
yarn typecheck

# 4. Run test suites
yarn workspace react-native-executorch test

# 5. Lint
yarn lint
```

--------------------------------

### Register and execute a model in tests

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/__tests__/README.md

Example of registering a model with the fake JSI and executing a classification task.

```ts
fakeJsi.registerModel('/models/classifier.pte', {
  schema: exported(method('forward', [f32(1, 3, 4, 4)], [f32(1, 3)])),
  execute: writesOutputs([1, 0, 2]),
});

const classifier = tracked(await createClassifier(config));
expect((await classifier.classify(imageBuffer(8, 8))).map((r) => r.label))
  .toEqual(['bird', 'cat', 'dog']);
```

--------------------------------

### Evaluate JavaScript in C++ Test

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/README.md

Example of driving the production module from JavaScript within a C++ test environment using evalNumberArray.

```cpp
auto result = evalNumberArray(R"(
    const t = __rnexecutorch_jsi__.createTensor([2, 2], 'float32');
    t.setData(new Float32Array([1.5, -2.5, 3.0, 4.25]));
    ...
)");
```

--------------------------------

### Delete bare-resource-fetcher package

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Removes the standalone bare-resource-fetcher package, which only exists for legacy example apps.

```bash
rm -rf packages/bare-resource-fetcher
```

--------------------------------

### Use useBackgroundBlur with Fishjam SDK

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch-webrtc/README.md

Example of using useBackgroundBlur to create a blur middleware and pass it to useCamera. The modelUri points to a .pte file, and blurRadius is set to 15. The middleware is conditionally applied based on blurEnabled state.

```tsx
import { useBackgroundBlur } from 'react-native-executorch-webrtc';
import { useCamera } from '@fishjam-cloud/react-native-client';

function VideoCall() {
  const [blurEnabled, setBlurEnabled] = useState(true);

  const { blurMiddleware } = useBackgroundBlur({
    // NOTE: you can use React Native Executorch's Resource Fetcher to download model files
    modelUri: 'file:///path/to/selfie_segmenter.pte',
    blurRadius: 15,
  });

  const { toggleCamera } = useCamera({
    cameraTrackMiddleware: blurEnabled ? blurMiddleware : undefined,
  });

  return (
    <Button
      title={blurEnabled ? 'Disable Blur' : 'Enable Blur'}
      onPress={() => setBlurEnabled(!blurEnabled)}
    />
  );
}
```

--------------------------------

### Delete expo-resource-fetcher package

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Removes the standalone expo-resource-fetcher package, which only exists for legacy example apps.

```bash
rm -rf packages/expo-resource-fetcher
```

--------------------------------

### Dynamically update blurRadius

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch-webrtc/README.md

Shows that blurRadius can be updated dynamically without reinitializing the hook. The example passes modelUri and blurRadius as variables.

```tsx
const { blurMiddleware } = useBackgroundBlur({
  modelUri: modelPath,
  blurRadius: intensity,
});
```

--------------------------------

### Create Documentation Version

Source: https://github.com/software-mansion/react-native-executorch/blob/main/docs/README.md

Snapshot the current documentation for a new release version.

```bash
yarn docs:version 1.0.0
```

--------------------------------

### Provisioning and Running Native Tests

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/README.md

Commands to download dependencies, initialize submodules, build test dependencies, and execute the test runner.

```bash
# 1. ExecuTorch/OpenCV/tokenizer headers (shared with clang-tidy and clangd).
#    The release is resolved from `nativeLibsVersion` in package.json.
RNET_HEADERS_ONLY=1 node scripts/download-libs.js

# 2. The submodules the tests compile. phonemis' `data/` is Git LFS and nothing
#    here reads it, so the checkout skips it.
git submodule update --init --depth 1 ../../third-party/googletest
GIT_LFS_SKIP_SMUDGE=1 git submodule update --init --depth 1 third-party/common/phonemis

# 3. Hermes + a minimal ExecuTorch host build (several minutes, cached afterwards)
scripts/build-native-test-deps.sh

# 4. Build and run (also fetches the fixtures, see below)
scripts/run-native-tests.sh
scripts/run-native-tests.sh -R MathOpsTest   # extra args go to ctest
```

--------------------------------

### Deploy with SSH

Source: https://github.com/software-mansion/react-native-executorch/blob/main/docs/README.md

Deploy the website using SSH.

```bash
$ USE_SSH=true yarn deploy
```

--------------------------------

### Build Production Files

Source: https://github.com/software-mansion/react-native-executorch/blob/main/docs/README.md

Build the static files for production. The output is generated in the build/ directory.

```bash
yarn build
```

--------------------------------

### Initialize with ExpoResourceFetcher

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/expo-resource-fetcher/README.md

Import initExecutorch and ExpoResourceFetcher, then pass the fetcher to the initializer so resource loading uses Expo's filesystem adapter.

```typescript
import { initExecutorch } from 'react-native-executorch';
import { ExpoResourceFetcher } from 'react-native-executorch-expo-resource-fetcher';

initExecutorch({
  resourceFetcher: ExpoResourceFetcher,
});
```

--------------------------------

### Create a development branch

Source: https://github.com/software-mansion/react-native-executorch/blob/main/CONTRIBUTING.md

Command to create and switch to a new branch for your changes.

```bash
git checkout -b a-descriptive-name-for-my-changes
```

--------------------------------

### Configure System Include Directories

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Adds third-party headers as SYSTEM to suppress warnings and manage include precedence.

```cmake
target_include_directories(rne_under_test SYSTEM PUBLIC
  "${INCLUDE_DIR}"
  "${INCLUDE_DIR}/executorch/extension/llm/tokenizers/include"
  "${INCLUDE_DIR}/executorch/extension/llm/tokenizers/third-party/json/include"
  "${INCLUDE_DIR}/executorch/extension/llm/tokenizers/third-party/re2"
  "${INCLUDE_DIR}/executorch/extension/llm/tokenizers/third-party/abseil-cpp")
```

--------------------------------

### Set project include directories

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Configures the include paths for the main project, including LLM tokenizer dependencies.

```cmake
target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE
    ${CPP_DIR}
    ${INCLUDE_DIR}
    ${INCLUDE_DIR}/executorch/extension/llm/tokenizers/include
    ${INCLUDE_DIR}/executorch/extension/llm/tokenizers/third-party/json/include
    ${INCLUDE_DIR}/executorch/extension/llm/tokenizers/third-party/re2
    ${INCLUDE_DIR}/executorch/extension/llm/tokenizers/third-party/abseil-cpp
)
```

--------------------------------

### Clone and configure remote

Source: https://github.com/software-mansion/react-native-executorch/blob/main/CONTRIBUTING.md

Commands to clone your fork and add the base repository as an upstream remote.

```bash
git clone git@github.com:<your Github handle>/react-native-executorch.git
cd react-native-executorch
git remote add upstream https://github.com/software-mansion/react-native-executorch.git
```

--------------------------------

### Configure OpenCV static libraries

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Sets up the list of static OpenCV libraries to link if RNE_ENABLE_OPENCV is enabled, including architecture-specific third-party libraries for arm64-v8a.

```cmake
set(OPENCV_LINK_LIBS "")
if(RNE_ENABLE_OPENCV)
  set(OPENCV_LINK_LIBS
    "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_core.a"
    "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_features2d.a"
    "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_highgui.a"
    "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_imgproc.a"
    "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_photo.a"
    "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_video.a"
  )
  if(ANDROID_ABI STREQUAL "arm64-v8a")
    list(APPEND OPENCV_LINK_LIBS
      "${LIBS_DIR}/opencv-third-party/${ANDROID_ABI}/libkleidicv_hal.a"
      "${LIBS_DIR}/opencv-third-party/${ANDROID_ABI}/libkleidicv_thread.a"
      "${LIBS_DIR}/opencv-third-party/${ANDROID_ABI}/libkleidicv.a"
    )
  endif()
endif()
```

--------------------------------

### Change prepare script in package.json

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Change the 'prepare' script from 'bob build && tsc -p legacy/tsconfig.json' to 'bob build'.

```json
"prepare": "bob build && tsc -p legacy/tsconfig.json"
```

```json
"prepare": "bob build"
```

--------------------------------

### Define Test Source Files

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Collects source files from various extension directories and manages conditional inclusion of phonemizer sources.

```cmake
file(GLOB CORE_SOURCES   "${CPP_DIR}/core/*.cpp")
file(GLOB MATH_SOURCES   "${CPP_DIR}/extensions/math/*.cpp")
file(GLOB NLP_SOURCES    "${CPP_DIR}/extensions/nlp/*.cpp")
file(GLOB SPEECH_SOURCES "${CPP_DIR}/extensions/speech/*.cpp")
file(GLOB LLM_SOURCES    "${CPP_DIR}/extensions/llm/*.cpp")
file(GLOB OPENCV_SOURCES "${CPP_DIR}/extensions/cv/*.cpp")

# phonemizer.cpp is the one speech source gated on phonemis, exactly as in
# android/CMakeLists.txt.
set(PHONEMIS_SOURCES "${CPP_DIR}/extensions/speech/phonemizer.cpp")
list(FILTER SPEECH_SOURCES EXCLUDE REGEX "/phonemizer\\.cpp$")

set(RNE_SOURCES
  "${CPP_DIR}/RnExecutorch.cpp"
  ${CORE_SOURCES} ${MATH_SOURCES} ${NLP_SOURCES} ${SPEECH_SOURCES} ${LLM_SOURCES})
```

--------------------------------

### Configure legacy support include paths

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Adds include directories for legacy headers, intended for removal in future versions.

```cmake
target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE
    ${LEGACY_CPP_DIR}
    ${LEGACY_ANDROID_DIR}
)
```

--------------------------------

### Define and Configure Test Suites

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Defines the base list of test files and conditionally appends additional suites based on build flags like RNE_TESTS_ENABLE_OPENCV, RNE_TESTS_ENABLE_PHONEMIS, RNE_HAVE_MODEL_FIXTURE, and RNE_HAVE_TOKENIZER_FIXTURE.

```cmake
set(TEST_SUITES
  core/DTypeTest.cpp
  core/ErrorTest.cpp
  core/ConversionsTest.cpp
  core/TensorTest.cpp
  core/SchemaTest.cpp
  core/UtilsTest.cpp
  extensions/MathOpsTest.cpp
  extensions/SpeechOpsTest.cpp
  extensions/LlmRunnerTest.cpp)

if(RNE_TESTS_ENABLE_OPENCV)
  list(APPEND TEST_SUITES extensions/CvOpsTest.cpp extensions/OcrOpsTest.cpp)
endif()

if(RNE_TESTS_ENABLE_PHONEMIS)
  list(APPEND TEST_SUITES extensions/PhonemizerTest.cpp)
endif()

if(RNE_HAVE_MODEL_FIXTURE)
  list(APPEND TEST_SUITES core/ModelTest.cpp)
endif()

if(RNE_HAVE_TOKENIZER_FIXTURE)
  list(APPEND TEST_SUITES extensions/TokenizerTest.cpp)
endif()
```

--------------------------------

### Run Jest test suites

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/__tests__/README.md

Commands to execute the test suites for the react-native-executorch workspace.

```bash
yarn workspace react-native-executorch test
yarn workspace react-native-executorch test --watch
yarn workspace react-native-executorch test __tests__/tasks   # one directory
```

--------------------------------

### Check for leftover legacy markers

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Run git grep "LEGACY SUPPORT" to ensure no legacy markers remain. Should return 0 results.

```bash
git grep "LEGACY SUPPORT"
```

--------------------------------

### Initialize with BareResourceFetcher

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/bare-resource-fetcher/README.md

Configure the executorch runtime to use the BareResourceFetcher as the resourceFetcher. This passes the fetcher to initExecutorch for resource loading in bare React Native projects.

```typescript
import { initExecutorch } from 'react-native-executorch';
import { BareResourceFetcher } from 'react-native-executorch-bare-resource-fetcher';

initExecutorch({
  resourceFetcher: BareResourceFetcher,
});

```

--------------------------------

### Link Optional Backends and Phonemis

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Conditionally links Phonemis, XNNPACK, or Vulkan backends based on build flags.

```cmake
if(RNE_ENABLE_PHONEMIS)
  target_link_libraries(${CMAKE_PROJECT_NAME} phonemis)
endif()

# Linking against the backend .so (when enabled) makes Gradle bundle them and
# instructs the dynamic linker to load them with libreact-native-executorch.so.
if(RNE_ENABLE_XNNPACK)
  target_link_libraries(${CMAKE_PROJECT_NAME} xnnpack_executorch_backend)
endif()
if(RNE_ENABLE_VULKAN)
  target_link_libraries(${CMAKE_PROJECT_NAME} vulkan_executorch_backend)
endif()
```

--------------------------------

### Run an LLM model with useLLMChatSession

Source: https://github.com/software-mansion/react-native-executorch/blob/main/README.md

Use the useLLMChatSession hook to load a model and send messages for on-device text generation.

```tsx
import { Button, View } from 'react-native';
import { models, useLLMChatSession } from 'react-native-executorch';

export function App() {
  const session = useLLMChatSession(models.llm.LFM2_5_1_2B.DEFAULT);

  const handleGenerate = async () => {
    if (!session.isReady || !session.sendMessage) return;

    const turn = await session.sendMessage(
      'Explain on-device AI in one sentence.',
      (token) => console.log(token)
    );

    console.log('Result messages:', turn.messages);
  };

  return (
    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
      <Button
        title={session.isReady ? 'Generate' : `Loading (${session.downloadProgress.toFixed(0)}%)`}
        onPress={handleGenerate}
        disabled={!session.isReady}
      />
    </View>
  );
}
```

--------------------------------

### Import Vulkan backend

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Conditionally imports the Vulkan backend library if RNE_ENABLE_VULKAN is set.

```cmake
if(RNE_ENABLE_VULKAN)
  add_library(vulkan_executorch_backend SHARED IMPORTED)
  set_target_properties(vulkan_executorch_backend PROPERTIES
      IMPORTED_LOCATION "${LIBS_DIR}/executorch/${ANDROID_ABI}/libvulkan_executorch_backend.so")
endif()
```

--------------------------------

### Import ExecuTorch core library

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Defines the shared library for the ExecuTorch core, which is required for all builds.

```cmake
add_library(executorch SHARED IMPORTED)
set_target_properties(executorch PROPERTIES
    IMPORTED_LOCATION "${LIBS_DIR}/executorch/${ANDROID_ABI}/libexecutorch.so")
```

--------------------------------

### Verify modified files against rne-rewrite

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Run git diff --exit-code against origin/rne-rewrite for the listed configuration and build files. Must return zero diff. Also check overall branch diff with git diff --stat.

```bash
# Verify modified configuration/build files are identical to rne-rewrite (must return 0 diff):
git diff --exit-code origin/rne-rewrite -- \
  package.json \
  .gitignore \
  .eslintrc.js \
  packages/react-native-executorch/package.json \
  packages/react-native-executorch/tsconfig.json \
  packages/react-native-executorch/tsconfig.build.json \
  packages/react-native-executorch/react-native-executorch.podspec \
  packages/react-native-executorch/android/CMakeLists.txt \
  packages/react-native-executorch/android/src/main/java/com/swmansion/rnexecutorch/RnExecutorchPackage.kt

# Check overall branch diff (should only show newly added docs or subsequent bugfixes):
git diff --stat origin/rne-rewrite
```

--------------------------------

### Link Legacy Support Libraries

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Links legacy dependencies required for ETInstallerModule, including fbjni and reactnative.

```cmake
# ==============================================================================
# LEGACY SUPPORT: link fbjni, reactnative (for CallInvoker), and android for legacy ETInstallerModule
# (Remove when react-native-executorch/legacy is dropped)
# ==============================================================================
target_link_libraries(${CMAKE_PROJECT_NAME}
    ReactAndroid::reactnative
    fbjni::fbjni
    android
)
# ==============================================================================
```

--------------------------------

### Configure Phonemis for rne_under_test

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Sets compile definitions, include directories, and links the phonemis library when enabled.

```cmake
target_compile_definitions(rne_under_test PUBLIC RNE_ENABLE_PHONEMIS)
  target_include_directories(rne_under_test PUBLIC "${PHONEMIS_DIR}/src")
  target_link_libraries(rne_under_test PUBLIC phonemis)
endif()
```

--------------------------------

### Run clang-tidy checks

Source: https://github.com/software-mansion/react-native-executorch/blob/main/CONTRIBUTING.md

Commands to execute static analysis checks on C++ sources using yarn workspaces. The second command allows specifying a custom path to the clang-tidy binary.

```bash
yarn workspace react-native-executorch lint:cpp           # all C++ sources
CLANG_TIDY=$(brew --prefix llvm)/bin/clang-tidy yarn workspace react-native-executorch lint:cpp
```

--------------------------------

### Import XNNPACK backend

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Conditionally imports the XNNPACK backend library if RNE_ENABLE_XNNPACK is set.

```cmake
if(RNE_ENABLE_XNNPACK)
  add_library(xnnpack_executorch_backend SHARED IMPORTED)
  set_target_properties(xnnpack_executorch_backend PROPERTIES
      IMPORTED_LOCATION "${LIBS_DIR}/executorch/${ANDROID_ABI}/libxnnpack_executorch_backend.so")
endif()
```

--------------------------------

### Register Test Executables

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Iterates over the TEST_SUITES list to create executables, link them with test support libraries, and register them with gtest_discover_tests.

```cmake
foreach(suite_path IN LISTS TEST_SUITES)
  get_filename_component(suite_name "${suite_path}" NAME_WE)
  add_executable(${suite_name} "${suite_path}")
  # re2/abseil come in transitively via et_tokenizers, which places them after
  # their consumer — see the note by TOKENIZER_DEP_LIBS.
  target_link_libraries(${suite_name} PRIVATE rne_test_support gtest_main)
  gtest_discover_tests(${suite_name} DISCOVERY_TIMEOUT 60)
endforeach()
```

--------------------------------

### Deploy without SSH

Source: https://github.com/software-mansion/react-native-executorch/blob/main/docs/README.md

Deploy the website without using SSH by specifying the GitHub username.

```bash
$ GIT_USER=<Your GitHub username> yarn deploy
```

--------------------------------

### ExecuTorch library imports

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Imports for core ExecuTorch libraries, extensions, and LLM-related components using the rne_import_et_lib function.

```cmake
rne_import_et_lib(et_core "" executorch_core)
rne_import_et_lib(et_full "" executorch)
rne_import_et_lib(et_tensor "extension/tensor" extension_tensor)
rne_import_et_lib(et_module "extension/module" extension_module_static extension_module)
rne_import_et_lib(et_data_loader "extension/data_loader" extension_data_loader)
rne_import_et_lib(et_flat_tensor "extension/flat_tensor" extension_flat_tensor)
rne_import_et_lib(et_named_data_map "extension/named_data_map" extension_named_data_map)
rne_import_et_lib(et_tokenizers "extension/llm/tokenizers" tokenizers)

# The llm extension wraps ExecuTorch's LLM runner, which pulls in the sampler,
# the memory allocator and the portable-kernel utilities it shares with them.
rne_import_et_lib(et_llm_runner "extension/llm/runner" extension_llm_runner)
rne_import_et_lib(et_llm_sampler "extension/llm/sampler" extension_llm_sampler)
rne_import_et_lib(et_memory_allocator "extension/memory_allocator" extension_memory_allocator)
rne_import_et_lib(et_kernels_util "kernels/portable/cpu/util" kernels_util_all_deps)
```

--------------------------------

### Update fork from upstream

Source: https://github.com/software-mansion/react-native-executorch/blob/main/CONTRIBUTING.md

Commands to fetch and rebase your local branch with the main upstream repository.

```bash
git fetch upstream
git rebase upstream/main
```

--------------------------------

### Link OpenMP and Core Libraries

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Configures linker options for OpenMP and links essential libraries including JSI and ExecuTorch.

```cmake
# libexecutorch.so references OpenMP runtime symbols (optimized kernels). Link
# the static OpenMP runtime into libRnExecutorch.so to resolve them.
target_link_options(${CMAKE_PROJECT_NAME} PRIVATE -fopenmp -static-openmp)

target_link_libraries(${CMAKE_PROJECT_NAME}
    ReactAndroid::jsi
    log
    ${OPENCV_LINK_LIBS}
    executorch
    z
)
```

--------------------------------

### Set Include Directories for rne_under_test

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Adds the CPP directory to the include path.

```cmake
target_include_directories(rne_under_test PUBLIC "${CPP_DIR}")
```

--------------------------------

### Push changes to remote

Source: https://github.com/software-mansion/react-native-executorch/blob/main/CONTRIBUTING.md

Command to push your local branch to your remote fork.

```bash
git push -u origin a-descriptive-name-for-my-changes
```

--------------------------------

### Configure Tokenizer Linker Groups

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Configures linker groups for tokenizer dependencies to resolve reference cycles, specifically excluding Apple platforms which do not support the GNU ld --start-group flag.

```cmake
set(TOKENIZER_DEP_LIBS ${ET_TOKENIZER_LIBS} ${ET_ABSEIL_LIBS} ${ET_SENTENCEPIECE_LIBS})
if(NOT APPLE AND TOKENIZER_DEP_LIBS)
  set(TOKENIZER_DEP_LIBS "-Wl,--start-group" ${TOKENIZER_DEP_LIBS} "-Wl,--end-group")
endif()
set_property(TARGET et_tokenizers APPEND PROPERTY
  INTERFACE_LINK_LIBRARIES ${TOKENIZER_DEP_LIBS})
```

--------------------------------

### Clear Cache

Source: https://github.com/software-mansion/react-native-executorch/blob/main/docs/README.md

Delete the .docusaurus cache and build folder to resolve duplicate ID errors.

```bash
yarn clear
```

--------------------------------

### useBackgroundBlur(options)

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch-webrtc/README.md

React hook that provides camera track middleware for background blur. It accepts an options object with modelUri and optional blurRadius, and returns a blurMiddleware function for use with Fishjam's useCamera.

```APIDOC
## useBackgroundBlur(options)

### Description
React hook that provides camera track middleware for background blur. It uses an ExecuTorch segmentation model to separate foreground from background and applies a blur effect.

### Method
Hook (React)

### Parameters
#### Options
- **modelUri** (string) - Required - Path to the ExecuTorch segmentation model (.pte file)
- **blurRadius** (number) - Optional, default: 12 - Blur intensity

### Returns
- **blurMiddleware** (TrackMiddleware) - Middleware function for use with Fishjam's useCamera

### Usage Example
```tsx
import { useBackgroundBlur } from 'react-native-executorch-webrtc';
import { useCamera } from '@fishjam-cloud/react-native-client';

function VideoCall() {
  const [blurEnabled, setBlurEnabled] = useState(true);

  const { blurMiddleware } = useBackgroundBlur({
    modelUri: 'file:///path/to/selfie_segmenter.pte',
    blurRadius: 15,
  });

  const { toggleCamera } = useCamera({
    cameraTrackMiddleware: blurEnabled ? blurMiddleware : undefined,
  });

  return (
    <Button
      title={blurEnabled ? 'Disable Blur' : 'Enable Blur'}
      onPress={() => setBlurEnabled(!blurEnabled)}
    />
  );
}
```

### Notes
- The blurRadius can be updated dynamically without reinitializing the hook.
- On iOS, uses Core Image for GPU-accelerated blur compositing.
- On Android, uses OpenGL ES shaders for blur and compositing, with OpenMP for parallel CPU operations.
```

--------------------------------

### Configure Phonemis dependency

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Conditionally adds the Phonemis subdirectory and sets necessary compile definitions and include directories when RNE_ENABLE_PHONEMIS is enabled.

```cmake
if(RNE_ENABLE_PHONEMIS)
  set(PHONEMIS_DIR "${THIRD_PARTY_DIR}/common/phonemis")
  add_subdirectory(${PHONEMIS_DIR} ${CMAKE_BINARY_DIR}/phonemis)
  # phonemis uses ET_ON to detect an available ExecuTorch build (NeuralPhonemizer).
  target_compile_definitions(phonemis PRIVATE ET_ON)
  target_include_directories(phonemis PRIVATE "${INCLUDE_DIR}")
  target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE "${PHONEMIS_DIR}/src")
endif()
```

--------------------------------

### Link CoreFoundation on Apple

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Links the CoreFoundation framework when building on Apple platforms.

```cmake
if(APPLE)
  target_link_libraries(rne_under_test PUBLIC "-framework CoreFoundation")
endif()
```

--------------------------------

### Propagate feature flags as preprocessor defines

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/android/CMakeLists.txt

Uses target_compile_definitions to pass RNE_ENABLE_OPENCV and RNE_ENABLE_PHONEMIS flags to the C++ compiler.

```cmake
if(RNE_ENABLE_OPENCV)
  target_compile_definitions(${CMAKE_PROJECT_NAME} PRIVATE RNE_ENABLE_OPENCV)
endif()
if(RNE_ENABLE_PHONEMIS)
  target_compile_definitions(${CMAKE_PROJECT_NAME} PRIVATE RNE_ENABLE_PHONEMIS)
endif()
```

--------------------------------

### Link Hermes Libraries

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Links the required Hermes host and JSI libraries along with ExecuTorch libraries.

```cmake
target_link_libraries(rne_under_test PUBLIC hermes_host hermes_jsi_host ${ET_LIBS})
```

--------------------------------

### Configure OpenCV for rne_under_test

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Sets compile definitions and links the rne_opencv library if enabled.

```cmake
if(RNE_TESTS_ENABLE_OPENCV)
  target_compile_definitions(rne_under_test PUBLIC RNE_ENABLE_OPENCV)
  target_link_libraries(rne_under_test PUBLIC rne_opencv)

```

--------------------------------

### Delete library legacy code directory

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Removes the entire legacy library code directory.

```bash
rm -rf packages/react-native-executorch/legacy
```

--------------------------------

### Delete legacy versioned docs and sidebars

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Removes legacy versioned documentation and sidebar files.

```bash
rm -rf docs/versioned_docs/version-0.10.0-legacy
rm -rf docs/versioned_sidebars/version-0.10.0-legacy-sidebars.json
```

--------------------------------

### npm dist-tag add command to move legacy tag

Source: https://github.com/software-mansion/react-native-executorch/blob/main/RELEASE.md

Adds the legacy dist-tag pointing to the previous line's highest patch version for the core package; repeat for each satellite package.

```bash
npm dist-tag add react-native-executorch@{PREV_MAJOR}.{PREV_MINOR}.{HIGHEST_PATCH} legacy
```

--------------------------------

### Remove legacy support section from .gitignore

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Remove the entire '# === LEGACY SUPPORT ===' section from the root .gitignore file.

```gitignore
apps/legacy/*/ios/
apps/legacy/*/android/
!apps/legacy/bare-rn/ios/
!apps/legacy/bare-rn/android/
```

--------------------------------

### Remove legacy source files block from podspec

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Remove the '# === LEGACY SUPPORT ===' source files block from the podspec.

```ruby
source_files += [
  "legacy/ios/**/*.{h,m,mm}",
  "legacy/cpp/**/*.{cpp,c,h,hpp}",
]
```

--------------------------------

### Remove legacy directory definitions from CMakeLists.txt

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Remove the legacy directory definitions from the Android CMakeLists.txt.

```cmake
set(LEGACY_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../legacy/cpp")
set(LEGACY_ANDROID_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../legacy/android")
```

--------------------------------

### Conditional OpenCV Test Integration

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

Invokes the rne_find_opencv function and appends OpenCV sources to the build if RNE_TESTS_ENABLE_OPENCV is enabled.

```cmake
if(RNE_TESTS_ENABLE_OPENCV)
  rne_find_opencv()
  list(APPEND RNE_SOURCES ${OPENCV_SOURCES})
endif()
```

--------------------------------

### rne_import_et_lib function definition

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

A CMake function that finds a static library in the ET_BUILD_DIR and sets it as an imported target.

```cmake
function(rne_import_et_lib target relative_path)
  find_library(${target}_LIB
    NAMES ${ARGN}
    PATHS "${ET_BUILD_DIR}/${relative_path}"
    NO_DEFAULT_PATH REQUIRED)
  add_library(${target} STATIC IMPORTED)
  set_target_properties(${target} PROPERTIES IMPORTED_LOCATION "${${target}_LIB}")
endfunction()
```

--------------------------------

### Remove legacy exclusion block from podspec

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Remove the '# === LEGACY SUPPORT ===' exclusion block from the podspec.

```ruby
exclude_files += [
  "legacy/cpp/rnexecutorch/tests/**/*",
  "legacy/cpp/rnexecutorch/jsi/*.{h,hpp}",
]
s.preserve_paths = "legacy/cpp/rnexecutorch/jsi/*.{h,hpp}"
```

--------------------------------

### rne_find_opencv CMake function

Source: https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/cpp/tests/CMakeLists.txt

This function defines the rne_opencv interface library and attempts to locate OpenCV via find_package or manual path discovery. It ensures include directories are prioritized correctly by modifying imported target properties.

```cmake
function(rne_find_opencv)
  add_library(rne_opencv INTERFACE)

  find_package(OpenCV QUIET COMPONENTS core imgproc)
  if(OpenCV_FOUND)
    message(STATUS "OpenCV: using CMake package ${OpenCV_VERSION}")
    # OpenCV's imported targets mark their include directory SYSTEM, which would
    # put it on -isystem — searched only after the vendored opencv2 headers.
    # Clearing that keeps it on -I, where it takes precedence.
    foreach(lib IN LISTS OpenCV_LIBS)
      if(TARGET ${lib})
        set_target_properties(${lib} PROPERTIES IMPORTED_NO_SYSTEM ON)
      endif()
    endforeach()
    set(RNE_OPENCV_INCLUDE_DIRS ${OpenCV_INCLUDE_DIRS} PARENT_SCOPE)
    target_link_libraries(rne_opencv INTERFACE ${OpenCV_LIBS})
    return()
  endif()

  find_path(OPENCV_INCLUDE_DIR
    NAMES opencv2/core.hpp
    PATH_SUFFIXES opencv4)
  find_library(OPENCV_CORE_LIB NAMES opencv_core)
  find_library(OPENCV_IMGPROC_LIB NAMES opencv_imgproc)

  if(NOT OPENCV_INCLUDE_DIR OR NOT OPENCV_CORE_LIB OR NOT OPENCV_IMGPROC_LIB)
    message(FATAL_ERROR
      "OpenCV (core + imgproc) not found. Install it with:\n"
      "  brew install opencv\n"
      "  apt-get install libopencv-core-dev libopencv-imgproc-dev\n"
      "or configure with -DRNE_TESTS_ENABLE_OPENCV=OFF to skip the cv suite.")
  endif()

  message(STATUS "OpenCV: using ${OPENCV_CORE_LIB}")
  set(RNE_OPENCV_INCLUDE_DIRS "${OPENCV_INCLUDE_DIR}" PARENT_SCOPE)
  target_link_libraries(rne_opencv INTERFACE "${OPENCV_CORE_LIB}" "${OPENCV_IMGPROC_LIB}")
endfunction()
```

--------------------------------

### Remove legacy header search path from podspec

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Remove the '# === LEGACY SUPPORT ===' header search path from the podspec.

```ruby
"$(PODS_TARGET_SRCROOT)/legacy/cpp",
```

--------------------------------

### Remove legacy libraries from target_link_libraries

Source: https://github.com/software-mansion/react-native-executorch/blob/main/LEGACY_REMOVAL.md

Remove the legacy libraries from the target_link_libraries in CMakeLists.txt.

```cmake
ReactAndroid::reactnative
fbjni::fbjni
android
```
Tokens:
Raw