Upload README.md

README.md

@@ -0,0 +1,451 @@
+---
+base_model: 01-ai/Yi-6B
+inference: false
+license: other
+license_link: LICENSE
+license_name: yi-license
+model_creator: 01-ai
+model_name: Yi 6B
+model_type: yi
+pipeline_tag: text-generation
+prompt_template: '{prompt}
+
+  '
+quantized_by: TheBloke
+widget:
+- output:
+    text: " an eerie sense that something is just not right\u2026\nBetween the two\
+      \ worlds lies The Forgotten Kingdom - home to creatures long since thought extinct\
+      \ and ancient magic so strong it defies belief! Only here can you find what\
+      \ has been lost for centuries: An Elixir Of Life which will restore youth and\
+      \ vitality if only those who seek its power are brave enough to face up against\
+      \ all manner of dangers lurking in this mysterious land! But beware; some say\
+      \ there may even exist powerful entities beyond our comprehension whose intentions\
+      \ towards humanity remain unclear at best ---- they might want nothing more\
+      \ than destruction itself rather then anything else from their quest after immortality\
+      \ (and maybe someone should tell them about modern medicine)? In any event though\
+      \ \u2013 one thing remains true regardless : whether or not success comes easy\
+      \ depends entirely upon how much effort we put into conquering whatever challenges\
+      \ lie ahead along with having faith deep down inside ourselves too ;) So let\u2019\
+      s get started now shall We?"
+  text: There's a place where time stands still. A place of breath taking wonder,
+    but also
+---
+<!-- markdownlint-disable MD041 -->
+
+<!-- header start -->
+<!-- 200823 -->
+<div style="width: auto; margin-left: auto; margin-right: auto">
+<img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
+</div>
+<div style="display: flex; justify-content: space-between; width: 100%;">
+    <div style="display: flex; flex-direction: column; align-items: flex-start;">
+        <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
+    </div>
+    <div style="display: flex; flex-direction: column; align-items: flex-end;">
+        <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
+    </div>
+</div>
+<div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
+<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
+<!-- header end -->
+
+# Yi 6B - AWQ
+- Model creator: [01-ai](https://huggingface.co/01-ai)
+- Original model: [Yi 6B](https://huggingface.co/01-ai/Yi-6B)
+
+<!-- description start -->
+## Description
+
+This repo contains AWQ model files for [01-ai's Yi 6B](https://huggingface.co/01-ai/Yi-6B).
+
+These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
+
+
+### About AWQ
+
+AWQ is an efficient, accurate and blazing-fast low-bit weight quantization method, currently supporting 4-bit quantization. Compared to GPTQ, it offers faster Transformers-based inference with equivalent or better quality compared to the most commonly used GPTQ settings.
+
+It is supported by:
+
+- [Text Generation Webui](https://github.com/oobabooga/text-generation-webui) - using Loader: AutoAWQ
+- [vLLM](https://github.com/vllm-project/vllm) - Llama and Mistral models only
+- [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
+- [Transformers](https://huggingface.co/docs/transformers) version 4.35.0 and later, from any code or client that supports Transformers
+- [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) - for use from Python code
+
+<!-- description end -->
+<!-- repositories-available start -->
+## Repositories available
+
+* [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Yi-6B-AWQ)
+* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Yi-6B-GPTQ)
+* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Yi-6B-GGUF)
+* [01-ai's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/01-ai/Yi-6B)
+<!-- repositories-available end -->
+
+<!-- prompt-template start -->
+## Prompt template: None
+
+```
+{prompt}
+
+```
+
+<!-- prompt-template end -->
+
+
+<!-- README_AWQ.md-provided-files start -->
+## Provided files, and AWQ parameters
+
+I currently release 128g GEMM models only. The addition of group_size 32 models, and GEMV kernel models, is being actively considered.
+
+Models are released as sharded safetensors files.
+
+| Branch | Bits | GS | AWQ Dataset | Seq Len | Size |
+| ------ | ---- | -- | ----------- | ------- | ---- |
+| [main](https://huggingface.co/TheBloke/Yi-6B-AWQ/tree/main) | 4 | 128 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4096 | 3.93 GB
+
+<!-- README_AWQ.md-provided-files end -->
+
+<!-- README_AWQ.md-text-generation-webui start -->
+## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
+
+Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
+
+It is strongly recommended to use the text-generation-webui one-click-installers unless you're sure you know how to make a manual install.
+
+1. Click the **Model tab**.
+2. Under **Download custom model or LoRA**, enter `TheBloke/Yi-6B-AWQ`.
+3. Click **Download**.
+4. The model will start downloading. Once it's finished it will say "Done".
+5. In the top left, click the refresh icon next to **Model**.
+6. In the **Model** dropdown, choose the model you just downloaded: `Yi-6B-AWQ`
+7. Select **Loader: AutoAWQ**.
+8. Click Load, and the model will load and is now ready for use.
+9. If you want any custom settings, set them and then click **Save settings for this model** followed by **Reload the Model** in the top right.
+10. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
+<!-- README_AWQ.md-text-generation-webui end -->
+
+<!-- README_AWQ.md-use-from-vllm start -->
+## Multi-user inference server: vLLM
+
+Documentation on installing and using vLLM [can be found here](https://vllm.readthedocs.io/en/latest/).
+
+- Please ensure you are using vLLM version 0.2 or later.
+- When using vLLM as a server, pass the `--quantization awq` parameter.
+
+For example:
+
+```shell
+python3 -m vllm.entrypoints.api_server --model TheBloke/Yi-6B-AWQ --quantization awq --dtype auto
+```
+
+- When using vLLM from Python code, again set `quantization=awq`.
+
+For example:
+
+```python
+from vllm import LLM, SamplingParams
+
+prompts = [
+    "Tell me about AI",
+    "Write a story about llamas",
+    "What is 291 - 150?",
+    "How much wood would a woodchuck chuck if a woodchuck could chuck wood?",
+]
+prompt_template=f'''{prompt}
+'''
+
+prompts = [prompt_template.format(prompt=prompt) for prompt in prompts]
+
+sampling_params = SamplingParams(temperature=0.8, top_p=0.95)
+
+llm = LLM(model="TheBloke/Yi-6B-AWQ", quantization="awq", dtype="auto")
+
+outputs = llm.generate(prompts, sampling_params)
+
+# Print the outputs.
+for output in outputs:
+    prompt = output.prompt
+    generated_text = output.outputs[0].text
+    print(f"Prompt: {prompt!r}, Generated text: {generated_text!r}")
+```
+<!-- README_AWQ.md-use-from-vllm start -->
+
+<!-- README_AWQ.md-use-from-tgi start -->
+## Multi-user inference server: Hugging Face Text Generation Inference (TGI)
+
+Use TGI version 1.1.0 or later. The official Docker container is: `ghcr.io/huggingface/text-generation-inference:1.1.0`
+
+Example Docker parameters:
+
+```shell
+--model-id TheBloke/Yi-6B-AWQ --port 3000 --quantize awq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
+```
+
+Example Python code for interfacing with TGI (requires [huggingface-hub](https://github.com/huggingface/huggingface_hub) 0.17.0 or later):
+
+```shell
+pip3 install huggingface-hub
+```
+
+```python
+from huggingface_hub import InferenceClient
+
+endpoint_url = "https://your-endpoint-url-here"
+
+prompt = "Tell me about AI"
+prompt_template=f'''{prompt}
+'''
+
+client = InferenceClient(endpoint_url)
+response = client.text_generation(prompt,
+                                  max_new_tokens=128,
+                                  do_sample=True,
+                                  temperature=0.7,
+                                  top_p=0.95,
+                                  top_k=40,
+                                  repetition_penalty=1.1)
+
+print(f"Model output: ", response)
+```
+<!-- README_AWQ.md-use-from-tgi end -->
+
+<!-- README_AWQ.md-use-from-python start -->
+## Inference from Python code using Transformers
+
+### Install the necessary packages
+
+- Requires: [Transformers](https://huggingface.co/docs/transformers) 4.35.0 or later.
+- Requires: [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) 0.1.6 or later.
+
+```shell
+pip3 install --upgrade "autoawq>=0.1.6" "transformers>=4.35.0"
+```
+
+Note that if you are using PyTorch 2.0.1, the above AutoAWQ command will automatically upgrade you to PyTorch 2.1.0.
+
+If you are using CUDA 11.8 and wish to continue using PyTorch 2.0.1, instead run this command:
+
+```shell
+pip3 install https://github.com/casper-hansen/AutoAWQ/releases/download/v0.1.6/autoawq-0.1.6+cu118-cp310-cp310-linux_x86_64.whl
+```
+
+If you have problems installing [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) using the pre-built wheels, install it from source instead:
+
+```shell
+pip3 uninstall -y autoawq
+git clone https://github.com/casper-hansen/AutoAWQ
+cd AutoAWQ
+pip3 install .
+```
+
+### Transformers example code (requires Transformers 4.35.0 and later)
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
+
+model_name_or_path = "TheBloke/Yi-6B-AWQ"
+
+tokenizer = AutoTokenizer.from_pretrained(model_name_or_path)
+model = AutoModelForCausalLM.from_pretrained(
+    model_name_or_path,
+    low_cpu_mem_usage=True,
+    device_map="cuda:0"
+)
+
+# Using the text streamer to stream output one token at a time
+streamer = TextStreamer(tokenizer, skip_prompt=True, skip_special_tokens=True)
+
+prompt = "Tell me about AI"
+prompt_template=f'''{prompt}
+'''
+
+# Convert prompt to tokens
+tokens = tokenizer(
+    prompt_template,
+    return_tensors='pt'
+).input_ids.cuda()
+
+generation_params = {
+    "do_sample": True,
+    "temperature": 0.7,
+    "top_p": 0.95,
+    "top_k": 40,
+    "max_new_tokens": 512,
+    "repetition_penalty": 1.1
+}
+
+# Generate streamed output, visible one token at a time
+generation_output = model.generate(
+    tokens,
+    streamer=streamer,
+    **generation_params
+)
+
+# Generation without a streamer, which will include the prompt in the output
+generation_output = model.generate(
+    tokens,
+    **generation_params
+)
+
+# Get the tokens from the output, decode them, print them
+token_output = generation_output[0]
+text_output = tokenizer.decode(token_output)
+print("model.generate output: ", text_output)
+
+# Inference is also possible via Transformers' pipeline
+from transformers import pipeline
+
+pipe = pipeline(
+    "text-generation",
+    model=model,
+    tokenizer=tokenizer,
+    **generation_params
+)
+
+pipe_output = pipe(prompt_template)[0]['generated_text']
+print("pipeline output: ", pipe_output)
+
+```
+<!-- README_AWQ.md-use-from-python end -->
+
+<!-- README_AWQ.md-compatibility start -->
+## Compatibility
+
+The files provided are tested to work with:
+
+- [text-generation-webui](https://github.com/oobabooga/text-generation-webui) using `Loader: AutoAWQ`.
+- [vLLM](https://github.com/vllm-project/vllm) version 0.2.0 and later.
+- [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) version 1.1.0 and later.
+- [Transformers](https://huggingface.co/docs/transformers) version 4.35.0 and later.
+- [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) version 0.1.1 and later.
+
+<!-- README_AWQ.md-compatibility end -->
+
+<!-- footer start -->
+<!-- 200823 -->
+## Discord
+
+For further support, and discussions on these models and AI in general, join us at:
+
+[TheBloke AI's Discord server](https://discord.gg/theblokeai)
+
+## Thanks, and how to contribute
+
+Thanks to the [chirper.ai](https://chirper.ai) team!
+
+Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
+
+I've had a lot of people ask if they can contribute. I enjoy providing models and helping people, and would love to be able to spend even more time doing it, as well as expanding into new projects like fine tuning/training.
+
+If you're able and willing to contribute it will be most gratefully received and will help me to keep providing more models, and to start work on new AI projects.
+
+Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
+
+* Patreon: https://patreon.com/TheBlokeAI
+* Ko-Fi: https://ko-fi.com/TheBlokeAI
+
+**Special thanks to**: Aemon Algiz.
+
+**Patreon special mentions**: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius
+
+
+Thank you to all my generous patrons and donaters!
+
+And thank you again to a16z for their generous grant.
+
+<!-- footer end -->
+
+# Original model card: 01-ai's Yi 6B
+
+<div align="center">
+
+<img src="./Yi.svg" width="200px">
+
+</div>
+
+## Introduction
+
+The **Yi** series models are large language models trained from scratch by
+developers at [01.AI](https://01.ai/). The first public release contains two
+bilingual(English/Chinese) base models with the parameter sizes of 6B([`Yi-6B`](https://huggingface.co/01-ai/Yi-6B)) 
+and 34B([`Yi-34B`](https://huggingface.co/01-ai/Yi-34B)). Both of them are trained 
+with 4K sequence length and can be extended to 32K during inference time. 
+The [`Yi-6B-200K`](https://huggingface.co/01-ai/Yi-6B-200K)
+and [`Yi-34B-200K`](https://huggingface.co/01-ai/Yi-34B-200K) are base model with
+200K context length.
+
+## News
+
+- 🎯 **2023/11/06**: The base model of [`Yi-6B-200K`](https://huggingface.co/01-ai/Yi-6B-200K) 
+and [`Yi-34B-200K`](https://huggingface.co/01-ai/Yi-34B-200K) with 200K context length.
+- 🎯 **2023/11/02**: The base model of [`Yi-6B`](https://huggingface.co/01-ai/Yi-6B) and 
+[`Yi-34B`](https://huggingface.co/01-ai/Yi-34B).
+
+
+## Model Performance
+
+| Model         |   MMLU   |  CMMLU   |  C-Eval  |  GAOKAO  |   BBH    | Common-sense Reasoning | Reading Comprehension | Math & Code |
+| :------------ | :------: | :------: | :------: | :------: | :------: | :--------------------: | :-------------------: | :---------: |
+|               |  5-shot  |  5-shot  |  5-shot  |  0-shot  | 3-shot@1 |           -            |           -           |      -      |
+| LLaMA2-34B    |   62.6   |    -     |    -     |    -     |   44.1   |          69.9          |         68.0          |    26.0     |
+| LLaMA2-70B    |   68.9   |   53.3   |    -     |   49.8   |   51.2   |          71.9          |         69.4          |    36.8     |
+| Baichuan2-13B |   59.2   |   62.0   |   58.1   |   54.3   |   48.8   |          64.3          |         62.4          |    23.0     |
+| Qwen-14B      |   66.3   |   71.0   |   72.1   |   62.5   |   53.4   |          73.3          |         72.5          |  **39.8**   |
+| Skywork-13B   |   62.1   |   61.8   |   60.6   |   68.1   |   41.7   |          72.4          |         61.4          |    24.9     |
+| InternLM-20B  |   62.1   |   59.0   |   58.8   |   45.5   |   52.5   |          78.3          |           -           |    30.4     |
+| Aquila-34B    |   67.8   |   71.4   |   63.1   |    -     |    -     |           -            |           -           |      -      |
+| Falcon-180B   |   70.4   |   58.0   |   57.8   |   59.0   |   54.0   |          77.3          |         68.8          |    34.0     |
+| Yi-6B         |   63.2   |   75.5   |   72.0   |   72.2   |   42.8   |          72.3          |         68.7          |    19.8     |
+| Yi-6B-200K    |   64.0   |   75.3   |   73.5   |   73.9   |   42.0   |          72.0          |         69.1          |    19.0     |
+| **Yi-34B**    | **76.3** | **83.7** |   81.4   |   82.8   | **54.3** |        **80.1**        |         76.4          |    37.1     |
+| Yi-34B-200K   |   76.1   |   83.6   | **81.9** | **83.4** |   52.7   |          79.7          |       **76.6**        |    36.3     |
+
+While benchmarking open-source models, we have observed a disparity between the
+results generated by our pipeline and those reported in public sources (e.g.
+OpenCompass). Upon conducting a more in-depth investigation of this difference,
+we have discovered that various models may employ different prompts,
+post-processing strategies, and sampling techniques, potentially resulting in
+significant variations in the outcomes. Our prompt and post-processing strategy
+remains consistent with the original benchmark, and greedy decoding is employed
+during evaluation without any post-processing for the generated content. For
+scores that were not reported by the original authors (including scores reported
+with different settings), we try to get results with our pipeline.
+
+To evaluate the model's capability extensively, we adopted the methodology
+outlined in Llama2. Specifically, we included PIQA, SIQA, HellaSwag, WinoGrande,
+ARC, OBQA, and CSQA to assess common sense reasoning. SquAD, QuAC, and BoolQ
+were incorporated to evaluate reading comprehension. CSQA was exclusively tested
+using a 7-shot setup, while all other tests were conducted with a 0-shot
+configuration. Additionally, we introduced GSM8K (8-shot@1), MATH (4-shot@1),
+HumanEval (0-shot@1), and MBPP (3-shot@1) under the category "Math & Code". Due
+to technical constraints, we did not test Falcon-180 on QuAC and OBQA; the score
+is derived by averaging the scores on the remaining tasks. Since the scores for
+these two tasks are generally lower than the average, we believe that
+Falcon-180B's performance was not underestimated.
+
+## Usage
+
+Please visit our [github repository](https://github.com/01-ai/Yi) for general
+guidance on how to use this model.
+
+## Disclaimer
+
+Although we use data compliance checking algorithms during the training process
+to ensure the compliance of the trained model to the best of our ability, due to
+the complexity of the data and the diversity of language model usage scenarios,
+we cannot guarantee that the model will generate correct and reasonable output
+in all scenarios. Please be aware that there is still a risk of the model
+producing problematic outputs. We will not be responsible for any risks and
+issues resulting from misuse, misguidance, illegal usage, and related
+misinformation, as well as any associated data security concerns.
+
+## License
+
+The Yi series models are fully open for academic research and free commercial
+usage with permission via applications. All usage must adhere to the [Model
+License Agreement 2.0](https://huggingface.co/01-ai/Yi-6B/blob/main/LICENSE). To
+apply for the official commercial license, please contact us
+([[email protected]](mailto:[email protected])).