Update README.md

README.md

@@ -1,3 +1,51 @@
 ---
 license: other
 ---
+
+# Koala: A Dialogue Model for Academic Research
+This repo contains the weights of the Koala 7B model produced at Berkeley. It is the result of combining the diffs from https://huggingface.co/young-geng/koala with the original Llama 7B model.
+
+This version has then been converted to HF format.
+
+The following commands were run to produce this repo:
+```
+git clone https://github.com/young-geng/EasyLM
+
+git clone https://huggingface.co/TheBloke/llama-13b
+
+mkdir koala_diffs && cd koala_diffs && wget https://huggingface.co/young-geng/koala/resolve/main/koala_13b_diff_v2
+
+cd EasyLM
+
+PYTHON_PATH="${PWD}:$PYTHONPATH" python \
+-m EasyLM.models.llama.convert_torch_to_easylm \
+--checkpoint_dir=/content/llama-13b \
+--output_file=/content/llama-13b-LM \
+--streaming=True
+
+PYTHON_PATH="${PWD}:$PYTHONPATH" python \
+-m EasyLM.scripts.diff_checkpoint --recover_diff=True \
+--load_base_checkpoint='params::/content/llama-13b-LM' \
+--load_target_checkpoint='params::/content/koala_diffs/koala_13b_diff_v2' \
+--output_file=/content/koala_13b.diff.weights \
+--streaming=True
+
+PYTHON_PATH="${PWD}:$PYTHONPATH" python \
+-m EasyLM.models.llama.convert_easylm_to_hf --model_size=7b \
+--output_dir=/content/koala-13B-HF \
+--load_checkpoint='params::/content/koala_13b.diff.weights' \
+--tokenizer_path=/content/llama-13b/tokenizer.model
+```
+
+Check out the following links to learn more about the Berkeley Koala model.
+* [Blog post](https://bair.berkeley.edu/blog/2023/04/03/koala/)
+* [Online demo](https://koala.lmsys.org/)
+* [EasyLM: training and serving framework on GitHub](https://github.com/young-geng/EasyLM)
+* [Documentation for running Koala locally](https://github.com/young-geng/EasyLM/blob/main/docs/koala.md)
+
+## License
+The model weights are intended for academic research only, subject to the
+[model License of LLaMA](https://github.com/facebookresearch/llama/blob/main/MODEL_CARD.md),
+[Terms of Use of the data generated by OpenAI](https://openai.com/policies/terms-of-use),
+and [Privacy Practices of ShareGPT](https://chrome.google.com/webstore/detail/sharegpt-share-your-chatg/daiacboceoaocpibfodeljbdfacokfjb).
+Any other usage of the model weights, including but not limited to commercial usage, is strictly prohibited.