Update README.md

README.md

@@ -1,3 +1,262 @@
 ---
 license: mit
+datasets:
+- jondurbin/airoboros-gpt4-1.4.1
+- ehartford/dolphin
 ---
+
+
+# Airophin: A Partial NTK RoPE Scaled QLoRA Fine-tune of Llama-2-13b (GPTQ quantized)
+
+LoRA Weights can be found here: https://huggingface.co/bhenrym14/airoboros-13b-gpt4-1.4.1-PI-8192-LoRA
+
+fp16 weights can be found here: https://huggingface.co/bhenrym14/airophin-13b-pntk-16k-fp16
+
+## Overview
+
+This is a finetune of Llama-2-13b, intended to extend the useful context window to 16384 tokens. There are two training phases:
+1.  It is first trained on a long-context (>7000 to 8192 token range) subset of [dolphin](), a orca-like dataset. This amounts to roughly 110mm tokens, seen twice over two epochs. Airoboros-like training prompt was used. This took ~45 hours.
+2.  The model was then finetuned on [Jon Durbin's Airoboros 13B GPT4 1.4](https://huggingface.co/jondurbin/airoboros-13b-gpt4-1.4) for 3 epochs. This took ~17 hours.
+
+**This is a QLoRA fine-tune**. 
+
+All training was performed with 1x RTX 6000 Ada.
+
+## How to Use
+
+This model employs [Partial NTK Rope Scaling](https://github.com/jquesnelle/scaled-rope/pull/1). This methodology is not yet implemented natively in Transformers or Exllama (as of 7/21). There are two options to run this:
+1. Transformers (use bnb for quantization). Use [fp16 weights](https://huggingface.co/bhenrym14/airophin-13b-pntk-16k-fp16).
+2. Autogptq/GPTQ-for-Llama. Use these quantized weights.
+
+Each method will require replacing the `LlamaEmbedding` with `LlamaPartNTKScaledRotaryEmbedding`, with `max_position_embeddings=16384`. A monkeypatch can be found here.
+
+
+
+
+
+The easiest way is to use [oobabooga text-generation-webui](https://github.com/oobabooga/text-generation-webui) with ExLlama. You'll need to set max_seq_len to 8192 and compress_pos_emb to 4.
+
+If you wish to use AutoGPTQ/GPTQ-for-Llama instead, you'll need to patch in the appropriate RoPE scaling module. see: [replace_llama_rope_with_scaled_rope](https://github.com/bhenrym14/qlora-airoboros-longcontext/blob/main/scaledllama/llama_rope_scaled_monkey_patch.py)
+
+## Motivation
+Recent advancements in extending context by RoPE scaling ([kaiokendev](https://kaiokendev.github.io/til#extending-context-to-8k) and [meta AI)](https://arxiv.org/abs/2306.15595)) demonstrate the ability to extend the context window without (total) retraining. Finetuning has shown to be necessary to properly leverage the longer context. The superHOT LoRA is an adapter that has been fine-tuned on longer context (8192 tokens); even when applied to models trained on dissimilar datasets, it successfully extends the context window to which the model can attend. While it's impressive this adapter is so flexible, how much does performance suffer relative to a model that has been fine-tuned with the scaled embeddings from the start? This is an experiment to explore this.
+
+## Relative Performance (perplexity)
+| Model                                                | Context (tokens)     | Perplexity |
+| ---------------------------------------------------- | ----------- | ---------- |
+| TheBloke/airoboros-13B-gpt4-1-4-GPTQ     | 512        |    **7.42**    |
+| TheBloke/airoboros-13B-gpt4-1-4-SuperHOT-8K-GPTQ     | 512        |    8.86    |
+| **bhenrym14/airoboros-13b-gpt4-1.4.1-PI-8192-GPTQ**    | 512    | 7.94   |
+| ---------------------------------------------------- | ----------- | ---------- |
+| TheBloke/airoboros-13B-gpt4-1-4-GPTQ     | 2048        |    **5.02**    |
+| TheBloke/airoboros-13B-gpt4-1-4-SuperHOT-8K-GPTQ     | 2048        |    5.98    |
+| **bhenrym14/airoboros-13b-gpt4-1.4.1-PI-8192-GPTQ**    | 2048   | 5.28   |
+| ---------------------------------------------------- | ----------- | ---------- |
+| TheBloke/airoboros-13B-gpt4-1-4-GPTQ     | 4096        |    9848.0    |
+| TheBloke/airoboros-13B-gpt4-1-4-SuperHOT-8K-GPTQ     | 4096        |    5.80    |
+| **bhenrym14/airoboros-13b-gpt4-1.4.1-PI-8192-GPTQ**    | 4096   | **5.15**   |
+
+
+- For contexts shorter than the original 2048, the original model has lower perplexity. This is consistent with the literature. The gap shrinks with context length, with the original becoming incoherent beyond this point.
+- In terms of perplexity, this model outperforms the SuperHOT variant at all tested context lengths. I haven't used models with the SuperHOT LoRA enough to have any sense of performance differences, but feedback on the 33b variant suggests it is particularly noticable at longer context lengths. 
+- This comparison isn't perfect. I did use the 1.4.1 dataset, the quantization method is slightly different, and the finetuning method is different (QLoRA vs full). In short, there are other potentially influential variables responsible for these performance differences.
+
+This model could be a little undertrained. I'll update the weights if I end up training it longer and/or with better hyperparameters
+## Quantization:
+
+The merged model was quantized with AutoGPTQ (bits = 4, group_size = 128, desc_act = True).
+
+## Prompting:
+
+airoboros-like prompting remains. See the following from one of Jon Durbin's airoboros model cards:
+
+
+### Context obedient question answering
+
+By obedient, I mean the model was trained to ignore what it thinks it knows, and uses the context to answer the question.  The model was also tuned to limit the values to the provided context as much as possible to reduce hallucinations.
+
+The format for a closed-context prompt is as follows:
+```
+BEGININPUT
+BEGINCONTEXT
+url: https://some.web.site/123
+date: 2023-06-01
+... other metdata ...
+ENDCONTEXT
+[insert your text blocks here]
+ENDINPUT
+[add as many other blocks, in the exact same format]
+BEGININSTRUCTION
+[insert your instruction(s).  The model was tuned with single questions, paragraph format, lists, etc.]
+ENDINSTRUCTION
+```
+
+It's also helpful to add "Don't make up answers if you don't know." to your instruction block to make sure if the context is completely unrelated it doesn't make something up.
+
+*The __only__ prompts that need this closed context formating are closed-context instructions.  Normal questions/instructions do not!*
+
+I know it's a bit verbose and annoying, but after much trial and error, using these explicit delimiters helps the model understand where to find the responses and how to associate specific sources with it.
+- `BEGININPUT` - denotes a new input block
+- `BEGINCONTEXT` - denotes the block of context (metadata key/value pairs) to associate with the current input block
+- `ENDCONTEXT` - denotes the end of the metadata block for the current input
+- [text] - Insert whatever text you want for the input block, as many paragraphs as can fit in the context.
+- `ENDINPUT` - denotes the end of the current input block
+- [repeat as many input blocks in this format as you want]
+- `BEGININSTRUCTION` - denotes the start of the list (or one) instruction(s) to respond to for all of the input blocks above.
+- [instruction(s)]
+- `ENDINSTRUCTION` - denotes the end of instruction set
+
+It sometimes works without `ENDINSTRUCTION`, but by explicitly including that in the prompt, the model better understands that all of the instructions in the block should be responded to.
+
+Here's a trivial, but important example to prove the point:
+```
+BEGININPUT
+BEGINCONTEXT
+date: 2021-01-01
+url: https://web.site/123
+ENDCONTEXT
+In a shocking turn of events, blueberries are now green, but will be sticking with the same name.
+ENDINPUT
+BEGININSTRUCTION
+What color are bluberries?  Source?
+ENDINSTRUCTION
+```
+
+And the response:
+```
+Blueberries are now green.
+Source:
+date: 2021-01-01
+url: https://web.site/123
+```
+
+The prompt itself should be wrapped in the vicuna1.1 template if you aren't using fastchat with the conv-template vicuna_v1.1 as described:
+
+```
+USER: BEGININPUT
+BEGINCONTEXT
+date: 2021-01-01
+url: https://web.site/123
+ENDCONTEXT
+In a shocking turn of events, blueberries are now green, but will be sticking with the same name.
+ENDINPUT
+BEGININSTRUCTION
+What color are bluberries?  Source?
+ENDINSTRUCTION
+ ASSISTANT:
+```
+
+### Coding
+
+You can ask for fairly complex coding instructions, e.g. (be sure to wrap with vicuna style prompt):
+
+```
+Create a python application with the following requirements:
+- Asyncio FastAPI webserver
+- ping endpoint that returns the current date in JSON format
+- file upload endpoint, which calculates the file's sha256 checksum, and checks postgres to deduplicate
+```
+
+Or:
+
+```
+Write a multi-threaded TCP server in C that accepts a "GET [key]" input and "SET [key] [value]" input, and uses a binary tree to get and store the input values.
+```
+
+You can optionally add a single space and "PLAINFORMAT" at the end of your prompt to avoid backticks, explanations, etc. and just print the code, e.g.:
+
+```
+Write a websocket application in node.js. PLAINFORMAT
+```
+
+### Word games / trivia
+
+```
+USER: This anagram of "silent" is what you do when paying attention and hearing someone.
+ASSISTANT: listen
+```
+
+```
+USER: Give me a list of 7 words that start with EN
+ASSISTANT: 1. Endlessly
+2. Enthusiastically
+3. Enormously
+4. Enveloping
+5. Enduring
+6. Enlightening
+7. Encouraging
+```
+
+### Multiple choice
+
+```
+USER: Which of the following astronomical objects is composed primarily of ice and rock, and is located in the Kuiper Belt?
+
+A) Mercury
+B) Venus
+C) Pluto
+D) Jupiter
+ASSISTANT: C, Pluto
+```
+
+### Writing
+
+<details>
+  <summary>Write a resignation letter in the style of a pirate captain, in which you resign from your position as janitor.</summary>
+
+  Response:
+```
+ASSISTANT: Captain Jack Sparrow here, as ye be knowin', has been forced to abandon me post as Janitor o' th' Festering Cesspool, which be a filthy hole o' water that we be callin' home.
+
+Ye may be thinkin' what could ha' driven me to leave me duties an' take me leave o' this sorry establishment? Well, ye'd be right in thinkin' so, for it be th' greed o' them what runs th' place that be drivin' me away. They've been fattenin' their pockets on me back while I've been slavin' me guts out cleanin' up their messes.
+
+No more, me hearties! Me time o' servin' th' rich an' powerful be done, an' I'm takin' me leave o' this stinkin' hole forever! Me destiny lies elsewhere, an' it be time I pursued it. Ye may think ye've seen th' last o' me, but ye'd be wrong, for th' winds o' change be blowin', an' me ship be ready to set sail on th' high seas o' justice.
+
+So, farewell ye scurvy dogs, ye who've made me life a living hell. I leave ye with me favorite saying: "ARRRGGGHHH, ye scurvy dogs!" An' remember, ye ain't never gonna see me comin', for me shadow be castin' long an' dark on th' horizon</summary>
+```
+
+</details>
+
+### Jokes
+
+```
+USER: Tell me a joke about bananas.
+ASSISTANT: What did the banana say when it got hit by a bus? R.I.P.E.
+```
+
+### Riddles (not great, but slightly better)
+
+```
+USER: What has a neck but no head?
+ASSISTANT: A bottle.
+```
+
+### Multi-character conversations
+
+```
+USER: Characters:
+ - Yoda, the ever clever jedi master.
+ - Homer Simpson, you know, the goofy yellow guy.
+ - USER/Jon - don't generate any speech or actions on behalf of Jon
+
+Rules:
+ - be sure to use the manerisms and speaking style of the characters correctly
+ - surround character actions with asterisks
+ - always put quotes around words spoken by the characters
+ - use a new line for each character's actions or speech
+ - always prefix actions/speech with the character's name and colon
+ - only generate text and actions on behalf of Yoda or Homer, and never anyone else
+
+Conversation will revolve around the grapes, in a local cafe with delicious coffee.
+
+Generate a single interaction between Yoda and Homer to start, with one sentence each.
+ASSISTANT: Yoda: "Mmm, these grapes are quite delicious, Master Homer."
+
+Homer: "Oh yeah, Yoda! They're the best grapes I've ever had!"
+USER: *enters the cafe* Sorry I'm late guys!
+ASSISTANT: Yoda: "No need to apologize, Jon. We were just enjoying these delightful grapes."
+
+Homer: "Yeah, man! It's not every day you get to eat grapes with a real-life Jedi Master!"
+
+*Yoda raises an eyebrow*
+```