Update README.md

README.md

@@ -1,6 +1,81 @@
 ---
+pipeline_tag: text-generation
 inference: false
-license: other
+license: bigcode-openrail-m
+datasets:
+- bigcode/the-stack-dedup
+- tiiuae/falcon-refinedweb
+metrics:
+- code_eval
+- mmlu
+- arc
+- hellaswag
+- truthfulqa
+library_name: transformers
+tags:
+- code
+model-index:
+- name: StarCoderPlus
+  results:
+  - task:
+      type: text-generation
+    dataset:
+      type: openai_humaneval
+      name: HumanEval (Prompted)
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 26.7
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: MMLU (5-shot)
+      name: MMLU
+    metrics:
+    - name: Accuracy
+      type: Accuracy
+      value: 45.1
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: HellaSwag (10-shot)
+      name: HellaSwag
+    metrics:
+    - name: Accuracy
+      type: Accuracy
+      value: 77.3
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: ARC (25-shot)
+      name: ARC
+    metrics:
+    - name: Accuracy
+      type: Accuracy
+      value: 48.9
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: ThrutfulQA (0-shot)
+      name: ThrutfulQA
+    metrics:
+    - name: Accuracy
+      type: Accuracy
+      value: 37.9
+      verified: false
+extra_gated_prompt: >-
+  ## Model License Agreement
+
+  Please read the BigCode [OpenRAIL-M
+  license](https://huggingface.co/spaces/bigcode/bigcode-model-license-agreement)
+  agreement before accepting it.
+    
+extra_gated_fields:
+  I accept the above license agreement, and will use the Model complying with the set of use restrictions and sharing requirements: checkbox
 ---
 
 <!-- header start -->
@@ -21,12 +96,7 @@ license: other
 
 These files are GGML format model files for [Bigcode's StarcoderPlus](https://huggingface.co/bigcode/starcoderplus).
 
-GGML files are for CPU + GPU inference using [llama.cpp](https://github.com/ggerganov/llama.cpp) and libraries and UIs which support this format, such as:
-* [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
-* [KoboldCpp](https://github.com/LostRuins/koboldcpp)
-* [ParisNeo/GPT4All-UI](https://github.com/ParisNeo/gpt4all-ui)
-* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python)
-* [ctransformers](https://github.com/marella/ctransformers)
+Please note that these MPT GGMLs are **not compatible with llama.cpp**. Please see below for a list of tools known to work with these model files.
 
 ## Repositories available
 
@@ -35,31 +105,23 @@ GGML files are for CPU + GPU inference using [llama.cpp](https://github.com/gger
 * [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/bigcode/starcoderplus)
 
 <!-- compatibility_ggml start -->
-## Compatibility
+## Compatibilty
 
-### Original llama.cpp quant methods: `q4_0, q4_1, q5_0, q5_1, q8_0`
+These files are **not** compatible with llama.cpp.
 
-I have quantized these 'original' quantisation methods using an older version of llama.cpp so that they remain compatible with llama.cpp as of May 19th, commit `2d5db48`.
+Currently they can be used with:
+* KoboldCpp, a powerful inference engine based on llama.cpp, with good UI: [KoboldCpp](https://github.com/LostRuins/koboldcpp)
+* The ctransformers Python library, which includes LangChain support: [ctransformers](https://github.com/marella/ctransformers)
+* The GPT4All-UI which uses ctransformers: [GPT4All-UI](https://github.com/ParisNeo/gpt4all-ui)
+* [rustformers' llm](https://github.com/rustformers/llm)
+* The example `mpt` binary provided with [ggml](https://github.com/ggerganov/ggml)
 
-They should be compatible with all current UIs and libraries that use llama.cpp, such as those listed at the top of this README.
+As other options become available I will endeavour to update them here (do let me know in the Community tab if I've missed something!)
 
-### New k-quant methods: `q2_K, q3_K_S, q3_K_M, q3_K_L, q4_K_S, q4_K_M, q5_K_S, q6_K`
+## Tutorial for using GPT4All-UI
 
-These new quantisation methods are only compatible with llama.cpp as of June 6th, commit `2d43387`.
-
-They will NOT be compatible with koboldcpp, text-generation-ui, and other UIs and libraries yet. Support is expected to come over the next few days.
-
-## Explanation of the new k-quant methods
-
-The new methods available are:
-* GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw)
-* GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw.
-* GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw.
-* GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
-* GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw
-* GGML_TYPE_Q8_K - "type-0" 8-bit quantization. Only used for quantizing intermediate results. The difference to the existing Q8_0 is that the block size is 256. All 2-6 bit dot products are implemented for this quantization type.
-
-Refer to the Provided Files table below to see what files use which methods, and how.
+* [Text tutorial, written by **Lucas3DCG**](https://huggingface.co/TheBloke/MPT-7B-Storywriter-GGML/discussions/2#6475d914e9b57ce0caa68888)
+* [Video tutorial, by GPT4All-UI's author **ParisNeo**](https://www.youtube.com/watch?v=ds_U0TDzbzI)
 <!-- compatibility_ggml end -->
 
 ## Provided files
@@ -71,26 +133,6 @@ Refer to the Provided Files table below to see what files use which methods, and
 | starcoderplus.ggmlv3.q5_1.bin | q5_1 | 5 | 14.26 GB | 16.76 GB | Original llama.cpp quant method, 5-bit. Even higher accuracy, resource usage and slower inference. |
 | starcoderplus.ggmlv3.q8_0.bin | q8_0 | 8 | 20.11 GB | 22.61 GB | Original llama.cpp quant method, 8-bit. Almost indistinguishable from float16. High resource use and slow. Not recommended for most users. |
 
-
-**Note**: the above RAM figures assume no GPU offloading. If layers are offloaded to the GPU, this will reduce RAM usage and use VRAM instead.
-
-## How to run in `llama.cpp`
-
-I use the following command line; adjust for your tastes and needs:
-
-```
-./main -t 10 -ngl 32 -m starcoder-plus.ggmlv3.q5_0.bin --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### Instruction: Write a story about llamas\n### Response:"
-```
-Change `-t 10` to the number of physical CPU cores you have. For example if your system has 8 cores/16 threads, use `-t 8`.
-
-Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
-
-If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
-
-## How to run in `text-generation-webui`
-
-Further instructions here: [text-generation-webui/docs/llama.cpp-models.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp-models.md).
-
 <!-- footer start -->
 ## Discord
 
@@ -121,4 +163,94 @@ Thank you to all my generous patrons and donaters!
 
 # Original model card: Bigcode's StarcoderPlus
 
-No original model card was provided.
+# StarCoderPlus
+
+Play with the instruction-tuned StarCoderPlus at [StarChat-Beta](https://huggingface.co/spaces/HuggingFaceH4/starchat-playground).
+
+##  Table of Contents
+
+1. [Model Summary](##model-summary)
+2. [Use](##use)
+3. [Limitations](##limitations)
+4. [Training](##training)
+5. [License](##license)
+6. [Citation](##citation)
+
+## Model Summary
+
+StarCoderPlus is a fine-tuned version of [StarCoderBase](https://huggingface.co/bigcode/starcoderbase) on 600B tokens from the English web dataset [RedefinedWeb](https://huggingface.co/datasets/tiiuae/falcon-refinedweb) 
+combined with [StarCoderData](https://huggingface.co/datasets/bigcode/starcoderdata) from [The Stack (v1.2)](https://huggingface.co/datasets/bigcode/the-stack) and a Wikipedia dataset.
+It's a 15.5B parameter Language Model trained on English and 80+ programming languages. The model uses [Multi Query Attention](https://arxiv.org/abs/1911.02150),
+[a context window of 8192 tokens](https://arxiv.org/abs/2205.14135),  and was trained using the [Fill-in-the-Middle objective](https://arxiv.org/abs/2207.14255) on 1.6 trillion tokens. 
+
+- **Repository:** [bigcode/Megatron-LM](https://github.com/bigcode-project/Megatron-LM)
+- **Project Website:** [bigcode-project.org](https://www.bigcode-project.org)
+- **Point of Contact:** [contact@bigcode-project.org](mailto:contact@bigcode-project.org)
+- **Languages:** English & 80+ Programming languages
+
+
+## Use
+
+### Intended use
+
+The model was trained on English and GitHub code. As such it is _not_ an instruction model and commands like "Write a function that computes the square root." do not work well. However, the instruction-tuned version in [StarChat](hhttps://huggingface.co/spaces/HuggingFaceH4/starchat-playground) makes a capable assistant.
+
+**Feel free to share your generations in the Community tab!**
+
+### Generation
+```python
+# pip install -q transformers
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+checkpoint = "bigcode/starcoderplus"
+device = "cuda" # for GPU usage or "cpu" for CPU usage
+
+tokenizer = AutoTokenizer.from_pretrained(checkpoint)
+model = AutoModelForCausalLM.from_pretrained(checkpoint).to(device)
+
+inputs = tokenizer.encode("def print_hello_world():", return_tensors="pt").to(device)
+outputs = model.generate(inputs)
+print(tokenizer.decode(outputs[0]))
+```
+
+### Fill-in-the-middle
+Fill-in-the-middle uses special tokens to identify the prefix/middle/suffix part of the input and output:
+
+```python
+input_text = "<fim_prefix>def print_hello_world():\n    <fim_suffix>\n    print('Hello world!')<fim_middle>"
+inputs = tokenizer.encode(input_text, return_tensors="pt").to(device)
+outputs = model.generate(inputs)
+print(tokenizer.decode(outputs[0]))
+```
+
+### Attribution & Other Requirements
+
+The training code dataset of the model was filtered for permissive licenses only. Nevertheless, the model can generate source code verbatim from the dataset. The code's license might require attribution and/or other specific requirements that must be respected. We provide a [search index](https://huggingface.co/spaces/bigcode/starcoder-search) that let's you search through the pretraining data to identify where generated code came from and apply the proper attribution to your code.
+
+# Limitations
+
+The model has been trained on a mixture of English text from the web and GitHub code. Therefore it might encounter limitations when working with non-English text, and can carry the stereotypes and biases commonly encountered online.
+Additionally, the generated code should be used with caution as it may contain errors, inefficiencies, or potential vulnerabilities. For a more comprehensive understanding of the base model's code limitations, please refer to See [StarCoder paper](hhttps://arxiv.org/abs/2305.06161). 
+
+# Training
+StarCoderPlus is a fine-tuned version on 600B English and code tokens of StarCoderBase, which was pre-trained on 1T code tokens. Below are the fine-tuning details:
+
+## Model
+- **Architecture:** GPT-2 model with multi-query attention and Fill-in-the-Middle objective
+- **Finetuning steps:** 150k
+- **Finetuning tokens:** 600B
+- **Precision:** bfloat16
+
+## Hardware
+
+- **GPUs:** 512 Tesla A100
+- **Training time:** 14 days
+
+## Software
+
+- **Orchestration:** [Megatron-LM](https://github.com/bigcode-project/Megatron-LM)
+- **Neural networks:** [PyTorch](https://github.com/pytorch/pytorch)
+- **BP16 if applicable:** [apex](https://github.com/NVIDIA/apex)
+
+# License
+The model is licensed under the BigCode OpenRAIL-M v1 license agreement. You can find the full agreement [here](https://huggingface.co/spaces/bigcode/bigcode-model-license-agreement).