You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add note about new architecture in readme and docs (#127)
## Description
<!-- Provide a concise and descriptive summary of the changes
implemented in this PR. -->
### Type of change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] Documentation update (improves or adds clarity to existing
documentation)
### Tested on
- [ ] iOS
- [ ] Android
### Testing instructions
<!-- Provide step-by-step instructions on how to test your changes.
Include setup details if necessary. -->
### Screenshots
<!-- Add screenshots here, if applicable -->
### Related issues
<!-- Link related issues here using #issue-number -->
### Checklist
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have updated the documentation accordingly
- [ ] My changes generate no new warnings
### Additional notes
<!-- Include any additional information, assumptions, or context that
reviewers might need to understand this PR. -->
Copy file name to clipboardexpand all lines: README.md
+26-15
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,12 @@
6
6
7
7
**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.
8
8
9
+
## Compatibility
10
+
11
+
React Native Executorch supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page).
12
+
13
+
If your app still runs on the old architecture, please consider upgrading to the New Architecture.
14
+
9
15
## Readymade models 🤖
10
16
11
17
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.
@@ -15,12 +21,12 @@ To run any AI model in ExecuTorch, you need to export it to a `.pte` format. If
15
21
Take a look at how our library can help build you your React Native AI features in our docs:
We currently host two example apps demonstrating use cases of our library:
82
+
72
83
- examples/speech-to-text - Whisper and Moonshine models ready for transcription tasks
73
84
- examples/computer-vision - computer vision related tasks
74
85
- examples/llama - chat applications showcasing use of LLMs
@@ -100,10 +111,10 @@ yarn expo run:ios
100
111
```
101
112
102
113
### Warning
103
-
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.
104
114
115
+
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.
105
116
106
-
## License
117
+
## License
107
118
108
119
This library is licensed under [The MIT License](./LICENSE).
Copy file name to clipboardexpand all lines: docs/docs/fundamentals/getting-started.md
+6
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,12 @@ ExecuTorch is a novel AI framework developed by Meta, designed to streamline dep
14
14
15
15
React Native ExecuTorch is our way of bringing ExecuTorch into the React Native world. Our API is built to be simple, declarative, and efficient. Plus, we’ll provide a set of pre-exported models for common use cases, so you won’t have to worry about handling exports yourself. With just a few lines of JavaScript, you’ll be able to run AI models (even LLMs 👀) right on your device—keeping user data private and saving on cloud costs.
16
16
17
+
## Compatibility
18
+
19
+
React Native Executorch supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page).
20
+
21
+
If your app still runs on the old architecture, please consider upgrading to the New Architecture.
22
+
17
23
## Installation
18
24
19
25
Installation is pretty straightforward, just use your favorite package manager.
0 commit comments