metadata

datasets:
  - Open-Orca/OpenOrca
  - zetavg/ShareGPT-Processed
  - bigcode/starcoderdata
  - togethercomputer/RedPajama-Data-1T
  - tiiuae/falcon-refinedweb
metrics:
  - code_eval
  - accuracy
pipeline_tag: text-generation
tags:
  - code
  - text-generation-inference
model-index:
  - name: long_llama_3b_instruct
    results:
      - task:
          name: Code Generation
          type: code-generation
        dataset:
          name: HumanEval
          type: openai_humaneval
        metrics:
          - name: pass@1
            type: pass@1
            value: 0.12
            verified: false

I'm constantly enhancing these model descriptions to provide you with the most relevant and comprehensive information

long_llama_3b_instruct - GGUF

Model creator: syzymon
Original model: long_llama_3b_instruct

OpenLlama is a free reimplementation of the original Llama Model which is licensed under Apache 2 license.

About GGUF format

gguf is the current file format used by the ggml library. A growing list of Software is using it and can therefore use this model. The core project making use of the ggml library is the llama.cpp project by Georgi Gerganov

Quantization variants

There is a bunch of quantized files available to cater to your specific needs. Here's how to choose the best option for you:

Legacy quants

Q4_0, Q4_1, Q5_0, Q5_1 and Q8 are legacy quantization types. Nevertheless, they are fully supported, as there are several circumstances that cause certain model not to be compatible with the modern K-quants.

Note:

Now there's a new option to use K-quants even for previously 'incompatible' models, although this involves some fallback solution that makes them not real K-quants. More details can be found in affected model descriptions. (This mainly refers to Falcon 7b and Starcoder models)

K-quants

K-quants are designed with the idea that different levels of quantization in specific parts of the model can optimize performance, file size, and memory load. So, if possible, use K-quants. With a Q6_K, you'll likely find it challenging to discern a quality difference from the original model - ask your model two times the same question and you may encounter bigger quality differences.

Original Model Card:

LongLLaMA: Focused Transformer Training for Context Scaling

TLDR

This repo contains LongLLaMA-Instruct-3Bv1.1 that is for research purposes only.

LongLLaMA is built upon the foundation of OpenLLaMA and fine-tuned using the Focused Transformer (FoT) method. We release a smaller 3B base variant (not instruction tuned) of the LongLLaMA model on a permissive license (Apache 2.0) and inference code supporting longer contexts on Hugging Face. 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

Base models

Focused Transformer: Contrastive Training for Context Scaling (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 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 passkey retrieval task, it can handle inputs of length $256k$.

	LongLLaMA-3B	LongLLaMA-3Bv1.1	LongLLaMA-7B (coming soon)	LongLLaMA-13B (coming soon)
Source model	OpenLLaMA-3B	OpenLLaMA-3Bv2	-	-
Source model tokens	1T	1 T	-	-
Fine-tuning tokens	10B	5B	-	-
Memory layers	6, 12, 18	6, 12, 18	-	-

Instruction/Chat tuning

In the fine_tuning subfolder we provide the code that was used to create LongLLaMA-Instruct-3Bv1.1, an instruction-tuned version of LongLLaMA-3Bv1.1. We used OpenOrca (instructions) and zetavg/ShareGPT-Processed (chat) datasets for tuning.

Usage

Requirements

pip install --upgrade pip
pip install transformers==4.30  sentencepiece accelerate

Loading model

import torch
from transformers import LlamaTokenizer, AutoModelForCausalLM

tokenizer = LlamaTokenizer.from_pretrained("syzymon/long_llama_3b_instruct")
model = AutoModelForCausalLM.from_pretrained("syzymon/long_llama_3b_instruct", 
                                            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.

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.

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

import torch
from transformers import LlamaTokenizer, AutoModelForCausalLM

tokenizer = LlamaTokenizer.from_pretrained("syzymon/long_llama_3b_instruct")
model = AutoModelForCausalLM.from_pretrained(
    "syzymon/long_llama_3b_instruct", 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, but in this case, they will be limited to the original context length of $2048$.

from transformers import LlamaTokenizer, LlamaForCausalLM
import torch

tokenizer = LlamaTokenizer.from_pretrained("syzymon/long_llama_3b_instruct")
model = LlamaForCausalLM.from_pretrained("syzymon/long_llama_3b_instruct", 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. 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. Refer to our paper Focused Transformer: Contrastive Training for Context Scaling for more details.

We manage to achieve good performance on the passkey retrieval task from Landmark Attention: Random-Access Infinite Context Length for Transformers. The code for generating the prompt and running the model is located in examples/passkey.py.

LongLLaMA

Our LongLLaMA 3B model also shows improvements when using long context on two downstream tasks, TREC question classification and WebQS question answering.

Context/Dataset	TREC	WebQS
$2K$	67.0	21.2
$4K$	71.6	21.4
$6K$	72.9	22.2
$8K$	73.3	22.4

LongLLaMA retains performance on tasks that do not require long context. We provide a comparison with OpenLLaMA on lm-evaluation-harness in the zero-shot setting.

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

Starting with v1.1 models we have decided to use EleutherAI implementation of lm-evaluation-harness wit a slight modification, that adds <bos> token at beginning of input sequence. The results are provided in the table below.

description	LongLLaMA-3B	OpenLLaMA-3Bv2	LongLLaMA-3Bv1.1	LongLLaMA-Instruct-3Bv1.1
anli_r1/acc	0.32	0.33	0.31	0.33
anli_r2/acc	0.33	0.35	0.33	0.35
anli_r3/acc	0.35	0.38	0.35	0.38
arc_challenge/acc	0.34	0.33	0.32	0.36
arc_challenge/acc_norm	0.37	0.36	0.36	0.37
arc_easy/acc	0.67	0.68	0.68	0.7
arc_easy/acc_norm	0.63	0.63	0.63	0.63
boolq/acc	0.68	0.67	0.66	0.77
hellaswag/acc	0.48	0.53	0.52	0.52
hellaswag/acc_norm	0.65	0.7	0.69	0.68
openbookqa/acc	0.28	0.28	0.28	0.28
openbookqa/acc_norm	0.38	0.39	0.37	0.41
piqa/acc	0.73	0.77	0.77	0.78
piqa/acc_norm	0.75	0.78	0.77	0.77
record/em	0.87	0.87	0.86	0.85
record/f1	0.88	0.88	0.87	0.86
rte/acc	0.6	0.53	0.62	0.7
truthfulqa_mc/mc1	0.24	0.22	0.21	0.25
truthfulqa_mc/mc2	0.38	0.35	0.35	0.4
wic/acc	0.5	0.5	0.5	0.54
winogrande/acc	0.6	0.66	0.63	0.65
Avg score	0.53	0.53	0.53	0.55

We also provide the results on human-eval. We cut the generated text after either

"\ndef "
"\nclass "
"\nif __name__"

	OpenLLaMA-3Bv2	LongLLaMA-3Bv1.1	LongLLaMA-Instruct-3Bv1.1
pass@1	0.09	0.12	0.12

Authors

Citation

To cite this work please use

@misc{tworkowski2023focused,
      title={Focused Transformer: Contrastive Training for Context Scaling}, 
      author={Szymon Tworkowski and Konrad Staniszewski and Mikołaj Pacek and Yuhuai Wu and Henryk Michalewski and Piotr Miłoś},
      year={2023},
      eprint={2307.03170},
      archivePrefix={arXiv},
      primaryClass={cs.CL}
}

License

The code and base models checkpoints are licensed under Apache License, Version 2.0.
The instruction/chat tuned models are for research purposes only.
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 checkpoints and the EasyLM library.

End of original Model File

Please consider to support my work

Coming Soon: I'm in the process of launching a sponsorship/crowdfunding campaign for my work. I'm evaluating Kickstarter, Patreon, or the new GitHub Sponsors platform, and I am hoping for some support and contribution to the continued availability of these kind of models. Your support will enable me to provide even more valuable resources and maintain the models you rely on. Your patience and ongoing support are greatly appreciated as I work to make this page an even more valuable resource for the community.