Edit model card

OpenAssistant LLaMA 30B RLHF 2

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.

Thanks to Mick for writing the xor_codec.py script which enables this process

The Process

Note: This process applies to oasst-rlhf-2-llama-30b-7k-steps model. The same process can be applied to other models in future, but the checksums will be different..

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.

Some users have also had problems with line endings causing JSON XORs not to work. Please ensure your JSON files have LF (not CR/LF) line endings.

To use OpenAssistant LLaMA-Based Models, you should have a copy of the original LLaMA model weights and add them to a llama subdirectory here. If you cannot obtain the original LLaMA, see the note in italic below for a possible alternative.

Ensure your LLaMA 30B checkpoint matches the correct md5sums:

f856e9d99c30855d6ead4d00cc3a5573  consolidated.00.pth
d9dbfbea61309dc1e087f5081e98331a  consolidated.01.pth
2b2bed47912ceb828c0a37aac4b99073  consolidated.02.pth
ea0405cdb5bc638fee12de614f729ebc  consolidated.03.pth
4babdbd05b8923226a9e9622492054b6  params.json

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

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.

  1. Create a clean Python 3.10 virtual environment & activate it:
python3.10 -m venv xor_venv
source xor_venv/bin/activate
  1. Clone transformers repo and switch to tested version:
git clone https://github.com/huggingface/transformers.git
cd transformers
git checkout d04ec99bec8a0b432fc03ed60cea9a1a20ebaf3c
pip install .
  1. Install exactly these dependency versions:
pip install torch==1.13.1 accelerate==0.18.0 sentencepiece==0.1.98 protobuf==3.20.1
  1. Check pip freeze output:
transformers @ file:///mnt/data/koepf/transformers
  1. While in transformers repo root, run HF LLaMA conversion script:
python src/transformers/models/llama/convert_llama_weights_to_hf.py --input_dir <input_path_llama_base>  --output_dir <output_path_llama30b_hf> --model_size 30B
  1. Run find . -type f -exec md5sum "{}" + in the conversion target directory (output_dir). This should produce exactly the following checksums if your files are correct:
462a2d07f65776f27c0facfa2affb9f9  ./pytorch_model-00007-of-00007.bin
e1dc8c48a65279fb1fbccff14562e6a3  ./pytorch_model-00003-of-00007.bin
9cffb1aeba11b16da84b56abb773d099  ./pytorch_model-00001-of-00007.bin
aee09e21813368c49baaece120125ae3  ./generation_config.json
92754d6c6f291819ffc3dfcaf470f541  ./pytorch_model-00005-of-00007.bin
3eddc6fc02c0172d38727e5826181adb  ./pytorch_model-00004-of-00007.bin
eeec4125e9c7560836b4873b6f8e3025  ./tokenizer.model
99762d59efa6b96599e863893cf2da02  ./pytorch_model-00006-of-00007.bin
598538f18fed1877b41f77de034c0c8a  ./config.json
fdb311c39b8659a5d5c1991339bafc09  ./tokenizer.json
fecfda4fba7bfd911e187a85db5fa2ef  ./pytorch_model.bin.index.json
edd1a5897748864768b1fab645b31491  ./tokenizer_config.json
6b2e0a735969660e720c27061ef3f3d3  ./special_tokens_map.json
5cfcb78b908ffa02e681cce69dbe4303  ./pytorch_model-00002-of-00007.bin

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.

  1. Once you have LLaMA weights in the correct format, you can apply the XOR decoding:
python xor_codec.py oasst-rlhf-2-llama-30b-7k-steps/ oasst-rlhf-2-llama-30b-7k-steps-xor/ llama30b_hf/

You should expect to see one warning message during execution:

Exception when processing 'added_tokens.json'

This is normal. If similar messages appear for other files, something has gone wrong.

  1. Now run find . -type f -exec md5sum "{}" + in the output directory (here oasst-rlhf-2-llama-30b-7k-steps). You should get a file with exactly these checksums:
d08594778f00abe70b93899628e41246  ./pytorch_model-00007-of-00007.bin
f11acc069334434d68c45a80ee899fe5  ./pytorch_model-00003-of-00007.bin
9f41bd4d5720d28567b3e7820b4a8023  ./pytorch_model-00001-of-00007.bin
27b0dc092f99aa2efaf467b2d8026c3f  ./added_tokens.json
148bfd184af630a7633b4de2f41bfc49  ./generation_config.json
b6e90377103e9270cbe46b13aed288ec  ./pytorch_model-00005-of-00007.bin
4c5941b4ee12dc0d8e6b5ca3f6819f4d  ./pytorch_model-00004-of-00007.bin
eeec4125e9c7560836b4873b6f8e3025  ./tokenizer.model
2c92d306969c427275f34b4ebf66f087  ./pytorch_model-00006-of-00007.bin
9a4d2468ecf85bf07420b200faefb4af  ./config.json
deb33dd4ffc3d2baddcce275a00b7c1b  ./tokenizer.json
13a3641423840eb89f9a86507a90b2bf  ./pytorch_model.bin.index.json
ed59bfee4e87b9193fea5897d610ab24  ./tokenizer_config.json
704373f0c0d62be75e5f7d41d39a7e57  ./special_tokens_map.json
ed991042b2a449123824f689bb94b29e  ./pytorch_model-00002-of-00007.bin

If so you have successfully decoded the weights and should be able to use the model with HuggingFace Transformers. If your checksums do not match those above, there is a problem.

license: other

Downloads last month
Hosted inference API

Unable to determine this model’s pipeline type. Check the docs .