react-native-executorch 0.5.9 → 0.5.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,6 +9,15 @@
|
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
|
|
12
|
+
<p align="center">
|
|
13
|
+
<a href="https://github.com/software-mansion/react-native-executorch/blob/release/0.5/README.md">English</a>
|
|
14
|
+
<a href="https://github.com/software-mansion/react-native-executorch/blob/release/0.5/readmes/README_es.md">Español</a>
|
|
15
|
+
<a href="https://github.com/software-mansion/react-native-executorch/blob/release/0.5/readmes/README_fr.md">Français</a>
|
|
16
|
+
<a href="https://github.com/software-mansion/react-native-executorch/blob/release/0.5/readmes/README_cn.md">简体中文</a>
|
|
17
|
+
<a href="https://github.com/software-mansion/react-native-executorch/blob/release/0.5/readmes/README_pt.md">Português</a>
|
|
18
|
+
<a href="https://github.com/software-mansion/react-native-executorch/blob/release/0.5/readmes/README_in.md">हिंदी</a>
|
|
19
|
+
</p>
|
|
20
|
+
|
|
12
21
|
**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](https://huggingface.co/software-mansion) page to explore these models.
|
|
13
22
|
|
|
14
23
|
**ExecuTorch**, developed by Meta, is a novel framework allowing AI model execution on devices like mobile phones or microcontrollers.
|
|
@@ -21,10 +30,11 @@ React Native ExecuTorch bridges the gap between React Native and native platform
|
|
|
21
30
|
**Table of contents:**
|
|
22
31
|
|
|
23
32
|
- [:yin_yang: Supported versions](#yin_yang-supported-versions)
|
|
24
|
-
- [:robot: Ready-made models](#robot-ready-made-models)
|
|
25
33
|
- [:books: Documentation](#books-documentation)
|
|
34
|
+
- [:earth_africa: Real-World Example](#earth_africa-real-world-example)
|
|
26
35
|
- [:llama: Quickstart - Running Llama](#llama-quickstart---running-llama)
|
|
27
|
-
- [:calling:
|
|
36
|
+
- [:calling: Demo apps](#calling-demo-apps)
|
|
37
|
+
- [:robot: Ready-made models](#robot-ready-made-models)
|
|
28
38
|
- [:balance_scale: License](#balance_scale-license)
|
|
29
39
|
- [:soon: What's next?](#soon-whats-next)
|
|
30
40
|
|
|
@@ -38,15 +48,17 @@ The minimal supported version are:
|
|
|
38
48
|
> [!IMPORTANT]
|
|
39
49
|
> React Native Executorch supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page).
|
|
40
50
|
|
|
41
|
-
## :robot: Ready-made models
|
|
42
|
-
|
|
43
|
-
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](https://pypi.org/project/executorch/).
|
|
44
|
-
|
|
45
51
|
## :books: Documentation
|
|
46
52
|
|
|
47
53
|
Check out how our library can help you build your React Native AI features by visiting our docs:
|
|
48
54
|
https://docs.swmansion.com/react-native-executorch
|
|
49
55
|
|
|
56
|
+
## :earth_africa: Real-World Example
|
|
57
|
+
|
|
58
|
+
React Native ExecuTorch is powering [Private Mind](https://github.com/software-mansion-labs/private-mind), a privacy-first mobile AI app available on [App Store](https://apps.apple.com/gb/app/private-mind/id6746713439) and [Google Play](https://play.google.com/store/apps/details?id=com.swmansion.privatemind).
|
|
59
|
+
|
|
60
|
+
<img width="2720" height="1085" alt="Private Mind promo" src="https://github.com/user-attachments/assets/b12296fe-19ac-48fc-9726-da9242700346" />
|
|
61
|
+
|
|
50
62
|
## :llama: **Quickstart - Running Llama**
|
|
51
63
|
|
|
52
64
|
**Get started with AI-powered text generation in 3 easy steps!**
|
|
@@ -93,12 +105,12 @@ const handleGenerate = async () => {
|
|
|
93
105
|
};
|
|
94
106
|
```
|
|
95
107
|
|
|
96
|
-
## :calling:
|
|
108
|
+
## :calling: Demo apps
|
|
97
109
|
|
|
98
110
|
We currently host a few example [apps](https://github.com/software-mansion/react-native-executorch/tree/main/apps) demonstrating use cases of our library:
|
|
99
111
|
|
|
100
112
|
- `llm` - Chat application showcasing use of LLMs
|
|
101
|
-
- `speech-to-text` - Whisper
|
|
113
|
+
- `speech-to-text` - Whisper model ready for transcription tasks
|
|
102
114
|
- `computer-vision` - Computer vision related tasks
|
|
103
115
|
- `text-embeddings` - Computing text representations for semantic search
|
|
104
116
|
|
|
@@ -117,6 +129,10 @@ yarn expo run:< ios | android >
|
|
|
117
129
|
> [!WARNING]
|
|
118
130
|
> 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.
|
|
119
131
|
|
|
132
|
+
## :robot: Ready-made models
|
|
133
|
+
|
|
134
|
+
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](https://docs.pytorch.org/executorch/stable/using-executorch-export.html) and [optimum-executorch README](https://github.com/huggingface/optimum-executorch?tab=readme-ov-file#option-2-export-and-load-separately).
|
|
135
|
+
|
|
120
136
|
## :balance_scale: License
|
|
121
137
|
|
|
122
138
|
This library is licensed under [The MIT License](./LICENSE).
|