Skip to content

Commit ac40c6f

Browse files
committed
docs: update READMEs
1 parent 421cc64 commit ac40c6f

7 files changed

Lines changed: 109 additions & 16 deletions

File tree

.cspell.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"version": "0.2",
33
"language": "en",
4-
"ignorePaths": ["**/node_modules", "**/Pods"],
4+
"ignorePaths": ["**/node_modules", "**/Pods", "**/readmes/**"],
55
"dictionaryDefinitions": [
66
{
77
"name": "project-words",

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,8 @@ Add this to your component file:
9797
import {
9898
useLLM,
9999
LLAMA3_2_1B,
100-
Message
100+
Message,
101+
initExecutorch,
101102
} from 'react-native-executorch';
102103
import { ExpoResourceFetcher } from '@react-native-executorch/expo-resource-fetcher';
103104

readmes/README_cn.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ React Native ExecuTorch 架起了 React Native 和原生平台功能之间的桥
5555

5656
- iOS 17.0
5757
- Android 13
58-
- React Native 0.76
58+
- React Native 0.81
5959

6060
> [!IMPORTANT]
6161
> React Native ExecuTorch 仅支持 [New React Native architecture](https://reactnative.dev/architecture/landing-page)
@@ -75,6 +75,15 @@ React Native ExecuTorch 为 [Private Mind](https://privatemind.swmansion.com/)
7575
```bash
7676
# 安装包
7777
yarn add react-native-executorch
78+
79+
# 如果您使用 expo,请添加这些包用于资源获取:
80+
yarn add @react-native-executorch/expo-adapter
81+
yarn add expo-file-system expo-asset
82+
83+
# 如果您使用原生 React Native 项目,请使用这些包:
84+
yarn add @react-native-executorch/bare-adapter
85+
yarn add @dr.pogodin/react-native-fs @kesha-antonov/react-native-background-downloader
86+
7887
# 根据平台,选择 iOS 或 Android
7988
yarn expo run:< ios | android >
8089
```
@@ -84,7 +93,17 @@ yarn expo run:< ios | android >
8493
将此添加到您的组件文件中:
8594

8695
```tsx
87-
import { useLLM, LLAMA3_2_1B, Message } from 'react-native-executorch';
96+
import {
97+
useLLM,
98+
LLAMA3_2_1B,
99+
Message,
100+
initExecutorch,
101+
} from 'react-native-executorch';
102+
import { ExpoResourceFetcher } from '@react-native-executorch/expo-resource-fetcher';
103+
104+
initExecutorch({
105+
resourceFetcher: ExpoResourceFetcher,
106+
});
88107

89108
function MyComponent() {
90109
// 初始化模型 🚀

readmes/README_es.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Las versiones mínimas compatibles son:
5555

5656
- iOS 17.0
5757
- Android 13
58-
- React Native 0.76
58+
- React Native 0.81
5959

6060
> [!IMPORTANT]
6161
> React Native ExecuTorch solo admite la [nueva arquitectura de React Native](https://reactnative.dev/architecture/landing-page).
@@ -75,16 +75,35 @@ React Native ExecuTorch impulsa [Private Mind](https://privatemind.swmansion.com
7575
```bash
7676
# Instalar el paquete
7777
yarn add react-native-executorch
78+
79+
# Si usa expo, agregue estos paquetes para la obtención de recursos:
80+
yarn add @react-native-executorch/expo-adapter
81+
yarn add expo-file-system expo-asset
82+
83+
# Si usa un proyecto básico de React Native, use estos paquetes:
84+
yarn add @react-native-executorch/bare-adapter
85+
yarn add @dr.pogodin/react-native-fs @kesha-antonov/react-native-background-downloader
86+
7887
# Dependiendo de la plataforma, elige iOS o Android
7988
yarn expo run:< ios | android >
8089
```
8190

82-
### :two: Configuración e inicialización
91+
### :two: **Configuración e inicialización**
8392

8493
Agrega esto a tu archivo de componente:
8594

8695
```tsx
87-
import { useLLM, LLAMA3_2_1B, Message } from 'react-native-executorch';
96+
import {
97+
useLLM,
98+
LLAMA3_2_1B,
99+
Message,
100+
initExecutorch,
101+
} from 'react-native-executorch';
102+
import { ExpoResourceFetcher } from '@react-native-executorch/expo-resource-fetcher';
103+
104+
initExecutorch({
105+
resourceFetcher: ExpoResourceFetcher,
106+
});
88107

89108
function MyComponent() {
90109
// Inicializa el modelo 🚀

readmes/README_fr.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
<img src="../docs/static/img/logo-hero.svg" alt="RNE Logo" width="25%">
33
</div>
44

5-
65
<div align="center">
76
<h1 align="center" style="display:inline-block">React Native ExecuTorch
87
</h1>
@@ -56,7 +55,7 @@ Les versions minimales supportées sont :
5655

5756
- iOS 17.0
5857
- Android 13
59-
- React Native 0.76
58+
- React Native 0.81
6059

6160
> [!IMPORTANT]
6261
> React Native ExecuTorch ne supporte que la [nouvelle architecture React Native](https://reactnative.dev/architecture/landing-page).
@@ -76,6 +75,15 @@ React Native ExecuTorch alimente [Private Mind](https://privatemind.swmansion.co
7675
```bash
7776
# Installez le package
7877
yarn add react-native-executorch
78+
79+
# Si vous utilisez expo, veuillez ajouter ces packages pour la récupération de ressources :
80+
yarn add @react-native-executorch/expo-adapter
81+
yarn add expo-file-system expo-asset
82+
83+
# Si vous utilisez un projet React Native brut, utilisez ces packages :
84+
yarn add @react-native-executorch/bare-adapter
85+
yarn add @dr.pogodin/react-native-fs @kesha-antonov/react-native-background-downloader
86+
7987
# Selon la plateforme, choisissez soit iOS soit Android
8088
yarn expo run:< ios | android >
8189
```
@@ -85,7 +93,17 @@ yarn expo run:< ios | android >
8593
Ajoutez ceci à votre fichier de composant :
8694

8795
```tsx
88-
import { useLLM, LLAMA3_2_1B, Message } from 'react-native-executorch';
96+
import {
97+
useLLM,
98+
LLAMA3_2_1B,
99+
Message,
100+
initExecutorch,
101+
} from 'react-native-executorch';
102+
import { ExpoResourceFetcher } from '@react-native-executorch/expo-resource-fetcher';
103+
104+
initExecutorch({
105+
resourceFetcher: ExpoResourceFetcher,
106+
});
89107

90108
function MyComponent() {
91109
// Initialisez le modèle 🚀

readmes/README_in.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
<a href="README_in.md"><img src="https://img.shields.io/badge/IN-00008B?logo=&logoColor=white&color=00008B&style=for-the-badge" alt="README IN"></a>
2626
</p>
2727

28-
2928
**React Native ExecuTorch** एक घोषणात्मक तरीका प्रदान करता है जिससे React Native का उपयोग करके उपकरण पर AI मॉडल्स को चलाया जा सके, जो **ExecuTorch** द्वारा संचालित है :rocket:. यह LLMs, कंप्यूटर विज़न मॉडल्स, और भी कई के लिए आउट-ऑफ़-द-बॉक्स सपोर्ट प्रदान करता है। इन मॉडलों का अन्वेषण करने के लिए हमारे [HuggingFace](https://huggingface.co/software-mansion) पेज पर जाएं।
3029

3130
**ExecuTorch**, Meta द्वारा विकसित, एक नया फ्रेमवर्क है जो मोबाइल फोनों या माइक्रोकंट्रोलर्स जैसे उपकरणों पर AI मॉडल निष्पादन की अनुमति देता है।
@@ -56,7 +55,7 @@ React Native ExecuTorch, React Native और नेटिव प्लेटफ
5655

5756
- iOS 17.0
5857
- Android 13
59-
- React Native 0.76
58+
- React Native 0.81
6059

6160
> [!IMPORTANT]
6261
> React Native ExecuTorch केवल [नई React Native आर्किटेक्चर](https://reactnative.dev/architecture/landing-page) का समर्थन करता है।
@@ -76,6 +75,15 @@ React Native ExecuTorch को [Private Mind](https://privatemind.swmansion.com/
7675
```bash
7776
# पैकेज को इंस्टॉल करें
7877
yarn add react-native-executorch
78+
79+
# यदि आप expo का उपयोग करते हैं, तो कृपया संसाधन प्राप्त करने के लिए ये पैकेज जोड़ें:
80+
yarn add @react-native-executorch/expo-adapter
81+
yarn add expo-file-system expo-asset
82+
83+
# यदि आप bare React Native प्रोजेक्ट का उपयोग करते हैं तो इन पैकेजों का उपयोग करें:
84+
yarn add @react-native-executorch/bare-adapter
85+
yarn add @dr.pogodin/react-native-fs @kesha-antonov/react-native-background-downloader
86+
7987
# प्लेटफॉर्म के अनुसार, या तो iOS या Android चुनें
8088
yarn expo run:< ios | android >
8189
```
@@ -85,7 +93,17 @@ yarn expo run:< ios | android >
8593
अपने घटक फाइल में यह जोड़ें:
8694

8795
```tsx
88-
import { useLLM, LLAMA3_2_1B, Message } from 'react-native-executorch';
96+
import {
97+
useLLM,
98+
LLAMA3_2_1B,
99+
Message,
100+
initExecutorch,
101+
} from 'react-native-executorch';
102+
import { ExpoResourceFetcher } from '@react-native-executorch/expo-resource-fetcher';
103+
104+
initExecutorch({
105+
resourceFetcher: ExpoResourceFetcher,
106+
});
89107

90108
function MyComponent() {
91109
// मॉडल को प्रारंभ करें 🚀

readmes/README_pt.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
<img src="../docs/static/img/logo-hero.svg" alt="RNE Logo" width="25%">
33
</div>
44

5-
65
<div align="center">
76
<h1 align="center" style="display:inline-block">React Native ExecuTorch
87
</h1>
@@ -57,7 +56,7 @@ As versões mínimas suportadas são:
5756

5857
- iOS 17.0
5958
- Android 13
60-
- React Native 0.76
59+
- React Native 0.81
6160

6261
> [!IMPORTANT]
6362
> React Native ExecuTorch suporta apenas a [Nova Arquitetura do React Native](https://reactnative.dev/architecture/landing-page).
@@ -77,6 +76,15 @@ React Native ExecuTorch está impulsionando o [Private Mind](https://privatemind
7776
```bash
7877
# Instale o pacote
7978
yarn add react-native-executorch
79+
80+
# Se você usa expo, adicione estes pacotes para busca de recursos:
81+
yarn add @react-native-executorch/expo-adapter
82+
yarn add expo-file-system expo-asset
83+
84+
# Se você usa projeto React Native básico, use estes pacotes:
85+
yarn add @react-native-executorch/bare-adapter
86+
yarn add @dr.pogodin/react-native-fs @kesha-antonov/react-native-background-downloader
87+
8088
# Dependendo da plataforma, escolha iOS ou Android
8189
yarn expo run:< ios | android >
8290
```
@@ -86,7 +94,17 @@ yarn expo run:< ios | android >
8694
Adicione isso ao seu arquivo de componente:
8795

8896
```tsx
89-
import { useLLM, LLAMA3_2_1B, Message } from 'react-native-executorch';
97+
import {
98+
useLLM,
99+
LLAMA3_2_1B,
100+
Message,
101+
initExecutorch,
102+
} from 'react-native-executorch';
103+
import { ExpoResourceFetcher } from '@react-native-executorch/expo-resource-fetcher';
104+
105+
initExecutorch({
106+
resourceFetcher: ExpoResourceFetcher,
107+
});
90108

91109
function MyComponent() {
92110
// Inicialize o modelo 🚀

0 commit comments

Comments
 (0)