OllieStanley
commited on
Commit
·
ca75c97
1
Parent(s):
cecdd87
Update README.md
Browse files
README.md
CHANGED
@@ -4,7 +4,7 @@ license: other
|
|
4 |
|
5 |
# OpenAssistant LLaMa 30B SFT 6
|
6 |
|
7 |
-
Due to the license attached to
|
8 |
|
9 |
Thanks to Mick for writing the `xor_codec.py` script which enables this process
|
10 |
|
@@ -14,9 +14,9 @@ Note: This process applies to `oasst-sft-6-llama-30b` model. The same process ca
|
|
14 |
|
15 |
**This process is tested only on Linux (specifically Ubuntu). Some users have reported that the process does not work on Windows. We recommend using WSL if you only have a Windows machine.**
|
16 |
|
17 |
-
To use OpenAssistant
|
18 |
|
19 |
-
Ensure your
|
20 |
|
21 |
```
|
22 |
f856e9d99c30855d6ead4d00cc3a5573 consolidated.00.pth
|
@@ -26,7 +26,9 @@ ea0405cdb5bc638fee12de614f729ebc consolidated.03.pth
|
|
26 |
4babdbd05b8923226a9e9622492054b6 params.json
|
27 |
```
|
28 |
|
29 |
-
|
|
|
|
|
30 |
|
31 |
1. Create a clean Python **3.10** virtual environment & activate it:
|
32 |
|
@@ -104,9 +106,9 @@ edd1a5897748864768b1fab645b31491 ./tokenizer_config.json
|
|
104 |
5cfcb78b908ffa02e681cce69dbe4303 ./pytorch_model-00002-of-00007.bin
|
105 |
```
|
106 |
|
107 |
-
**Important: You should now have the correct
|
108 |
|
109 |
-
7. Once you have
|
110 |
|
111 |
```
|
112 |
python xor_codec.py oasst-sft-6-llama-30b/ oasst-sft-6-llama-30b-xor/oasst-sft-6-llama-30b-xor/ llama30b_hf/
|
|
|
4 |
|
5 |
# OpenAssistant LLaMa 30B SFT 6
|
6 |
|
7 |
+
Due to the license attached to LLaMA models by Meta AI it is not possible to directly distribute LLaMA-based models. Instead we provide XOR weights for the OA models.
|
8 |
|
9 |
Thanks to Mick for writing the `xor_codec.py` script which enables this process
|
10 |
|
|
|
14 |
|
15 |
**This process is tested only on Linux (specifically Ubuntu). Some users have reported that the process does not work on Windows. We recommend using WSL if you only have a Windows machine.**
|
16 |
|
17 |
+
To use OpenAssistant LLaMA-Based Models, you need to have a copy of the original LLaMA model weights and add them to a `llama` subdirectory here.
|
18 |
|
19 |
+
Ensure your LLaMA 30B checkpoint matches the correct md5sums:
|
20 |
|
21 |
```
|
22 |
f856e9d99c30855d6ead4d00cc3a5573 consolidated.00.pth
|
|
|
26 |
4babdbd05b8923226a9e9622492054b6 params.json
|
27 |
```
|
28 |
|
29 |
+
*If you do not have a copy of the original LLaMA weights and cannot obtain one, you may still be able to complete this process. Some users have reported that [this model](https://huggingface.co/elinas/llama-30b-hf-transformers-4.29) can be used as a base for the XOR conversion. This will also allow you to skip to Step 7. However, we only support conversion starting from LLaMA original checkpoint and cannot provide support if you experience issues with this alternative approach.*
|
30 |
+
|
31 |
+
**Important: Follow these exact steps to convert your original LLaMA checkpoint to a HuggingFace Transformers-compatible format. If you use the wrong versions of any dependency, you risk ending up with weights which are not compatible with the XOR files.**
|
32 |
|
33 |
1. Create a clean Python **3.10** virtual environment & activate it:
|
34 |
|
|
|
106 |
5cfcb78b908ffa02e681cce69dbe4303 ./pytorch_model-00002-of-00007.bin
|
107 |
```
|
108 |
|
109 |
+
**Important: You should now have the correct LLaMA weights and be ready to apply the XORs. If the checksums above do not match yours, there is a problem.**
|
110 |
|
111 |
+
7. Once you have LLaMA weights in the correct format, you can apply the XOR decoding:
|
112 |
|
113 |
```
|
114 |
python xor_codec.py oasst-sft-6-llama-30b/ oasst-sft-6-llama-30b-xor/oasst-sft-6-llama-30b-xor/ llama30b_hf/
|