Skip to content

Commit a38e0a1

Browse files
Readme amendments (#335)
## Description * Fix Heading in `Quickstart - Running Llama` and make it compatible * Update link to ready-made models in table of contents * Remove unnecessary horizontal bars from `Quickstart - Running Llama` * Rephrase section with minimal supported versions * Make more visible names of examples in `Example` section * And emoji to warning section and unlink from table of content as it is a part of the `Example` section ### 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 - [x] iOS - [x] Android ### Testing instructions No testing necessary. ### Screenshots Not applicable ### Related issues Not applicable ### Checklist - [x] 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. --> --------- Co-authored-by: Jakub Gonera <[email protected]>
1 parent 4f0c5fd commit a38e0a1

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,11 @@
1111
**Table of contents:**
1212

1313
- [Compatibility](#compatibility)
14-
- [Ready-made models 🤖](#readymade-models-)
14+
- [Ready-made models 🤖](#ready-made-models-)
1515
- [Documentation 📚](#documentation-)
16-
- [🦙 Quickstart - Running Llama](#-quickstart---running-llama)
16+
- [Quickstart - Running Llama 🦙](#quickstart---running-llama-)
1717
- [Minimal supported versions](#minimal-supported-versions)
1818
- [Examples 📲](#examples-)
19-
- [Warning](#warning)
2019
- [License](#license)
2120
- [What's next?](#whats-next)
2221

@@ -35,7 +34,7 @@ To run any AI model in ExecuTorch, you need to export it to a `.pte` format. If
3534
Take a look at how our library can help build you your React Native AI features in our docs:
3635
https://docs.swmansion.com/react-native-executorch
3736

38-
# 🦙 **Quickstart - Running Llama**
37+
## **Quickstart - Running Llama** 🦙
3938

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

@@ -47,8 +46,6 @@ yarn add react-native-executorch
4746
cd ios && pod install && cd ..
4847
```
4948

50-
---
51-
5249
### 2️⃣ **Setup & Initialization**
5350

5451
Add this to your component file:
@@ -72,8 +69,6 @@ function MyComponent() {
7269
}
7370
```
7471

75-
---
76-
7772
### 3️⃣ **Run the model!**
7873

7974
```tsx
@@ -91,16 +86,18 @@ const handleGenerate = async () => {
9186

9287
## Minimal supported versions
9388

94-
The minimal supported version is 17.0 for iOS and Android 13.
89+
The minimal supported version are:
90+
* iOS 17.0
91+
* Android 13
9592

9693
## Examples 📲
9794

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

100-
- examples/llm - chat application showcasing use of LLMs
101-
- examples/speech-to-text - Whisper and Moonshine models ready for transcription tasks
102-
- examples/computer-vision - computer vision related tasks
103-
- examples/text-embeddings - computing text representations for semantic search
97+
- `examples/llm` - chat application showcasing use of LLMs
98+
- `examples/speech-to-text` - Whisper and Moonshine models ready for transcription tasks
99+
- `examples/computer-vision` - computer vision related tasks
100+
- `examples/text-embeddings` - computing text representations for semantic search
104101

105102
If you would like to run it, navigate to it's project directory, for example `examples/llm` from the repository root and install dependencies with:
106103

@@ -128,7 +125,7 @@ or iOS:
128125
yarn expo run:ios
129126
```
130127

131-
### Warning
128+
### Warning ⚠️
132129

133130
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.
134131

0 commit comments

Comments
 (0)