react-native-executorch

React Native ExecuTorch

React Native ExecuTorch provides a declarative way to run AI models on-device using React Native, powered by ExecuTorch :rocket:. It offers out-of-the-box support for a wide range of LLMs, computer vision models, and more. Visit our HuggingFace page to explore these models.

ExecuTorch, developed by Meta, is a novel framework allowing AI model execution on devices like mobile phones or microcontrollers.

React Native ExecuTorch bridges the gap between React Native and native platform capabilities, enabling developers to efficiently run local AI models on mobile devices. This can be achieved without the need for extensive expertise in native programming or machine learning.

Table of Contents

• Supported Versions
• Real-world Example
• Quickstart - Running Llama
  • :one: Installation
  • :two: Setup & Initialization
  • :three: Run the Model!
• Demo Apps
• Ready-made Models
• Documentation
• License
• What's Next?
• React Native ExecuTorch is created by Software Mansion

Supported Versions

The minimal supported version are:

• iOS 17.0
• Android 13
• React Native - see compatibility table

[!IMPORTANT] React Native ExecuTorch supports only the New React Native architecture.

Real-world Example

React Native ExecuTorch is powering Private Mind, a privacy-first mobile AI app available on App Store and Google Play.

Quickstart - Running Llama

Get started with AI-powered text generation in 3 easy steps!

:one: Installation

# Install the package
yarn add react-native-executorch

# If you use expo, please add these packages for resource fetching:
yarn add react-native-executorch-expo-resource-fetcher
yarn add expo-file-system expo-asset

#if you use bare React Native project use these packages:
yarn add react-native-executorch-bare-resource-fetcher
yarn add @dr.pogodin/react-native-fs @kesha-antonov/react-native-background-downloader

# Depending on the platform, choose either iOS or Android
yarn < ios | android >

:two: Setup & Initialization

Add this to your component file:

import {
  useLLM,
  LLAMA3_2_1B,
  Message,
  initExecutorch,
} from 'react-native-executorch';
import { ExpoResourceFetcher } from 'react-native-executorch-expo-resource-fetcher';

initExecutorch({
  resourceFetcher: ExpoResourceFetcher,
});

function MyComponent() {
  // Initialize the model 🚀
  const llm = useLLM({ model: LLAMA3_2_1B });
  // ... rest of your component
}

:three: Run the Model!

const handleGenerate = async () => {
  const chat: Message[] = [
    { 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);
};

Demo Apps

We currently host a few example apps demonstrating use cases of our library:

• llm - Chat application showcasing use of LLMs
• speech - Speech to Text & Text to Speech task implementations
• computer-vision - Computer vision related tasks
• text-embeddings - Computing text representations for semantic search
• bare_rn - LLM chat example for bare React Native (without Expo)

If you would like to run a demo app, navigate to its project directory. Then install dependencies and run app with:

yarn && yarn < ios | android >

[!WARNING] Running LLMs requires a significant amount of RAM. If you are encountering unexpected app crashes, try to increase the amount of RAM allocated to the emulator.

Ready-made Models

Our library has a number of ready-to-use AI models; a complete list is available in the documentation. If you're interested in running your own AI model, you need to first export it to the .pte format. Instructions on how to do this are available in the Python API and optimum-executorch README.

Documentation

Check out how our library can help you build your React Native AI features by visiting our docs: https://docs.swmansion.com/react-native-executorch

License

This library is licensed under The MIT License.

What's Next?

To learn about our upcoming plans and developments, please visit our milestones.

React Native ExecuTorch is created by Software Mansion

Since 2012, Software Mansion is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – Hire us.