feat: add C++ JSI interface and Executorch dependency

.cspell-wordlist.txt

@@ -0,0 +1,48 @@
+swmansion
+executorch
+execu
+Execu
+torch
+huggingface
+bbox
+bboxes
+deeplab
+unsqueeze
+qlora
+spinquant
+efficientnet
+ssdlite
+udnie
+crnn
+mobilenet
+microcontrollers
+notimestamps
+seqs
+smollm
+qwen
+XNNPACK
+EFFICIENTNET
+SSDLITE
+MOBILENET
+UDNIE
+CRNN
+SPINQUANT
+QLORA
+GGUF
+deeplabv
+DEELABV
+ARGMAX
+Abaza
+Adyghe
+Chech
+Dargwa
+Ingush
+Karbadian
+Lezghian
+Occitan
+Tabassaran
+Sinhala
+Infima
+sublabel
+Aeonik
+Lexend

.cspell.json

@@ -0,0 +1,12 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "ignorePaths": ["**/node_modules", "**/Pods"],
+  "dictionaryDefinitions": [
+    {
+      "name": "project-words",
+      "path": ".cspell-wordlist.txt"
+    }
+  ],
+  "dictionaries": ["project-words"]
+}

.eslintrc

@@ -0,0 +1,38 @@
+{
+    "parserOptions": {
+        "requireConfigFile": false,
+        "babelOptions": {
+            "presets": [
+                "@babel/preset-react"
+            ]
+        }
+    },
+    "root": true,
+    "extends": [
+        "@react-native",
+        "prettier",
+        "plugin:@cspell/recommended"
+    ],
+    "rules": {
+        "react/react-in-jsx-scope": "off",
+        "prettier/prettier": [
+            "error",
+            {
+                "quoteProps": "consistent",
+                "singleQuote": true,
+                "tabWidth": 2,
+                "trailingComma": "es5",
+                "useTabs": false
+            }
+        ],
+        "@cspell/spellchecker": ["warn", { "customWordListFile": ".cspell-wordlist.txt" }]
+
+    },
+    "plugins": [
+        "eslint-plugin-prettier"
+    ],
+    "ignorePatterns": [
+        "node_modules/",
+        "lib/"
+    ]
+}

.github/workflows/build-android-llama-example.yml → .github/workflows/build-android-llm-example.yml

@@ -1,27 +1,27 @@
-name: Llama Example app Android build check
+name: LLM Example app Android build check
 on:
   pull_request:
     paths:
-      - .github/workflows/build-android-llama-example.yml
+      - .github/workflows/build-android-llm-example.yml
       - android/**
       - third-party/android/**
-      - examples/llama/package.json
-      - examples/llama/android/**
+      - examples/llm/package.json
+      - examples/llm/android/**
   push:
     branches:
       - main
     paths:
-      - .github/workflows/build-android-llama-example.yml
+      - .github/workflows/build-android-llm-example.yml
       - android/**
       - third-party/android/**
-      - examples/llama/package.json
-      - examples/llama/android/**
+      - examples/llm/package.json
+      - examples/llm/android/**
 jobs:
   build:
     if: github.repository == 'software-mansion/react-native-executorch'
     runs-on: ubuntu-latest
     env:
-      WORKING_DIRECTORY: examples/llama
+      WORKING_DIRECTORY: examples/llm
     concurrency:
       group: android-${{ github.ref }}
       cancel-in-progress: true

.github/workflows/build-ios-llama-example.yml → .github/workflows/build-ios-llm-example.yml

@@ -1,19 +1,19 @@
-name: Llama Example app iOS build check
+name: LLM Example app iOS build check
 on:
   push:
     branches:
       - main
     paths:
-      - '.github/workflows/build-ios-llama-example.yml'
+      - '.github/workflows/build-ios-llm-example.yml'
       - '*.podspec'
-      - 'examples/llama/ios/**'
-      - 'examples/llama/package.json'
+      - 'examples/llm/ios/**'
+      - 'examples/llm/package.json'
   pull_request:
     paths:
-      - '.github/workflows/build-ios-llama-example.yml'
+      - '.github/workflows/build-ios-llm-example.yml'
       - '*.podspec'
-      - 'examples/llama/ios/**'
-      - 'examples/llama/package.json'
+      - 'examples/llm/ios/**'
+      - 'examples/llm/package.json'
 jobs:
   build:
     if: github.repository == 'software-mansion/react-native-executorch'
@@ -25,17 +25,17 @@ jobs:
       - name: Check out Git repository
         uses: actions/checkout@v4
       - name: Install node dependencies
-        working-directory: examples/llama
+        working-directory: examples/llm
         run: yarn
       - name: Install pods
-        working-directory: examples/llama/ios
+        working-directory: examples/llm/ios
         run: pod install
       - name: Build app
-        working-directory: examples/llama/ios
+        working-directory: examples/llm/ios
         run: |
           set -o pipefail && xcodebuild \
-            -workspace llama.xcworkspace \
-            -scheme llama \
+            -workspace llm.xcworkspace \
+            -scheme llm \
             -sdk iphonesimulator \
             -configuration Debug \
             -destination 'platform=iOS Simulator,name=iPhone 16 Pro' \

.gitignore

@@ -80,3 +80,7 @@ lib/
 # React Native Codegen
 ios/generated
 android/generated
+
+# custom
+*.tgz
+Makefile

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "executorch"]
+    path = third-party/executorch
+    url = https://github.com/software-mansion-labs/executorch
+[submodule "tokenizers-cpp"]
+	path = third-party/tokenizers-cpp
+	url = https://github.com/software-mansion-labs/tokenizers-cpp

.prettierrc

@@ -0,0 +1,7 @@
+{
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+}

README.md

@@ -14,7 +14,7 @@ React Native Executorch supports only the [New React Native architecture](https:
 
 If your app still runs on the old architecture, please consider upgrading to the New Architecture.
 
-## Readymade models 🤖
+## Ready-made models 🤖
 
 To run any AI model in ExecuTorch, you need to export it to a `.pte` format. If you're interested in experimenting with your own models, we highly encourage you to check out the [Python API](https://pypi.org/project/executorch/). If you prefer focusing on developing your React Native app, we will cover several common use cases. For more details, please refer to the documentation.
 
@@ -43,16 +43,17 @@ Add this to your component file:
 
 ```tsx
 import {
-  LLAMA3_2_3B_QLORA,
-  LLAMA3_2_3B_TOKENIZER,
   useLLM,
+  LLAMA3_2_1B,
+  LLAMA3_2_TOKENIZER_CONFIG,
 } from 'react-native-executorch';
 
 function MyComponent() {
   // Initialize the model 🚀
   const llama = useLLM({
-    modelSource: LLAMA3_2_3B_QLORA,
-    tokenizerSource: LLAMA3_2_3B_TOKENIZER,
+    modelSource: LLAMA3_2_1B,
+    tokenizerSource: LLAMA3_2_TOKENIZER,
+    tokenizerConfigSource: LLAMA3_2_TOKENIZER_CONFIG,
   });
   // ... rest of your component
 }
@@ -67,8 +68,8 @@ const handleGenerate = async () => {
   const prompt = 'The meaning of life is';
 
   // Generate text based on your desired prompt
-  const response = await llama.generate(prompt);
-  console.log('Llama says:', response);
+  await llama.runInference(prompt);
+  console.log('Llama says:', llama.response);
 };
 ```
 
@@ -84,9 +85,9 @@ We currently host two example apps demonstrating use cases of our library:
 
 - examples/speech-to-text - Whisper and Moonshine models ready for transcription tasks
 - examples/computer-vision - computer vision related tasks
-- examples/llama - chat applications showcasing use of LLMs
+- examples/llm - chat applications showcasing use of LLMs
 
-If you would like to run it, navigate to it's project directory, for example `examples/llama` from the repository root and install dependencies with:
+If you would like to run it, navigate to it's project directory, for example `examples/llm` from the repository root and install dependencies with:
 
 ```bash
 yarn

android/CMakeLists.txt

@@ -0,0 +1,17 @@
+cmake_minimum_required(VERSION 3.13)
+project(RnExecutorch)
+
+set (CMAKE_VERBOSE_MAKEFILE ON)
+set (CMAKE_CXX_STANDARD 20)
+
+include("${REACT_NATIVE_DIR}/ReactAndroid/cmake-utils/folly-flags.cmake")
+add_compile_options(${folly_FLAGS})
+
+string(APPEND CMAKE_CXX_FLAGS " -DRCT_NEW_ARCH_ENABLED")
+
+set(ANDROID_CPP_DIR "${CMAKE_SOURCE_DIR}/src/main/cpp")
+set(COMMON_CPP_DIR "${CMAKE_SOURCE_DIR}/../common")
+set(ET_LIB_DIR "${CMAKE_SOURCE_DIR}/../third-party/android/libs")
+set(ET_INCLUDE_DIR "${CMAKE_SOURCE_DIR}/../third-party/include")
+
+add_subdirectory("${ANDROID_CPP_DIR}")