Add README.md

README.md

@@ -5,4 +5,197 @@ datasets:
 pipeline_tag: text-generation
 tags:
 - text-generation-inference
----
+---
+<p align="center" width="100%"><img src="https://raw.githubusercontent.com/CStanKonrad/long_llama/main/assets/longllama.png" alt="LongLLaMA" style="width: 50%;  display: block; margin: auto;"></p>
+
+# LongLLaMA: Focused Transformer Training for Context Scaling
+
+
+[Colab](https://colab.research.google.com/github/CStanKonrad/long_llama/blob/main/long_llama_colab.ipynb) | [TLDR](#TLDR) | [Overview](#Overview) | [Usage](#Usage) | [LongLLaMA performance](#LongLLaMA-performance) | [Authors](#Authors) | [Citation](#Citation) | [License](License) | [Acknowledgments](#Acknowledgments)
+
+## TLDR
+This repository contains the research preview of **LongLLaMA, a large language model capable of handling long contexts of 256k tokens or even more**. 
+
+LongLLaMA is built upon the foundation of [OpenLLaMA](https://github.com/openlm-research/open_llama) and fine-tuned using the Focused Transformer (FoT) method.  We release a smaller 3B variant of the LongLLaMA model on a permissive license (Apache 2.0) and inference code supporting longer contexts on [Hugging Face](https://huggingface.co/syzymon/long_llama_3b). Our model weights can serve as the drop-in replacement of LLaMA in existing implementations (for short context up to 2048 tokens). Additionally, we provide evaluation results and comparisons against the original OpenLLaMA models. Stay tuned for further updates.
+
+
+## Overview
+[Focused Transformer: Contrastive Training for Context Scaling](TODO) (FoT) presents a simple method for endowing language models with the ability to handle context consisting possibly of millions of tokens while training on significantly shorter input. FoT permits a subset of attention layers to access a memory cache of (key, value) pairs to extend the context length. The distinctive aspect of FoT is its training procedure, drawing from contrastive learning. Specifically, we deliberately expose the memory attention layers to both relevant and irrelevant keys (like negative samples from unrelated documents). This strategy incentivizes the model to differentiate keys connected with semantically diverse values, thereby enhancing their structure. This, in turn, makes it possible to extrapolate the effective context length much beyond what is seen in training. 
+
+
+**LongLLaMA** is an [OpenLLaMA](https://github.com/openlm-research/open_llama) model finetuned with the FoT method,
+with three layers used for context extension. Crucially, LongLLama is able to extrapolate much beyond the context length seen in training: $8k$. E.g., in the key retrieval task, it can handle inputs of length $256k$.
+
+<center>
+
+|  | [LongLLaMA-3B](https://huggingface.co/syzymon/long_llama_3b) | LongLLaMA-7B<br />*(coming soon)*|  LongLLaMA-13B<br />*(coming soon)*|
+|----------------|----------|-----------|-----------|
+| Source model         | [OpenLLaMA-3B](https://huggingface.co/openlm-research/open_llama_3b_easylm)      | -        | - |
+| Source model tokens     | 1T      | -       | - |
+| Fine-tuning tokens  | 10B     | -     | -|
+| Memory layers         |  6, 12, 18        |  -        | -|
+
+</center>
+
+
+## Usage
+
+See also: [colab with an example usage of LongLLaMA](https://colab.research.google.com/github/CStanKonrad/long_llama/blob/main/long_llama_colab.ipynb).
+### Requirements
+```
+pip install --upgrade pip
+pip install transformers==4.30  sentencepiece accelerate
+```
+
+### Loading model
+```python
+import torch
+from transformers import LlamaTokenizer, AutoModelForCausalLM
+
+tokenizer = LlamaTokenizer.from_pretrained("syzymon/long_llama_3b")
+model = AutoModelForCausalLM.from_pretrained("syzymon/long_llama_3b", 
+                                            torch_dtype=torch.float32, 
+                                            trust_remote_code=True)
+```
+
+### Input handling and generation
+LongLLaMA uses the Hugging Face interface, the long input given to the model will be 
+split into context windows and loaded into the memory cache.
+```python
+prompt = "My name is Julien and I like to"
+input_ids = tokenizer(prompt, return_tensors="pt").input_ids
+outputs = model(input_ids=input_ids)
+```
+During the model call, one can provide the parameter `last_context_length` (default $1024$), which specifies the number of tokens left in the last context window. Tuning this parameter can improve generation as the first layers do not have access to memory. See details in [How LongLLaMA handles long inputs](#How-LongLLaMA-handles-long-inputs).
+
+```python
+generation_output = model.generate(
+    input_ids=input_ids,
+    max_new_tokens=256,
+    num_beams=1,
+    last_context_length=1792,
+    do_sample=True,
+    temperature=1.0,
+)
+print(tokenizer.decode(generation_output[0]))
+```
+
+### Additional configuration
+LongLLaMA has several other parameters:
+* `mem_layers` specifies layers endowed with memory (should be either an empty list or a list of all memory layers specified in the description of the checkpoint).
+* `mem_dtype` allows changing the type of memory cache
+* `mem_attention_grouping` can trade off speed for reduced memory usage. 
+  When equal to `(4, 2048)`, the memory layers will process at most $4*2048$ queries at once ($4$ heads and $2048$ queries for each head).
+
+```python
+import torch
+from transformers import LlamaTokenizer, AutoModelForCausalLM
+
+tokenizer = LlamaTokenizer.from_pretrained("syzymon/long_llama_3b")
+model = AutoModelForCausalLM.from_pretrained(
+    "syzymon/long_llama_3b", torch_dtype=torch.float32, 
+    mem_layers=[], 
+    mem_dtype='bfloat16',
+    trust_remote_code=True,
+    mem_attention_grouping=(4, 2048),
+)
+```
+
+
+### Drop-in use with LLaMA code
+ LongLLaMA checkpoints can also be used as a drop-in replacement for LLaMA checkpoints in [Hugging Face implementation of LLaMA](https://huggingface.co/docs/transformers/main/model_doc/llama), but in this case, they will be limited to the original context length of $2048$.
+
+```python
+from transformers import LlamaTokenizer, LlamaForCausalLM
+import torch
+
+tokenizer = LlamaTokenizer.from_pretrained("syzymon/long_llama_3b")
+model = LlamaForCausalLM.from_pretrained("syzymon/long_llama_3b", torch_dtype=torch.float32)
+```
+
+
+### How LongLLaMA handles long inputs
+Inputs over $2048$ tokens are automatically split into windows $w_1, \ldots, w_m$. The first $m-2$ windows contain $2048$ tokens each, $w_{m-1}$ has no more than $2048$ tokens, and $w_m$ contains the number of tokens specified by `last_context_length`. The model processes the windows one by one extending the memory cache after each. If `use_cache` is `True`, the last window will not be loaded to the memory cache but to the local (generation) cache.
+
+The memory cache stores $(key, value)$ pairs for each head of the specified memory layers `mem_layers`. In addition to this, it stores attention masks. 
+
+If `use_cache=True` (which is the case in generation), LongLLaMA will use two caches: the memory cache for the specified layers and the local (generation) cache for all layers. When the local cache exceeds $2048$ elements, its content is moved to the memory cache for the memory layers.
+
+For simplicity, context extension is realized with a memory cache and full attention in this repo. Replacing this simple mechanism with a KNN search over an external database is possible with systems like [Faiss](https://github.com/facebookresearch/faiss). This potentially would enable further context length scaling. We leave this as a future work.
+
+
+## LongLLaMA performance
+We present some illustrative examples of LongLLaMA results and refer to our paper [Focused Transformer: Contrastive Training for Context Scaling](TODO) for more details.
+
+We manage to achieve good performance on the passkey retrieval task from [Landmark Attention: Random-Access Infinite Context Length for Transformers](https://arxiv.org/abs/2305.16300). The code for generating the prompt and running the model is located in `examples/passkey.py`. 
+
+<p align="center" width="100%">
+<img src="https://raw.githubusercontent.com/CStanKonrad/long_llama/main/assets/plot_passkey.png" alt="LongLLaMA" style="width: 70%; min-width: 300px; display: block; margin: auto;">
+</p>
+
+Our LongLLaMA 3B model also shows improvements when using long context on two downstream tasks, TREC question classification and WebQS question answering. 
+<center>
+
+
+| Context/Dataset | TREC  | WebQS |
+| --- | --- | --- |
+| $2K$ | 67.0 |  21.2 |
+| $4K$ | 71.6 | 21.4 |
+| $6K$ | 72.9 | 22.2 |
+| $8K$ | **73.3** | **22.4** |
+
+</center>
+
+LongLLama retains performance on tasks that do not require long context. We provide a comparison with OpenLLaMA
+on [lm-evaluation-harness](https://github.com/EleutherAI/lm-evaluation-harness) in a zero-shot setting. 
+<center>
+
+| Task/Metric | OpenLLaMA-3B | LongLLaMA-3B |
+|----------------|----------|-----------|
+| anli_r1/acc | 0.33 | 0.32 |
+| anli_r2/acc | 0.32 | 0.33 |
+| anli_r3/acc | 0.35 | 0.35 |
+| arc_challenge/acc | 0.34 | 0.34 |
+| arc_challenge/acc_norm | 0.37 | 0.37 |
+| arc_easy/acc | 0.69 | 0.68 |
+| arc_easy/acc_norm | 0.65 | 0.63 |
+| boolq/acc | 0.68 | 0.68 |
+| hellaswag/acc | 0.49 | 0.48 |
+| hellaswag/acc_norm | 0.67 | 0.65 |
+| openbookqa/acc | 0.27 | 0.28 |
+| openbookqa/acc_norm | 0.40 | 0.38 |
+| piqa/acc | 0.75 | 0.73 |
+| piqa/acc_norm | 0.76 | 0.75 |
+| record/em | 0.88 | 0.87 |
+| record/f1 | 0.89 | 0.87 |
+| rte/acc | 0.58 | 0.60 |
+| truthfulqa_mc/mc1 | 0.22 | 0.24 |
+| truthfulqa_mc/mc2 | 0.35 | 0.38 |
+| wic/acc | 0.48 | 0.50 |
+| winogrande/acc | 0.62 | 0.60 |
+| Avg score | 0.53 | 0.53 |
+
+</center>
+
+## Authors
+- [Szymon Tworkowski](https://scholar.google.com/citations?user=1V8AeXYAAAAJ&hl=en)
+- [Konrad Staniszewski](https://scholar.google.com/citations?user=CM6PCBYAAAAJ)
+- [Mikołaj Pacek](https://scholar.google.com/citations?user=eh6iEbQAAAAJ&hl=en&oi=ao)
+- [Henryk Michalewski](https://scholar.google.com/citations?user=YdHW1ycAAAAJ&hl=en)
+- [Yuhuai Wu](https://scholar.google.com/citations?user=bOQGfFIAAAAJ&hl=en)
+- [Piotr Miłoś](https://scholar.google.pl/citations?user=Se68XecAAAAJ&hl=pl&oi=ao)
+
+
+## Citation
+To cite this work please use
+```bibtex
+TODO
+```
+
+
+## License
+The code and checkpoints are licensed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+Some of the examples use external code (see headers of files for copyright notices and licenses).
+
+## Acknowledgments
+We gratefully acknowledge the TPU Research Cloud program, which was instrumental to our research by providing significant computational resources. We are also grateful to Xinyang Geng and Hao Liu for releasing [OpenLLaMA](https://github.com/openlm-research/open_llama) checkpoints and the [EasyLM](https://github.com/young-geng/EasyLM) library.