"Update README.md"

README.md

@@ -0,0 +1,329 @@
+---
+license: other
+datasets:
+- jondurbin/airoboros-gpt4-1.4
+---
+[![banner](https://maddes8cht.github.io/assets/buttons/Huggingface-banner.jpg)]()
+
+I'm constantly enhancing these model descriptions to provide you with the most relevant and comprehensive information
+
+# airoboros-mpt-30b-gpt4-1p4-five-epochs - GGUF
+- Model creator: [jondurbin](https://huggingface.co/jondurbin)
+- Original model: [airoboros-mpt-30b-gpt4-1p4-five-epochs](https://huggingface.co/jondurbin/airoboros-mpt-30b-gpt4-1p4-five-epochs)
+
+MPT-7b and MPT-30B are part of the family of Mosaic Pretrained Transformer (MPT) models, which use a modified transformer architecture optimized for efficient training and inference.
+
+
+
+# About GGUF format
+
+`gguf` is the current file format used by the [`ggml`](https://github.com/ggerganov/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](https://github.com/ggerganov/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:
+## Technical info
+
+This is a test of qlora fine-tuning of the mpt-30b model, __with 5 epochs__.
+
+qlora compatible model: https://huggingface.co/jondurbin/mpt-30b-qlora-compatible
+
+My fork of qlora with mpt-30b support: https://github.com/jondurbin/qlora
+
+Differences in the qlora scripts:
+
+- requires adding `--mpt True` for mpt-based models
+- uses `--num_train_epochs` instead of `--max_steps`
+- uses airoboros prompt format (mostly 1:1 with vicuna) rather than alpaca, and expects an input file in JSONL format with "instruction" and "response"
+
+__I think there's a bug in gradient accumulation, so if you try this, maybe set gradient accumulation steps to 1__
+
+See the mpt-30b-qlora-compatible model card for training details.
+
+*This doesn't seem as high quality as the llama-33b versions unfortunately, with one-off tests, but I don't have a great answer as to why.  Perhaps there are fewer forward layers that can be tuned?*
+
+## Overview
+
+This is mostly an extension of the previous gpt-4 series, but it's the first with mpt-30b as the base, and 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 [qlora](https://github.com/jondurbin/qlora)
+
+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. 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-mpt-30b-gpt4-1p4-five-epochs \
+  --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*
+```
+
+### License and usage
+
+This is a real gray area, here's why:
+
+- the dataset was generated with gpt-4, via https://github.com/jondurbin/airoboros
+- the ToS for openai API usage has a clause preventing the output from being used to train a model that __competes__ with OpenAI
+  - what does *compete* actually mean here?
+  - a 30b parameter model isn't anywhere near the quality of gpt-4, or even gpt-3.5, so I can't imagine this could credibly be considered competing in the first place
+  - if someone else uses the dataset to do the same, they wouldn't necessarily be violating the ToS because they didn't call the API, so I don't know how that works
+- the training data used in essentially all large language models includes a significant of copyrighted or otherwise unallowable licensing in the first place
+- other work using the self-instruct method, e.g. the original here: https://github.com/yizhongw/self-instruct released the data and model as apache-2
+
+I am purposingly not placing a license on here because I am not a lawyer and refuse to attempt to interpret all of the terms accordingly.  Your best bet is probably to avoid using this commercially, especially since it didn't perform quite as well as expected using qlora.
+
+***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.
+
+<center>
+
+[![GitHub](https://maddes8cht.github.io/assets/buttons/github-io-button.png)](https://maddes8cht.github.io)
+[![Stack Exchange](https://stackexchange.com/users/flair/26485911.png)](https://stackexchange.com/users/26485911)
+[![GitHub](https://maddes8cht.github.io/assets/buttons/github-button.png)](https://github.com/maddes8cht)
+[![HuggingFace](https://maddes8cht.github.io/assets/buttons/huggingface-button.png)](https://huggingface.co/maddes8cht)
+[![Twitter](https://maddes8cht.github.io/assets/buttons/twitter-button.png)](https://twitter.com/maddes1966)
+
+</center>