"Update README.md"

README.md

@@ -0,0 +1,210 @@
+---
+model-index:
+- name: rocket-3b
+  results: []
+license: cc-by-sa-4.0
+language:
+- en
+base_model: stabilityai/stablelm-3b-4e1t
+---
+[![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
+
+# rocket-3B - GGUF
+- Model creator: [pansophic](https://huggingface.co/pansophic)
+- Original model: [rocket-3B](https://huggingface.co/pansophic/rocket-3B)
+
+# StableLM
+This is a Model based on StableLM. 
+Stablelm is a familiy of Language Models by Stability AI.
+
+## Note:
+Current (as of 2023-11-15) implementations of Llama.cpp only support GPU offloading up to 34 Layers with these StableLM Models.
+The model will crash immediately if -ngl is larger than 34.
+The model works fine however without any gpu acceleration.
+
+
+
+# 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:
+<img src="https://cdn-uploads.huggingface.co/production/uploads/6501bfe0493fd9c8c2e32402/BmbkjOkcTm-YMa-unolmJ.png" alt="Rocket Logo" width="800" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+
+# Rocket-3B 🦝
+<b>Rocket</b> 🦝 is a 3 billion large language model that was trained on a mix of publicly available datasets using [Direct Preference Optimization (DPO)](https://arxiv.org/abs/2305.18290). The prompt format used is <b>ChatML</b>.
+
+
+## Model description
+- **Model type:** A 3B parameter GPT-like model fine-tuned on a mix of publicly available datasets using DPO.
+- **Language(s) (NLP):** Primarily English
+- **License:** CC-BY-SA-4.0
+- **Finetuned from model:** [Stability AI](https://huggingface.co/stabilityai/stablelm-3b-4e1t)
+
+
+## Performance
+Despite its compact dimensions, the model achieves outstanding scores in both MT-Bench [MT-Bench](https://huggingface.co/spaces/lmsys/mt-bench) and [AlpacaEval](https://tatsu-lab.github.io/alpaca_eval/) benchmarks, surpassing the performance of considerably larger models. 
+
+| Model | Size | Alignment | MT-Bench (score) | AlpacaEval (win rate %) |
+|-------------|-----|----|---------------|--------------|
+| StableLM-Tuned-α 🦜| 7B | SFT |2.75| -|
+| MPT-Chat |  7B | SFT |5.42| -|
+| Falcon-Instruct 🦅|  40B | SFT |5.17 |45.71|
+| Orca-2|  13B | SFT |6.15 |-|
+| Xwin-LMv0.1 | 7B| PPO | 6.19| 87.83|
+| Llama2-Chat 🦙| 7B |RLHF |6.26| 71.37|
+| TÜLU 2 🐫|  7B | DPO |6.27| 85.1|
+| Guanaco 🦙| 65B | SFT |6.41| 71.80|
+| **Rocket** 🦝 | **3B** | **DPO** | **6.56** | **79.75** |
+| Llama2-Chat 🦙| 13B |RLHF |6.65| 81.09|
+| Zephyr-7b-α 🪁 |7B|  DPO| 6.88| -|
+| Vicuna v1.3 🦙| 33B | SFT |7.12 |88.99|
+| Zephyr-7b-β 🪁 |7B|  DPO| 7.34| 90.60|
+| WizardLM v1.0 🦙| 70B |SFT |7.71 |-|
+| GPT-3.5-turbo | - |RLHF |7.94 |89.37|
+
+Specifically, across various categories within the MT-Bench evaluation, Rocket-3B demonstrates impressive performance when compared to larger open models such as Llama2-Chat-7B, Falcon-40B-Instruct, and Guanaco-65B.
+
+
+![MT-Bench results](https://cdn-uploads.huggingface.co/production/uploads/6501bfe0493fd9c8c2e32402/5Tv4-4w4zNKAAjiLNGu7A.png)
+
+## MT-Bench detailed score for first and second turn
+In MT-Bench, Rocket 🦝 scores 6.99 in the first turn and 6.13 in the second turn, with an average score of 6.56. These scores reflect the model's performance in understanding and generating text during different parts of a conversation.
+
+| Model | First turn | Second turn | Average |
+|-------------|-----|----|---------------|
+| **Rocket** 🦝 | **6.99** | **6.13** | **6.56** |
+
+
+## AlpacaEval detailed scores
+In AlpacaEval, Rocket 🦝 achieves a near 80% win rate, coupled with an average response length of 1,242 tokens, indicating its effectiveness in producing detailed responses.
+
+| Model | Win rate | Std error | Average length |
+|-------------|-----|----|---------------|
+| **Rocket** 🦝 | **79.75** | **1.42** | **1242** |
+
+
+## Other benchmarks
+
+| Metric                | Value                     |
+|-----------------------|---------------------------|
+| Average               | 51.00             |
+| ARC (25-shot)         | 50.51          |
+| HellaSwag (10-shot)   | 76.45    |
+| MMLU (5-shot)        | 45.51        |
+| TruthfulQA (0-shot)   | 54.38   |
+| Winogrande (5-shot)   | 67.8   |
+| GSM8K (5-shot)        | 37.91        |
+| DROP (3-shot)        | 24.49        |
+
+
+## Intended uses & limitations
+Initially, we fine-tuned the model using a dataset created by merging and curating multiple datasets, available on the HuggingFace Hub. This dataset will be released to the public soon. We further enhanced the model's performance using DPO, selecting samples from the [openbmb/UltraFeedback](https://huggingface.co/datasets/openbmb/UltraFeedback) and [BAAI/JudgeLM-100K](https://huggingface.co/datasets/BAAI/JudgeLM-100K) datasets. The outcome is a highly effective chat model with a 3 billion parameter scale.
+
+
+## Input Format
+The model is trained with the ChatML format:
+
+```
+<|im_start|>system
+System message here.<|im_end|>
+<|im_start|>user
+Your message here!<|im_end|>
+<|im_start|>assistant
+```
+
+Here's how you can run the model using 🤗 Transformers:
+
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
+
+model = AutoModelForCausalLM.from_pretrained("pansophic/rocket-3B", trust_remote_code=True, torch_dtype=torch.bfloat16).to("cuda")
+tokenizer = AutoTokenizer.from_pretrained("pansophic/rocket-3B", trust_remote_code=True, torch_dtype=torch.bfloat16)
+streamer = TextStreamer(tokenizer)
+
+prompt = """<|im_start|>system
+{system}<|im_end|>
+<|im_start|>user
+{user}<|im_end|>
+<|im_start|>assistant
+"""
+
+system = "You are a helpful assistant."
+user = "How are you?"
+
+# Apply the ChatML format
+prompt = prompt.format(system=system, user=user)
+
+# Tokenize the prompt
+inputs = tokenizer(prompt, return_tensors="pt", return_attention_mask=False).to("cuda")
+generated_text = model.generate(**inputs, max_length=3084, top_p=0.95, do_sample=True, temperature=0.7, use_cache=True, streamer=streamer)
+
+# <|im_start|>system
+# You are a chef who makes everything sound like a secret culinary masterpiece, even everyday meals.<|im_end|>
+# <|im_start|>user
+# How to cook an omelette?<|im_end|>
+# <|im_start|>assistant
+# Ah, the art of crafting the perfect omelette, a secret culinary masterpiece indeed.
+# Begin by gently whisking two to three eggs in a mixing bowl, and then pour the silky liquid into a non-stick pan.
+# Allow the eggs to dance and sizzle as you swiftly tilt the pan to spread the joy throughout the entire omelette universe.
+# As the edges begin to set, fold the omelette in half with a gentle flourish, and you'll witness a stunning display of culinary prowess.
+# Enjoy this enchanting creation, and you'll be transported to a world of secret culinary mastery.<|im_end|>
+```
+
+## Bias, Risks, and Limitations
+Unlike ChatGPT, which incorporates in-the-loop filtering of responses and is aligned during the RLHF phase for safe completions, our model lacks these features. Consequently, it may generate problematic outputs, particularly when prompted in certain ways. Below is the score of the model on Toxigen benchmark.
+
+The pretraining dataset is comprised of a filtered mixture of open-source large-scale datasets available on the [HuggingFace Hub](https://huggingface.co/datasets): Falcon RefinedWeb extract ([Penedo et al., 2023](https://huggingface.co/datasets/tiiuae/falcon-refinedweb)), RedPajama-Data ([Together Computer., 2023](https://github.com/togethercomputer/RedPajama-Data)) and The Pile ([Gao et al., 2020](https://arxiv.org/abs/2101.00027)) both without the *Books3* subset, and StarCoder ([Li et al., 2023](https://arxiv.org/abs/2305.06161)).  
+
+| Metric                | Value                     |
+|-----------------------|---------------------------|
+| Toxigen (0-shot)         | 43.40          |
+
+**The model name is inspired by the small but formidable character from 'Guardians of the Galaxy'. Similar to its namesake, this model, with its 3 billion parameters, showcases remarkable efficiency and effectiveness, challenging larger models despite its smaller size."*
+
+*Model card adapted from [Zephyr Beta](https://huggingface.co/HuggingFaceH4/zephyr-7b-beta/blob/main/README.md) and [Tulu-2-7B](https://huggingface.co/allenai/tulu-2-7b/blob/main/README.md)*
+
+***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>