From 603c596616aa3a967139c3d1e9d4358fabd89f73 Mon Sep 17 00:00:00 2001
From: oobabooga <112222186+oobabooga@users.noreply.github.com>
Date: Tue, 18 Jul 2023 10:29:56 -0700
Subject: [PATCH] Add LLaMA-v2 conversion instructions

---
 docs/LLaMA-v2-model.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 docs/LLaMA-v2-model.md

diff --git a/docs/LLaMA-v2-model.md b/docs/LLaMA-v2-model.md
new file mode 100644
index 00000000..ac06ccf6
--- /dev/null
+++ b/docs/LLaMA-v2-model.md
@@ -0,0 +1,35 @@
+# LLaMA-v2
+
+To convert LLaMA-v2 from the `.pth` format provided by Meta to transformers format, follow the steps below:
+
+1) `cd` into your `llama` folder (the one containing `download.sh` and the models that you downloaded):
+
+```
+cd llama
+```
+
+2) Clone the code in [this PR](https://github.com/huggingface/transformers/pull/24891):
+
+```
+git clone 'https://github.com/ArthurZucker/transformers' -b llama-tests
+
+```
+
+3) Create symbolic links from the downloaded folders to names that the conversion script can recognize:
+
+```
+ln -s llama-2-7b 7B
+ln -s llama-2-13b 13B
+```
+
+4) Do the conversions:
+
+```
+mkdir llama-2-7b-hf llama-2-13b-hf
+python ./transformers/src/transformers/models/llama/convert_llama_weights_to_hf.py --input_dir . --model_size 7B --output_dir llama-2-7b-hf --safe_serialization true
+python ./transformers/src/transformers/models/llama/convert_llama_weights_to_hf.py --input_dir . --model_size 13B --output_dir llama-2-13b-hf --safe_serialization true
+```
+
+5) Move the output folders inside `text-generation-webui/models`
+
+6) Have fun