Skip to content

Commit 8402566

Browse files
readme : update hot-topics & models, detail windows release in usage (#3615)
* Update README.md * Update README.md * Update README.md * move "Running on Windows" section below "Prepare data and run" --------- Co-authored-by: Georgi Gerganov <[email protected]>
1 parent 40e5ce0 commit 8402566

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Inference of [LLaMA](https://arxiv.org/abs/2302.13971) model in pure C/C++
1111

1212
### Hot topics
13-
13+
- ‼️ BPE tokenizer update: existing Falcon and Starcoder `.gguf` models will need to be reconverted: [#3252](https://github.com/ggerganov/llama.cpp/pull/3252)
1414
- ‼️ Breaking change: `rope_freq_base` and `rope_freq_scale` must be set to zero to use the model default values: [#3401](https://github.com/ggerganov/llama.cpp/pull/3401)
1515
- Parallel decoding + continuous batching support added: [#3228](https://github.com/ggerganov/llama.cpp/pull/3228) \
1616
**Devs should become familiar with the new API**
@@ -89,16 +89,17 @@ as the main playground for developing new features for the [ggml](https://github
8989
- [X] [Vicuna](https://github.com/ggerganov/llama.cpp/discussions/643#discussioncomment-5533894)
9090
- [X] [Koala](https://bair.berkeley.edu/blog/2023/04/03/koala/)
9191
- [X] [OpenBuddy 🐶 (Multilingual)](https://github.com/OpenBuddy/OpenBuddy)
92-
- [X] [Pygmalion 7B / Metharme 7B](#using-pygmalion-7b--metharme-7b)
92+
- [X] [Pygmalion/Metharme](#using-pygmalion-7b--metharme-7b)
9393
- [X] [WizardLM](https://github.com/nlpxucan/WizardLM)
94-
- [X] [Baichuan-7B](https://huggingface.co/baichuan-inc/baichuan-7B) and its derivations (such as [baichuan-7b-sft](https://huggingface.co/hiyouga/baichuan-7b-sft))
95-
- [X] [Aquila-7B](https://huggingface.co/BAAI/Aquila-7B) / [AquilaChat-7B](https://huggingface.co/BAAI/AquilaChat-7B)
96-
- [X] [Aquila2-7B](https://huggingface.co/BAAI/Aquila2-7B) / [AquilaChat2-7B](https://huggingface.co/BAAI/AquilaChat2-7B) / [AquilaChat2-34B](https://huggingface.co/BAAI/AquilaChat2-34B) / [Aquila2-34B](https://huggingface.co/BAAI/Aquila2-34B)
94+
- [X] [Baichuan 1 & 2](https://huggingface.co/models?search=baichuan-inc/Baichuan) + [derivations](https://huggingface.co/hiyouga/baichuan-7b-sft)
95+
- [X] [Aquila 1 & 2](https://huggingface.co/models?search=BAAI/Aquila)
9796
- [X] [Starcoder models](https://github.com/ggerganov/llama.cpp/pull/3187)
9897
- [X] [Mistral AI v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1)
9998
- [X] [Refact](https://huggingface.co/smallcloudai/Refact-1_6B-fim)
100-
- [X] [Bloom](https://github.com/ggerganov/llama.cpp/pull/3553)
99+
- [X] [Persimmon 8B](https://github.com/ggerganov/llama.cpp/pull/3410)
101100
- [X] [MPT](https://github.com/ggerganov/llama.cpp/pull/3417)
101+
- [X] [Bloom](https://github.com/ggerganov/llama.cpp/pull/3553)
102+
102103

103104
**Bindings:**
104105

@@ -207,7 +208,7 @@ https://user-images.githubusercontent.com/1991296/224442907-7693d4be-acaa-4e01-8
207208
208209
## Usage
209210
210-
Here are the steps for the LLaMA-7B model.
211+
Here are the end-to-end binary build and model conversion steps for the LLaMA-7B model.
211212
212213
### Get the Code
213214
@@ -574,6 +575,18 @@ python3 convert.py models/7B/
574575

575576
When running the larger models, make sure you have enough disk space to store all the intermediate files.
576577

578+
### Running on Windows with prebuilt binaries
579+
580+
You will find prebuilt Windows binaries on the release page.
581+
582+
Simply download and extract the latest zip package of choice: (e.g. `llama-b1380-bin-win-avx2-x64.zip`)
583+
584+
From the unzipped folder, open a terminal/cmd window here and place a pre-converted `.gguf` model file. Test out the main example like so:
585+
586+
```
587+
.\main -m llama-2-7b.Q4_0.gguf -n 128
588+
```
589+
577590
### Memory/Disk Requirements
578591

579592
As the models are currently fully loaded into memory, you will need adequate disk space to save them and sufficient RAM to load them. At the moment, memory and disk requirements are the same.

0 commit comments

Comments
 (0)