Update README.md

README.md

@@ -1,3 +1,141 @@
 ---
+inference: false
+language:
+- zh
 license: apache-2.0
+model_name: Breeze-7B-Instruct-v0.1
+pipeline_tag: text-generation
+prompt_template: '<s> SYS_PROMPT [INST] QUERY1 [/INST] RESPONSE1 [INST] QUERY2 [/INST]'
+quantized_by: yuuko-eth
+tags:
+- nlp
+- chinese
+- mistral
+- traditional_chinese
 ---
+
+
+# Breeze-7B-Instruct-v0.1-GGUF
+- Model creator: [MTK Research](https://huggingface.co/MediaTek-Research)
+- Original model: [Breeze-7B-Instruct-v0.1](https://huggingface.co/MediaTek-Research/Breeze-7B-Instruct-v0.1)
+
+<!-- description start -->
+## Description
+
+This repo contains GGUF format model files for [Breeze-7B-Instruct-v0.1](https://huggingface.co/MediaTek-Research/Breeze-7B-Instruct-v0.1).
+
+<!-- description end -->
+
+### About GGUF
+GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
+Here is an incomplete list of clients and libraries that are known to support GGUF:
+* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
+* [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
+* [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
+* [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
+* [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
+* [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
+* [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
+* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
+* [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
+* [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
+
+
+---
+
+> Original `README.MD` is as follows.
+
+---
+
+# Model Card for Breeze-7B-Instruct-v0.1
+
+Breeze-7B is a language model family that builds on top of [Mistral-7B](https://huggingface.co/mistralai/Mistral-7B-v0.1), specifically intended for Traditional Chinese use.
+
+[Breeze-7B-Base](https://huggingface.co/MediaTek-Research/Breeze-7B-Base-v0.1) is the base model for the Breeze series. 
+It is suitable for use if you have substantial fine-tuning data to tune it for your specific use case.
+
+[Breeze-7B-Instruct](https://huggingface.co/MediaTek-Research/Breeze-7B-Instruct-v0.1) derives from the base model Breeze-7B-Base, making the resulting model amenable to be used as-is for commonly seen tasks.
+
+[Breeze-7B-Instruct-64k](https://huggingface.co/MediaTek-Research/Breeze-7B-Instruct-64k-v0.1) is a slightly modified version of 
+Breeze-7B-Instruct to enable a 64k-token context length. Roughly speaking, that is equivalent to 88k Traditional Chinese characters.
+
+The current release version of Breeze is v0.1.
+
+Practicality-wise:
+- Breeze expands the original vocabulary with additional 30,000 Traditional Chinese tokens. With the expanded vocabulary, everything else being equal, Breeze operates at twice the inference speed for Traditional Chinese to Mistral-7B and Llama 7B. [See [Inference Performance](#inference-performance).]
+- Breeze-Instruct can be used as is for common tasks such as Q&A, RAG, multi-round chat, and summarization.
+- In particular, Breeze-Instruct-64k can perform tasks at a document level, not a chapter level.
+
+Performance-wise:
+- Breeze demonstrates impressive performance in benchmarks for Traditional Chinese, when compared to similar sized open-source contemporaries such as Taiwan-LLM, QWen, and Yi. [See [Chat Model Performance](#chat-model-performance).]
+- Breeze shows comparable results to Mistral-7B-Instruct-v0.1 on the MMLU and MT-Bench benchmarks. [See [Chat Model Performance](#chat-model-performance).]
+
+
+*A project by the members (in alphabetical order): Chan-Jan Hsu 許湛然, Chang-Le Liu 劉昶樂, Feng-Ting Liao 廖峰挺, Po-Chun Hsu 許博竣, Yi-Chang Chen 陳宜昌, and the supervisor Da-Shan Shiu 許大山.*
+
+## Features
+
+- Breeze-7B-Base-v0.1
+  - Expanding the vocabulary dictionary size from 32k to 62k to better support Traditional Chinese
+  - 8k-token context length
+- Breeze-7B-Instruct-v0.1
+  - Expanding the vocabulary dictionary size from 32k to 62k to better support Traditional Chinese 
+  - 8k-token context length
+  - Multi-turn dialogue (without special handling for harmfulness)
+- Breeze-7B-Instruct-64k-v0.1
+  - Expanding the vocabulary dictionary size from 32k to 62k to better support Traditional Chinese
+  - 64k-token context length
+  - Multi-turn dialogue (without special handling for harmfulness)
+
+## Model Details
+
+- Breeze-7B-Base-v0.1
+  - Finetuned from: [mistralai/Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1)
+  - Model type: Causal decoder-only transformer language model
+  - Language: English and Traditional Chinese (zh-tw)
+- Breeze-7B-Instruct-v0.1
+  - Finetuned from: [MediaTek-Research/Breeze-7B-Base-v0.1](https://huggingface.co/MediaTek-Research/Breeze-7B-Base-v0.1)
+  - Model type: Causal decoder-only transformer language model
+  - Language: English and Traditional Chinese (zh-tw)
+- Breeze-7B-Instruct-64k-v0.1
+  - Finetuned from: [MediaTek-Research/Breeze-7B-Instruct-v0.1](https://huggingface.co/MediaTek-Research/Breeze-7B-Instruct-v0.1)
+  - Model type: Causal decoder-only transformer language model
+  - Language: English and Traditional Chinese (zh-tw)
+ 
+
+## Inference
+The template for inference instances is as follows:
+<style>
+  .pTemplate code { background-color:white;padding:2px 3px;border-radius:4px }
+</style>
+<div class="pTemplate" style="background-color: #f6f8fa; padding: 20px; border-radius: 10px; border: 1px solid #e1e4e8; box-shadow: 0 2px 5px rgba(0,0,0,0.1);">
+<strong>Prompting template:</strong><br/><br/>
+
+<code>
+  &lt;s&gt; SYS_PROMPT   [INST] QUERY1 [/INST] RESPONSE1 [INST] QUERY2 [/INST]
+</code>
+<br/><br/>
+where <code>SYS_PROMPT</code>, <code>QUERY1</code>, <code>RESPONSE1</code>, and <code>QUERY2</code> can be provided by the user.
+<br/><br/>
+The suggested default <code>SYS_PROMPT</code> is:
+<br/><br/>
+<code>
+You are a helpful AI assistant built by MediaTek Research. The user you are helping speaks Traditional Chinese and comes from Taiwan.
+</code>
+<br/><br/>
+</div>
+
+## License
+
+This model and its associated data are released under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+## Citation
+
+```
+@article{breeze7b2024,
+  title={},
+  author={},
+  journal={arXiv},
+  year={2024}
+}
+```