Skip to content

Commit 6bdd5eb

Browse files
Update README.md
1 parent a5c0e63 commit 6bdd5eb

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

README.md

+16-10
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
1-
# sherpa
1+
# Demo App for llama.cpp Model
2+
This app is a demo of the llama.cpp model that tries to recreate an offline chatbot, working similar to OpenAI's ChatGPT. The source code for this app is available on GitHub.
23

3-
A new Flutter project.
4+
The app was developed using Flutter and implements ggerganov/llama.cpp, recompiled to work on mobiles. Please note that Meta officially distributes the LLaMA models, and they will not be provided by the app developers.
45

5-
## Getting Started
6+
To run this app, you need to download the 7B llama model from Meta for research purposes. You should rename it to `ggml-model.bin` and place it in your device's download folder.
67

7-
This project is a starting point for a Flutter application.
8+
Additionally, you can fine-tune the ouput with preprompts to improve its performance.
9+
10+
## Usage
11+
To use this app, follow these steps:
12+
13+
1. Download the `ggml-model.bin` from Meta for research purposes.
14+
2. Rename the downloaded file to `ggml-model.bin`.
15+
3. Place the file in your device's download folder.
16+
4. Run the app on your mobile device.
17+
18+
## Disclaimer
19+
Please note that the llama.cpp models are owned and officially distributed by Meta. This app only serves as a demo for the model's capabilities and functionality. The developers of this app do not provide the LLaMA models and are not responsible for any issues related to their usage.
820

9-
A few resources to get you started if this is your first Flutter project:
1021

11-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
1322

14-
For help getting started with Flutter development, view the
15-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.

0 commit comments

Comments
 (0)