Skip to content

Commit 614405f

Browse files
authored
added translations of README (#640)
## Description <!-- Provide a concise and descriptive summary of the changes implemented in this PR. --> ### Introduces a breaking change? - [ ] Yes - [X] No ### Type of change - [ ] Bug fix (change which fixes an issue) - [ ] New feature (change which adds functionality) - [X] Documentation update (improves or adds clarity to existing documentation) - [ ] Other (chores, tests, code style improvements etc.) ### 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. -->
1 parent d414d50 commit 614405f

File tree

7 files changed

+749
-0
lines changed

7 files changed

+749
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@
99

1010
![Software Mansion banner](https://github.com/user-attachments/assets/fa2c4735-e75c-4cc1-970d-88905d95e3a4)
1111

12+
<p align="center">
13+
<a href="https://github.com/software-mansion/react-native-executorch/blob/main/README.md">English</a>
14+
<a href="https://github.com/software-mansion/react-native-executorch/blob/main/readmes/README_es.md">Español</a>
15+
<a href="https://github.com/software-mansion/react-native-executorch/blob/main/readmes/README_fr.md">Français</a>
16+
<a href="https://github.com/software-mansion/react-native-executorch/blob/main/readmes/README_cn.md">简体中文</a>
17+
<a href="https://github.com/software-mansion/react-native-executorch/blob/main/readmes/README_pt.md">Português</a>
18+
<a href="https://github.com/software-mansion/react-native-executorch/blob/main/readmes/README_in.md">हिंदी</a>
19+
</p>
20+
1221
**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.
1322

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

RELEASE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ The release process of new minor version consists of the following steps:
1414
8. Create a PR with the updated docs.
1515
9. Create the release notes on GitHub.
1616
10. Update README.md with release video, if available.
17+
11. Update README.md links to release branch.
1718

1819
## Patch release
1920

readmes/README_cn.md

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
<div align="right">
2+
<h1 align="left" style="display:inline-block">React Native ExecuTorch
3+
<!-- Discord Badge -->
4+
<a href="https://discord.gg/ZGqqY55qkP">
5+
<img src="https://img.shields.io/badge/Discord-Join%20Us-00008B?logo=discord&logoColor=white&style=for-the-badge" alt="Join our Discord community">
6+
</a>
7+
</h1>
8+
</div>
9+
10+
![Software Mansion banner](https://github.com/user-attachments/assets/fa2c4735-e75c-4cc1-970d-88905d95e3a4)
11+
12+
<p align="center">
13+
<a href="../README.md">English</a>
14+
<a href="README_es.md">Español</a>
15+
<a href="README_fr.md">Français</a>
16+
<a href="README_cn.md">简体中文</a>
17+
<a href="README_pt.md">Português</a>
18+
<a href="README_in.md">हिंदी</a>
19+
</p>
20+
21+
**React Native ExecuTorch** 是一个使用 React Native 在设备上运行 AI 模型的声明式工具,得益于 **ExecuTorch** 的支持 :rocket:。它为各种 LLM、计算机视觉模型等提供了开箱即用的支持。访问我们的 [HuggingFace](https://huggingface.co/software-mansion) 页面,以探索这些模型。
22+
23+
**ExecuTorch** 由 Meta 开发,是一个创新的框架,允许在移动电话或微控制器等设备上执行 AI 模型。
24+
25+
React Native ExecuTorch 架起了 React Native 和原生平台功能之间的桥梁,使开发者无需深入的本地编程或机器学习知识即可高效地在移动设备上本地运行 AI 模型。
26+
27+
[![npm version](https://img.shields.io/npm/v/react-native-executorch?color=00008B)](https://www.npmjs.com/package/react-native-executorch)
28+
[![CI](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml/badge.svg)](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml)
29+
30+
**目录:**
31+
32+
- [:yin_yang: 支持的版本](#yin_yang-supported-versions)
33+
- [:books: 文档](#books-documentation)
34+
- [:earth_africa: 实际案例](#earth_africa-real-world-example)
35+
- [:llama: 快速入门 - 运行 Llama](#llama-quickstart---running-llama)
36+
- [:calling: 示例应用](#calling-demo-apps)
37+
- [:robot: 现成模型](#robot-ready-made-models)
38+
- [:balance_scale: 许可证](#balance_scale-license)
39+
- [:soon: 接下来是什么?](#soon-whats-next)
40+
41+
## :yin_yang: 支持的版本
42+
43+
最低支持版本为:
44+
* iOS 17.0
45+
* Android 13
46+
* React Native 0.76
47+
48+
> [!IMPORTANT]
49+
> React Native Executorch 仅支持 [New React Native architecture](https://reactnative.dev/architecture/landing-page)
50+
51+
## :books: 文档
52+
53+
查看我们的文档,了解我们的库如何帮助您构建 React Native AI 功能:
54+
https://docs.swmansion.com/react-native-executorch
55+
56+
## :earth_africa: 实际案例
57+
58+
React Native ExecuTorch 为 [Private Mind](https://github.com/software-mansion-labs/private-mind) 提供了动力,这是一款以隐私优先的移动 AI 应用程序,可在 [App Store](https://apps.apple.com/gb/app/private-mind/id6746713439)[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+
62+
## :llama: **快速入门 - 运行 Llama**
63+
64+
**通过三个简单步骤,开始使用 AI 驱动的文本生成!**
65+
66+
### :one: **安装**
67+
68+
```bash
69+
# 安装包
70+
yarn add react-native-executorch
71+
# 根据平台,选择 iOS 或 Android
72+
yarn expo run:< ios | android >
73+
```
74+
75+
### :two: **设置和初始化**
76+
77+
将此添加到您的组件文件中:
78+
79+
```tsx
80+
import {
81+
useLLM,
82+
LLAMA3_2_1B,
83+
Message
84+
} from 'react-native-executorch';
85+
86+
function MyComponent() {
87+
// 初始化模型 🚀
88+
const llm = useLLM({ model: LLAMA3_2_1B });
89+
// ... 您组件的其余部分
90+
}
91+
```
92+
93+
### :three: **运行模型!**
94+
95+
```tsx
96+
const handleGenerate = async () => {
97+
const chat: Message[] = [
98+
{ role: 'system', content: 'You are a helpful assistant' },
99+
{ role: 'user', content: 'What is the meaning of life?' }
100+
];
101+
102+
// 聊天生成
103+
await llm.generate(chat);
104+
console.log('Llama says:', llm.response);
105+
};
106+
```
107+
108+
## :calling: 示例应用
109+
110+
我们目前托管了一些示例 [应用程序](https://github.com/software-mansion/react-native-executorch/tree/main/apps),展示了我们库的使用案例:
111+
112+
- `llm` - 展现 LLM 使用的聊天应用程序
113+
- `speech-to-text` - 准备用于转录任务的 Whisper 模型
114+
- `computer-vision` - 计算机视觉相关任务
115+
- `text-embeddings` - 用于语义搜索的文本表示计算
116+
117+
如果您想运行示例应用程序,请导航到其项目目录并安装依赖项:
118+
119+
```bash
120+
yarn
121+
```
122+
123+
然后,根据平台,选择 iOS 或 Android:
124+
125+
```bash
126+
yarn expo run:< ios | android >
127+
```
128+
129+
> [!WARNING]
130+
> 运行 LLM 需要大量的 RAM。如果您遇到意外的应用崩溃,请尝试增加分配给模拟器的 RAM。
131+
132+
## :robot: 现成模型
133+
134+
我们的库中有许多现成可用的 AI 模型;完整列表可在文档中查看。如果您有兴趣运行自己的 AI 模型,首先需要将其导出为 `.pte` 格式。关于如何执行此操作的说明可在 [Python API](https://docs.pytorch.org/executorch/stable/using-executorch-export.html)[optimum-executorch 说明](https://github.com/huggingface/optimum-executorch?tab=readme-ov-file#option-2-export-and-load-separately) 中获取。
135+
136+
## :balance_scale: 许可证
137+
138+
此库受 [MIT 许可证](./LICENSE) 许可。
139+
140+
## :soon: 接下来是什么?
141+
142+
若要了解我们的计划和发展,敬请访问我们的 [milestones](https://github.com/software-mansion/react-native-executorch/milestones)
143+
144+
## React Native ExecuTorch 是由 Software Mansion 创建的
145+
146+
自 2012 年以来,[Software Mansion](https://swmansion.com) 是一家拥有构建网络和移动应用经验的软件机构。我们是核心 React Native 贡献者,并且是处理各种 React Native 问题的专家。我们可以帮助您构建下一个梦想产品——[雇佣我们](https://swmansion.com/contact/projects?utm_source=react-native-executorch&utm_medium=readme)
147+
148+
[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=react-native-executorch-github 'Software Mansion')](https://swmansion.com)

readmes/README_es.md

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
<div align="right">
2+
<h1 align="left" style="display:inline-block">React Native ExecuTorch
3+
<!-- Insignia de Discord -->
4+
<a href="https://discord.gg/ZGqqY55qkP">
5+
<img src="https://img.shields.io/badge/Discord-Únete%20a%20Nosotros-00008B?logo=discord&logoColor=white&style=for-the-badge" alt="Únete a nuestra comunidad en Discord">
6+
</a>
7+
</h1>
8+
</div>
9+
10+
![Banner de Software Mansion](https://github.com/user-attachments/assets/fa2c4735-e75c-4cc1-970d-88905d95e3a4)
11+
12+
<p align="center">
13+
<a href="../README.md">English</a>
14+
<a href="README_es.md">Español</a>
15+
<a href="README_fr.md">Français</a>
16+
<a href="README_cn.md">简体中文</a>
17+
<a href="README_pt.md">Português</a>
18+
<a href="README_in.md">हिंदी</a>
19+
</p>
20+
21+
**React Native ExecuTorch** ofrece una forma declarativa de ejecutar modelos de IA en el dispositivo utilizando React Native, impulsado por **ExecuTorch** :rocket:. Proporciona soporte listo para usar para una amplia gama de LLMs, modelos de visión por computadora y más. Visita nuestra página en [HuggingFace](https://huggingface.co/software-mansion) para explorar estos modelos.
22+
23+
**ExecuTorch**, desarrollado por Meta, es un marco innovador que permite la ejecución de modelos de IA en dispositivos como teléfonos móviles o microcontroladores.
24+
25+
React Native ExecuTorch conecta React Native con las capacidades nativas de la plataforma, permitiendo a los desarrolladores ejecutar modelos locales de IA en dispositivos móviles de manera eficiente. Esto puede lograrse sin necesidad de una gran experiencia en programación nativa o aprendizaje automático.
26+
27+
[![Versión en npm](https://img.shields.io/npm/v/react-native-executorch?color=00008B)](https://www.npmjs.com/package/react-native-executorch)
28+
[![CI](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml/badge.svg)](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml)
29+
30+
**Tabla de contenidos:**
31+
32+
- [:yin_yang: Versiones compatibles](#yin_yang-versiones-compatibles)
33+
- [:books: Documentación](#books-documentación)
34+
- [:earth_africa: Ejemplo del mundo real](#earth_africa-ejemplo-del-mundo-real)
35+
- [:llama: Inicio rápido - Ejecutar Llama](#llama-inicio-rápido---ejecutar-llama)
36+
- [:calling: Aplicaciones de demostración](#calling-aplicaciones-de-demostración)
37+
- [:robot: Modelos listos para usar](#robot-modelos-listos-para-usar)
38+
- [:balance_scale: Licencia](#balance_scale-licencia)
39+
- [:soon: ¿Qué sigue?](#soon-qué-sigue)
40+
41+
## :yin_yang: Versiones compatibles
42+
43+
Las versiones mínimas compatibles son:
44+
* iOS 17.0
45+
* Android 13
46+
* React Native 0.76
47+
48+
> [!IMPORTANT]
49+
> React Native ExecuTorch solo admite la [nueva arquitectura de React Native](https://reactnative.dev/architecture/landing-page).
50+
51+
## :books: Documentación
52+
53+
Consulta cómo nuestra biblioteca puede ayudarte a crear funciones de IA en React Native visitando nuestra documentación:
54+
https://docs.swmansion.com/react-native-executorch
55+
56+
## :earth_africa: Ejemplo del mundo real
57+
58+
React Native ExecuTorch impulsa [Private Mind](https://github.com/software-mansion-labs/private-mind), una aplicación móvil de IA centrada en la privacidad disponible en [App Store](https://apps.apple.com/gb/app/private-mind/id6746713439) y [Google Play](https://play.google.com/store/apps/details?id=com.swmansion.privatemind).
59+
60+
<img width="2720" height="1085" alt="Promoción de Private Mind" src="https://github.com/user-attachments/assets/b12296fe-19ac-48fc-9726-da9242700346" />
61+
62+
## :llama: **Inicio rápido - Ejecutar Llama**
63+
64+
**¡Comienza con la generación de texto impulsada por IA en 3 sencillos pasos!**
65+
66+
### :one: **Instalación**
67+
68+
```bash
69+
# Instalar el paquete
70+
yarn add react-native-executorch
71+
# Dependiendo de la plataforma, elige iOS o Android
72+
yarn expo run:< ios | android >
73+
```
74+
75+
### :two: Configuración e inicialización
76+
77+
Agrega esto a tu archivo de componente:
78+
79+
```tsx
80+
import {
81+
useLLM,
82+
LLAMA3_2_1B,
83+
Message
84+
} from 'react-native-executorch';
85+
86+
function MyComponent() {
87+
// Inicializa el modelo 🚀
88+
const llm = useLLM({ model: LLAMA3_2_1B });
89+
// ... resto de tu componente
90+
}
91+
```
92+
93+
### :three: ¡Ejecuta el modelo!
94+
```tsx
95+
const handleGenerate = async () => {
96+
const chat: Message[] = [
97+
{ role: 'system', content: 'Eres un asistente útil' },
98+
{ role: 'user', content: '¿Cuál es el significado de la vida?' }
99+
];
100+
101+
// Generación de chat
102+
await llm.generate(chat);
103+
console.log('Llama dice:', llm.response);
104+
};
105+
```
106+
107+
## :calling: Aplicaciones de demostración
108+
109+
Actualmente alojamos algunos ejemplos de [aplicaciones](https://github.com/software-mansion/react-native-executorch/tree/main/apps) que muestran casos de uso de nuestra biblioteca:
110+
111+
- `llm` - Aplicación de chat que muestra el uso de LLMs
112+
- `speech-to-text` - Modelo Whisper listo para tareas de transcripción
113+
- `computer-vision` - Tareas relacionadas con visión por computadora
114+
- `text-embeddings` - Cálculo de representaciones de texto para búsqueda semántica
115+
116+
Si deseas ejecutar una aplicación de demostración, navega al directorio del proyecto e instala las dependencias con:
117+
118+
```bash
119+
yarn
120+
```
121+
122+
Luego, dependiendo de la plataforma, elige iOS o Android:
123+
124+
```bash
125+
yarn expo run:< ios | android >
126+
```
127+
128+
> [!WARNING]
129+
> Ejecutar LLMs requiere una cantidad significativa de RAM. Si experimentas cierres inesperados de la aplicación, intenta aumentar la cantidad de RAM asignada al emulador.
130+
131+
## :robot: Modelos listos para usar
132+
133+
Nuestra biblioteca incluye varios modelos de IA listos para usar; la lista completa está disponible en la documentación. Si te interesa ejecutar tu propio modelo de IA, primero debes exportarlo al formato `.pte`. Las instrucciones para hacerlo están disponibles en la [API de Python](https://docs.pytorch.org/executorch/stable/using-executorch-export.html) y en el [README de optimum-executorch]((https://github.com/huggingface/optimum-executorch?tab=readme-ov-file#option-2-export-and-load-separately)).
134+
135+
## :balance_scale: Licencia
136+
137+
Esta biblioteca está licenciada bajo [La Licencia MIT](./LICENSE).
138+
139+
## :soon: ¿Qué sigue?
140+
141+
Para conocer nuestros próximos planes y desarrollos, visita nuestros [hitos](https://github.com/software-mansion/react-native-executorch/milestones).
142+
143+
## React Native ExecuTorch es creado por Software Mansion
144+
145+
Desde 2012, [Software Mansion](https://swmansion.com) es una agencia de software con experiencia en el desarrollo de aplicaciones web y móviles. Somos colaboradores principales de React Native y expertos en resolver todo tipo de problemas relacionados con esta tecnología. Podemos ayudarte a construir tu próximo producto soñado – [Contrátanos](https://swmansion.com/contact/projects?utm_source=react-native-executorch&utm_medium=readme).
146+
147+
[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=react-native-executorch-github 'Software Mansion')](https://swmansion.com)

0 commit comments

Comments
 (0)