0.4.0

.cspell-wordlist.txt

@@ -0,0 +1,51 @@
+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
+finetuned
+MINILM
+MPNET

.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" }],
+        "camelcase": "error"
+    },
+    "plugins": [
+        "eslint-plugin-prettier"
+    ],
+    "ignorePatterns": [
+        "node_modules/",
+        "lib/"
+    ]
+}

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

@@ -1,28 +1,28 @@
-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/**
   workflow_dispatch:
 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
@@ -35,6 +35,7 @@ jobs:
           distribution: 'zulu'
           java-version: 17
       - name: Install node dependencies
+        working-directory: ${{ env.WORKING_DIRECTORY }}
         run: yarn install --immutable
       - name: Build app
         working-directory: ${{ env.WORKING_DIRECTORY }}/android

.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'
   workflow_dispatch:
 jobs:
   build:
@@ -23,20 +23,23 @@ jobs:
       group: ios-${{ github.ref }}
       cancel-in-progress: true
     steps:
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: latest-stable
       - 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

@@ -8,13 +8,25 @@
 
 **ExecuTorch** is a novel framework created by Meta that enables running AI models on devices such as mobile phones or microcontrollers. React Native ExecuTorch bridges the gap between React Native and native platform capabilities, allowing developers to run AI models locally on mobile devices with state-of-the-art performance, without requiring deep knowledge of native code or machine learning internals.
 
+**Table of contents:**
+
+- [Compatibility](#compatibility)
+- [Ready-made models 🤖](#readymade-models-)
+- [Documentation 📚](#documentation-)
+- [🦙 Quickstart - Running Llama](#-quickstart---running-llama)
+- [Minimal supported versions](#minimal-supported-versions)
+- [Examples 📲](#examples-)
+- [Warning](#warning)
+- [License](#license)
+- [What's next?](#whats-next)
+
 ## Compatibility
 
 React Native Executorch supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page).
 
 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 +55,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
 }
@@ -64,11 +77,14 @@ function MyComponent() {
 
 ```tsx
 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);
+  const chat = [
+    { role: 'system' content: 'You are a helpful assistant' }
+    { role: 'user', content: 'What is the meaning of life?' }
+  ];
+
+  // Chat completion
+  await llm.generate(chat);
+  console.log('Llama says:', llm.response);
 };
 ```
 
@@ -82,11 +98,12 @@ https://github.com/user-attachments/assets/27ab3406-c7f1-4618-a981-6c86b53547ee
 
 We currently host a few example apps demonstrating use cases of our library:
 
+- examples/llm - chat application showcasing use of LLMs
 - 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/text-embeddings - computing text representations for semantic search
 
-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/build.gradle

@@ -103,7 +103,7 @@ dependencies {
   implementation "com.facebook.react:react-android:+"
   implementation 'org.opencv:opencv:4.10.0'
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-  implementation 'com.github.software-mansion:react-native-executorch:main-SNAPSHOT'
+  implementation(files("libs/executorch.aar"))
   implementation 'org.opencv:opencv:4.10.0'
   implementation("com.squareup.okhttp3:okhttp:4.9.2")
 }

android/src/main/java/com/swmansion/rnexecutorch/ETModule.kt

@@ -9,7 +9,6 @@ import com.swmansion.rnexecutorch.utils.ETError
 import com.swmansion.rnexecutorch.utils.TensorUtils
 import org.pytorch.executorch.EValue
 import org.pytorch.executorch.Module
-import java.net.URL
 
 class ETModule(
   reactContext: ReactApplicationContext,
@@ -23,7 +22,7 @@ class ETModule(
     modelSource: String,
     promise: Promise,
   ) {
-    module = Module.load(URL(modelSource).path)
+    module = Module.load(modelSource)
     promise.resolve(0)
   }