Create README.md

README.md

@@ -0,0 +1,243 @@
+---
+datasets:
+- jondurbin/airoboros-2.1
+- kmfoda/booksum
+---
+
+
+
+# RoPE Scaled QLoRA Fine-tune of Llama-2 13b on airoboros-2.1, with Long Context Pretraining (fp16 weights)
+
+
+## Overview
+
+This is a finetune of Llama-2-13b, intended to extend the useful context window to 16384 tokens via position interpolation (PI). There are two training phases:
+1. Scaling the RoPE embeddings by a factor of 0.25 (linear method), train on 16384 token sequences from the `chapter` component of the the [booksum](https://huggingface.co/datasets/kmfoda/booksum) dataset. (one epoch, ~ 150mm tokens)
+2. The model was then finetuned on [Jon Durbin's Airoboros 2.1 dataset](https://huggingface.co/datasets/jondurbin/airoboros-2.1), with same scaling approach, for 2 epochs.
+
+**This is a (merged) QLoRA fine-tune (rank 64)**. 
+
+The finetune was performed with 1x RTX 6000 Ada.
+
+
+## How to Use
+
+This model employs linear RoPE scaling, which is now has native support in Transformers (be sure to update it if you have issues). Use it as you would with any normal context length variant.
+
+Please comment with any questions. 
+
+Ooba use: Be sure to increase the `Truncate the prompt up to this length` parameter to 16384 to utilize the full context capabilities.
+
+## Motivation
+
+Given the excellent performance of llama-2 13b finetunes relative to llama 33b, I have received several requests for a 16k model using the latest airoboros dataset. Furthermore, while partial NTK scaling appears to be better for retaining short context performance, it is not natively supported in `transformers` and is thus not as accessible to less technical audiences. This model is designed to offer long context capabilites with the stylistic characteristics of the new airoboros dataset.
+
+## Relative Performance (wikitext perplexity)
+
+| Context (tokens)  | bhenrym14/airoboros-l2-13b-PI-16k-fp16| bhenrym14/airophin-v2-13b-PI-8k-fp16 | bhenrym14/airophin-13b-pntk-16k-fp16| bhenrym14/airoboros-13b-gpt4-1.4.1-PI-8192-fp16 |bhenrym14/airoboros-33b-gpt4-1.4.1-lxctx-PI-16384-fp16  | jondurbin/airoboros-l2-13b-gpt4-1.4.1 |
+| --- | ---| ----- | -----| ------| --- |
+| 512 | 7.67 | 7.38 | 7.62 | 8.24 | 7.90 | **7.23** |
+| 1024 | 6.15 | 5.99 | 6.20 | 6.71 | 6.17 | **5.85**  |
+| 2048 | 5.29 | 5.22 | 5.38 | 5.87 | 5.23 | **5.07** |
+| 4096 | 4.94 | 4.90 | 5.08 | 5.50 | 4.91 | **4.77** |
+| 8192 | **4.71** | **4.71** | 4.90 | 5.32 | Not Tested | 57.1 |
+| 12000 | **4.54** | 55 | 4.82 | 56.1 | Not Tested | Not Tested |
+
+- This model is very competitive with the Llama-1 33b extended context variants. In fact, it outperforms bhenrym14/airoboros-33b-gpt4-1.4.1-lxctx-PI-16384-fp16 everywhere <=8192 tokens. Do note however that 33b model is only trained on the 1.4.1 Airoboros dataset. Additionally this model only requires a PI factor of 2, whereas the 33b-16k llama1 model requires a factor of 8. It is clear from my experiments and those in the literature that higher factors pose larger challenges for performance recovery.
+- Not presented here, but this model outperforms the base llama-2-13b on MMLU-fs with a score of ~57.3 (computed on subset of full benchmark). If this score ends up being be replicated on the HF LLM leaderboard, **this would be the highest mmlu score for a 13b extended context model** and #4 overall for 13b (as of 8/15).
+- Feedback regarding real-world performance is appreciated. Llama2-13b is known to have repetition problems. Does the extensive training on top of the base model help ameliorate this tendency? Perplexity and MMLU are great, but the don't tell the whole story.
+
+## Prompting:
+
+This model was trained with airoboros-like prompting in the 2nd phase. 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*
+```