From 2845af9b7f09effe27081a0c42d59f1e66cd5c20 Mon Sep 17 00:00:00 2001 From: Guillaume Lample Date: Sat, 4 Mar 2023 17:15:03 +0100 Subject: [PATCH] added reference --- README.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0e311916f..e3d30c63f 100755 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ This repository is intended as a minimal, hackable and readable example to load [LLaMA](https://ai.facebook.com/blog/large-language-model-llama-meta-ai/) ([arXiv](https://arxiv.org/abs/2302.13971v1)) models and run inference. In order to download the checkpoints and tokenizer, fill this [google form](https://forms.gle/jk851eBVbX1m5TAv5) -### Setup +## Setup + In a conda env with pytorch / cuda available, run ``` pip install -r requirements.txt @@ -13,11 +14,13 @@ Then in this repository pip install -e . ``` -### Download +## Download + Once your request is approved, you will receive links to download the tokenizer and model files. Edit the `download.sh` script with the signed url provided in the email to download the model weights and tokenizer. -### Inference +## Inference + The provided `example.py` can be run on a single or multi-gpu node with `torchrun` and will output completions for two pre-defined prompts. Using `TARGET_FOLDER` as defined in `download.sh`: ``` torchrun --nproc_per_node MP example.py --ckpt_dir $TARGET_FOLDER/model_size --tokenizer_path $TARGET_FOLDER/tokenizer.model @@ -32,14 +35,28 @@ Different models require different MP values: | 33B | 4 | | 65B | 8 | -### FAQ +## FAQ + - [1. The download.sh script doesn't work on default bash in MacOS X](FAQ.md#1) - [2. Generations are bad!](FAQ.md#2) - [3. CUDA Out of memory errors](FAQ.md#3) - [4. Other languages](FAQ.md#4) -### Model Card +## Reference + +LLaMA: Open and Efficient Foundation Language Models -- https://arxiv.org/abs/2302.13971 + +``` +@article{touvron2023llama, + title={LLaMA: Open and Efficient Foundation Language Models}, + author={Touvron, Hugo and Lavril, Thibaut and Izacard, Gautier and Martinet, Xavier and Lachaux, Marie-Anne and Lacroix, Timoth{\'e}e and Rozi{\`e}re, Baptiste and Goyal, Naman and Hambro, Eric and Azhar, Faisal and Rodriguez, Aurelien and Joulin, Armand and Grave, Edouard and Lample, Guillaume}, + journal={arXiv preprint arXiv:2302.13971}, + year={2023} +} +``` + +## Model Card See [MODEL_CARD.md](MODEL_CARD.md) -### License +## License See the [LICENSE](LICENSE) file.